1. Introduction

The purpose of this document is to give developers sufficient information to be able to get familiar with Aeras´ services as well as how to integrate with the available services according to relevant agreement with Aera. The services are available through the Aera API Gateway. Credentials are needed to to access the services.

Aera Platform
Figure 1. The services covered by this document explains most of the Aera Platform, except the Terminal and SDK documentation.

Additional documentation can be requested by contacting Aera.

1.1. Identification

Loyalty programs are increasingly important in the battle for customer loyalty. This emphasises the need to identify and enroll the customer in an easy and safe way — regardless of channel, touch-point and payment method.

Aera offers a solution for friction-free identification and enrolment in accordance with the General Data Protection Regulation (GDPR) and security standards. The flexible platform also ensures rapid implementation of future new identifiers

1.2. Contact information

  • Contact your Aera Business Contact (if you have one) for prices, contracts and general information about Aera’s Platform.

  • Contact Aera Support (support@aera.id) for getting access to the APIs in test and operation related questions.

2. Getting Started

The documentation describes how to use the API/services and also how to setup the necessary security mechanisms to access the services. The API offers robust, scalable and secure services.

In order to access Aera’s APIs and environments, an agreement with Aera Payment & Identification AS is required. Reach out to your business contact at Aera (if you have one), or contact us at support@aera.id to get this sorted.

2.1. Access to the APIs

An API Key is required to access the Aera API Gateway. Most end-points also require a Bearer Token. All requests MUST use the SSL endpoint.

The Aera Payment & Identity Platform offers 2 environments for our Customers:

In order to be granted the needed credentials to get access to the environments, the following information must be send in a request to Aera Support (support@aera.id):

Company

<e.g. Aera Payment & Identification AS>

Country

<e.g. Norway>

Agreement ref

<e.g. Framework agreement dated dd.MM.yyyy>
If not available, refer to a Manager responsible for the integration

Aera Contact
A person within Aera that can confirm the access request

Name: <e.g. Kari Nordmann>
E-mail: <e.g. kari.nordmann@aera.id>

Technical Contact
The technical person that will receive the client credentials

Name: <e.g. Ola Nordmann>
E-mail: <e.g. ola.nordmann@mail.no>
Mobile no: <e.g. +47 XXXXXXXX> must be able to receive SMS
Position: <e.g. Integration Specialist>

Environment

<PreProd API or PSP/ Production API or PSP>

API Details

<Detailed list of all service end-points that are requested>
<Information about usage of the API, additional information, your concepts, etc>
Aera will send back unique information that should never under any circumstance be shared, but kept Secure. The information includes, but is not limited to

  • API Key (x-api-key)

  • Credentials (username/password)

These can then be used to access the agreed API services Aera offers, following the documentation on this page.

Please read the Security and Terms of use sections before start using the services.

2.1.1. Configuration tips when integrating with the API

DNS cache stores the locations (IP addresses) of servers which you have recently viewed. If the location of the server changes before the entry in your DNS cache updates, you can no longer access the site.

Because the Identity API Gateway uses DNS name entries that occasionally change, we recommend that you configure your client application with a DNS cache TTL value of no more than 60 seconds.

If you are using Java/JVM, it might have a default TTL set so that it will never refresh DNS entries until the JVM is restarted.
To modify the JVM’s TTL, you can set the networkaddress.cache.ttl property value using one of the following methods:

globally, for all applications that use the JVM. Set networkaddress.cache.ttl in the $JAVA_HOME/jre/lib/security/java.security file:

networkaddress.cache.ttl=60

for your application only, set networkaddress.cache.ttl in your application’s initialization code:

java.security.Security.setProperty("networkaddress.cache.ttl" , "60");

More information is described in this article Setting the JVM TTL for DNS Name Lookups.

2.2. RESTful API

The Identity API Gateway is meant to conform with RESTful principles, separating the API into logical resources. These resources are manipulated using HTTP requests (as defined in RFC 2616) where each method (GET, POST, PUT, DELETE) has specific meaning. The resources are defined as nouns that make sense from the API consumer, and is manipulated by verbs (the HTTP requests).

RESTful principles provide strategies to handle CRUD (Create Read Update Delete) actions using HTTP methods

  • GET /identities/12 - Retrieves a specific Identity

  • POST /identities - Creates a new Identity

  • PUT /identities/12 - Updates Identity #12

  • DELETE /identities/12 - Deletes Identity #12

There are some exceptions, e.g.:
POST /identities/loyalties/find-by-identifier. A POST is used to GET a list of Loyalty documents
* This is typically used when there are several search criteria, that is passed in as part of the body
* A HTTP GET request does not support using body, but only URL parameters

All Aera Payment & Identification (API) Gateway resources are represented as JSON documents using UTF-8.

2.2.1. HTTP Request URL

The URL of an API Gateway request has the following format:

https://api.aerahost.com/{path}

where {path} identifies an API Gateway resource under the root resource (/). E.g., to access a specific identifier attached to an identity:

GET https://api.aerahost.com/identities/12/identifier/8 HTTP/1.1
Authorization: ...

The Authorization header containing the caller’s credentials is used to sign the request for API Gateway to authenticate the caller and to authorize the request according to pre-configured policies. The URL path for the this request is /identities/12/identifier/8, where Identifier with id 8 on Identity with id 12 is accessed.

2.2.2. Breaking vs. non-breaking changes

Non-breaking changes tend to be additive: adding new fields or nested resources to the resource representations, adding new endpoints such as a PUT or PATCH that was previously unavailable.

API consumers should build client code that is resilient to these kinds of non-breaking changes.
Breaking changes include:

  1. Renaming fields and/or resource paths – often for clarity after the API is released

  2. Changing payload structures to accommodate the following: renaming or removing fields (even if they are considered optional – contracts!); changing fields from a single value to a one-to-many relationship (e.g. moving from one email address per account to a list of email addresses for an account)

  3. Fixing poor choices of HTTP verbs, response codes, or inconsistent design across API endpoints

If a breaking change is encountered, API will be versioned unless it can be avoided by coordinating a temporarily backward compability accepted by all of the API consumers.

2.3. Glossary

JSON JavaScript Object Notation is an open-standard file format that use human-readable text to transmit data objects consisting of attribute-value pairs an array data types ( or any other serialisable value). Derived from JavaScript JSON is a language-independent data format
RESTful API an application program interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data. Sometimes also referred to as a RESTful web service — it is based on representational state transfer (REST) technology, an architectural style and approach to communications often used in web services development.
SDK Standard Developer Kit
UTF-8 8-bit Unicode Transformation Format is a character encoding capable of encoding all 1,112,064 valid code points in Unicode using one to four 8-bit bytes
OTP One-Time Password
SMS Short Message Service

3. Access API

Service paths and model definition for Access PSP.

3.1. What is Access API

Access API is an application used to obtain an access token needed to use other Aera API services (api.aerahost.com). By being authenticated using a valid clientId (username) and clientSecret (password), you’ll get an accessToken and a refreshToken back. The accessToken can then be used in the Authorization header as the Bearer token.

Sequence diagram
Sequence diagram for Access Token
Figure 2. Sequence diagram for obtaining and using Access Token

3.2. Paths

Descriptions of resources/paths in the service.

3.2.1. Get Application Status (Health check)

GET /access/health
Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Responses
HTTP Code Description Schema

200

OK

Status
Produces

  • application/json

  • application/vnd.access.v1+json

Tags

  • Health

Example HTTP request
GET /access/health HTTP/1.1
x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE
Accept: application/json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 21

{
  "status" : "UP"
}
Example Curl request
$ curl 'https://api.aerahost.com/access/health' -i -X GET \
    -H 'x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE' \
    -H 'Accept: application/json'

3.2.2. Introspects an access token (@see https://tools.ietf.org/html/rfc7662)

POST /access/oauth2/introspect
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

FormData

token
required

The token to introspect.

string
Responses
HTTP Code Description Schema

200

OK

IntrospectResponse
Consumes

  • application/x-www-form-urlencoded

Produces

  • application/json

  • application/vnd.access.v1+json

Tags

  • AccessService

Example HTTP request
POST /access/oauth2/introspect HTTP/1.1
Content-Type: application/x-www-form-urlencoded
x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE
Accept: application/vnd.access.v1+json
Host: api.aerahost.com
Content-Length: 746

token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic2NvcGUiOlsic2NvcGUxIiwic2NvcGUyIl0sInN1YiI6IjA3N2QwZTU1LWU2YzctNDFlNC05MTUyLTE1ZGVlZGVmMDg0OCIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTU3NjIzODcyMSwiaWF0IjoxNTc2MjM4NzIxLCJleHAiOjk5OTk5OTk5OTksImp0aSI6IjBkZmJlMTE1LTcyNmUtNGQyZS04MWMwLTZiY2UwODk3NWVlYSJ9.AtmCMc15jGhaLfURt-8-M0i_l4Owfsdk0eogbG4YEU6tBFV_FWHZ1p8O4OHNVPxMzSTKrIu3FIJ_0yd07xVcP4zUrFQcPWsTRCGb2t1sdJPqTUQaJA2DSqGI2hHJi7b0eBXT4MnhM_tcjFxnXjhRwiaYnsHqDzIb0E_XZ5JhgYevbOGhLkjgIYfCk8-P4XjD9h7z_gqXJbQ2688E8bJJe_Fh_ZCOmmbxRdLqvyDhFtFJ392rkFQ-qFPDvMf7qAOnSmje6O0BzbNkNqSKfTJKlT2SxMyvh6j4a-Uk-MzXFsI4MsWvP7OstGsJJxvtGtm3EqSWfbsmL2e2Ube7su8dKA
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.access.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: h9b6ts7D6ekGEcD0DEPq1TjA4zkx+kUuThJ9JGypcbL3kWV4QtqiS9KfjYEcIW0R73qepnOb8OazEqGhH6Ou5v6c5TEjS8Vr1PbaFhWZs7l/ZnGlrhuXe+asYIqAqkugkhuuc1gt4XKcnco+b+z8eBn5A7Q0YGwAQJjYoRCtVQ8TkQzAilG8tZdRSAsHoieoL5Brxf20RV78L1xx0x7C5s88cDrgIwJXwBVKDLT6qAin2ta+2QQYX+jZXUVmPNem6AkZ2KSFolo2xtD5nGi8JH6qJmBJabhiShqXhqIMYyFDrk1AENwAleyFrSXk3RnBNbGcpFEOfZrPaodGnZFuuQ==
Content-Length: 240

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T13:10:47.493Z"
  },
  "active" : true,
  "sub" : "077d0e55-e6c7-41e4-9152-15deedef0848",
  "jti" : "0dfbe115-726e-4d2e-81c0-6bce08975eea",
  "exp" : 9999999999
}
Example Curl request
$ curl 'https://api.aerahost.com/access/oauth2/introspect' -i -X POST \
    -H 'x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE' \
    -H 'Accept: application/vnd.access.v1+json' \
    -d 'token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic2NvcGUiOlsic2NvcGUxIiwic2NvcGUyIl0sInN1YiI6IjA3N2QwZTU1LWU2YzctNDFlNC05MTUyLTE1ZGVlZGVmMDg0OCIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTU3NjIzODcyMSwiaWF0IjoxNTc2MjM4NzIxLCJleHAiOjk5OTk5OTk5OTksImp0aSI6IjBkZmJlMTE1LTcyNmUtNGQyZS04MWMwLTZiY2UwODk3NWVlYSJ9.AtmCMc15jGhaLfURt-8-M0i_l4Owfsdk0eogbG4YEU6tBFV_FWHZ1p8O4OHNVPxMzSTKrIu3FIJ_0yd07xVcP4zUrFQcPWsTRCGb2t1sdJPqTUQaJA2DSqGI2hHJi7b0eBXT4MnhM_tcjFxnXjhRwiaYnsHqDzIb0E_XZ5JhgYevbOGhLkjgIYfCk8-P4XjD9h7z_gqXJbQ2688E8bJJe_Fh_ZCOmmbxRdLqvyDhFtFJ392rkFQ-qFPDvMf7qAOnSmje6O0BzbNkNqSKfTJKlT2SxMyvh6j4a-Uk-MzXFsI4MsWvP7OstGsJJxvtGtm3EqSWfbsmL2e2Ube7su8dKA'

3.2.3. Create an access token

POST /access/oauth2/token
Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : AccessRequest

Responses
HTTP Code Description Schema

201

Created

AccessResponse
Consumes

  • application/json

  • application/vnd.access.v1+json

Produces

  • application/json

  • application/vnd.access.v1+json

Tags

  • AccessService

Example HTTP request
POST /access/oauth2/token HTTP/1.1
Content-Type: application/vnd.access.v1+json;charset=UTF-8
x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE
Accept: application/vnd.access.v1+json
Content-Length: 119
Host: api.aerahost.com

{
  "grantType" : "password",
  "username" : "077d0e55-e6c7-41e4-9152-15deedef0848",
  "password" : "Secretpassw0rd!"
}
Example HTTP response
HTTP/1.1 201 Created
Content-Type: application/vnd.access.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: D/nopQtV1pdBrSFQcJHtPnhaGKV1iHKftoenJt8m47K5Lbf0sPs+3ZG0WBEDhUUlIqu/+N6698rvaIVqAnoDNUmC6887XyOcveOULuQvMmRJRCRDRnRXcEF7jeLMCSwgecBcIxAiL0xKBdW2D4a8LrPuFeStRsad+616uNJgGXVE6jcwN6YAWv6v3rzF7Vda3ODbN6fVvVj+u52QHMl5LgYaeu3JRwsxLLmhx+hd8Wo388030yJTfCF5BKFTy1J6spaF0OTNDutZFSa1X8gjuxjwsIuBxreyI8jq4lMQDAzacsug1K9OP+M1WDpbw5I6ALZnX/W85Ev6h2sWsfW4ZQ==
Content-Length: 1946

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T13:10:48.441Z"
  },
  "accessToken" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbImFkZElkZW50aWZpZXIiLCJkZWxldGVJZGVudGlmaWVyV2l0aEJvZHkiLCJkZWxldGVJZGVudGl0eSIsImdldElkZW50aXR5IiwiZGVsZXRlSWRlbnRpZmllciIsImdldElkZW50aXR5VHJhbnNhY3Rpb25zIiwiYWxsSWRlbnRpdHlNb2R1bGUiLCJhZGRJZGVudGl0eSIsInBhdGNoSWRlbnRpdHkiLCJwYXRjaElkZW50aWZpZXIiLCJmaW5kQnlJZGVudGlmaWVyIl0sInN1YiI6IjA3N2QwZTU1LWU2YzctNDFlNC05MTUyLTE1ZGVlZGVmMDg0OCIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6WyJhZXJhLnRlc3QtcmVzb3VyY2UiXSwibmJmIjoxNzU1MDkwNjQ4LCJpYXQiOjE3NTUwOTA2NDgsImV4cCI6MTc1NTA5MTI0OCwianRpIjoiYjQ5YzA5NTQtZGVhZi00MWYwLThjNzItM2U1MDhlMjI2ODg2In0.PtWNfDhl5tWLYdTqbojduyMx0m-mxk-thgA_Hd6xUQxXIr1dWNDmYUpH7qssvV4CBxH7GJ_jpozQJT2sXFsGrrDoqN1Idt6OsqzXPeWommg1lc-1MJpLgJ05ZwIy5uiFVZeBOCGn4hvCsuLf5b9dn65epQsMfYoCqGw1pxCNRpsOZKp7ViLdR-Wh0bFmVe3tcTmxoGbejQPGb90e9WD_SA9coUnddzpknrNyHwPFmAaWxz9yrp0-wHDtRu6Ia6uoqI8W0AkzcJrAtr2ZUoeMELgpZs25rM-TnJ0pi_akyQvZpghrCBC9-4hVfCSiw46PCpN7-jnE1u3VL3ddTd8FZA",
  "refreshToken" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InJlZnJlc2hfdG9rZW4iLCJhdGkiOiJiNDljMDk1NC1kZWFmLTQxZjAtOGM3Mi0zZTUwOGUyMjY4ODYiLCJzdWIiOiIwNzdkMGU1NS1lNmM3LTQxZTQtOTE1Mi0xNWRlZWRlZjA4NDgiLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOlsiYWVyYS50ZXN0LXJlc291cmNlIl0sIm5iZiI6MTc1NTA5MDY0OCwiaWF0IjoxNzU1MDkwNjQ4LCJleHAiOjE3NTUwOTQ4NDgsImp0aSI6ImRkYzFjMjI0LWQ5NDUtNDcyOS05YTgyLWU2YzEzNGE1ZjIxMyJ9.pB-zgYZwAqK0QYCWK1-KKgzTlcIqP1doRKMXBGVH1qSdZnuik45JXtDYrK3VXmX4sy2YGvyH76sOP5qVGvNyonP0eROxV0oOAmKayGfJoZWqQzsJ2NIQqR_kSL5vZiKcGnO5IfEJj3VMCa9F6s0BZUe6d7XLfsjnV7eiQg6OtugFj_GZtx0mVN6l5YPD90K_mR-qZREUJUNcDzCVl22e3ruAyLJre07L27ksgv4c7mD1OYOivhBPZibv4ciLgM2nTuQJuxKSSDoFOQy8N5OHdyzwlOKlzhSxXTQFqleOyYSjc3yyV2XXiNJRpDUfDPvvEKYnG3-M1wTUAC2Drvxmrw",
  "expiresIn" : "600"
}
Example Curl request
$ curl 'https://api.aerahost.com/access/oauth2/token' -i -X POST \
    -H 'Content-Type: application/vnd.access.v1+json;charset=UTF-8' \
    -H 'x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE' \
    -H 'Accept: application/vnd.access.v1+json' \
    -d '{
  "grantType" : "password",
  "username" : "077d0e55-e6c7-41e4-9152-15deedef0848",
  "password" : "Secretpassw0rd!"
}'

3.3. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

3.3.1. AccessRequest

Access Token request

Name Description Schema

grantType
required

The grant type.

enum (password, refresh_token)

password
optional

The subject’s password.
Length : 0 - 80
Pattern : "(?=.\\d)(?=.)[A-Za-z\\d!@.#$%&*+_?&=\\-]{8,}$"

string

refreshToken
optional

The refresh token.
Length : 0 - 2048
Pattern : "^[a-zA-Z0-9\\-]+?\\.[a-zA-Z0-9\\-]+?\\.([a-zA-Z0-9\\-_]+)?$"

string

username
optional

The subject (username) that should be authorized.
Length : 0 - 36
Pattern : "^[a-zA-Z0-9\\-]+$"

string

3.3.2. AccessResponse

Name Description Schema

accessToken
optional

The access token.

string

expiresIn
optional

Seconds until the Access token expires.

string

refreshToken
optional

The refresh token.

string

responseInfo
optional

ResponseInfo

3.3.3. IntrospectForm

Name Description Schema

token
required

The token to introspect.
Pattern : "^[A-Za-z0-9-=]+\\.[A-Za-z0-9-=]+\\.[A-Za-z0-9-_.+/=]+$"

string

3.3.4. IntrospectResponse

Name Description Schema

active
required

Boolean indicator of whether or not the presented token is currently active.

boolean

ati
optional

This value is a CaSe-SenSiTiVe unique identifier for the AccessToken linked to the refresh token.

string (uuid)

azp
optional

Authorized party - the party to which the ID Token was issued.

string

exp
required

Integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire.

integer (int64)

jti
required

This value is a CaSe-SenSiTiVe unique identifier for the JWT.

string (uuid)

responseInfo
optional

ResponseInfo

sub
required

The Subject/Client_Id that requested the token.

string

3.3.5. ResponseInfo

Info object that can provide specific messages

Name Description Schema

externalResponseCode
optional

Additional response code from external systems.

string

message
optional

Specific response message

string

responseCode
required

Minimum length : 1

string

timeStamp
required

Timestamp. Mandatory
Minimum length : 1
Example : "2021-12-21T10:23:19.279Z"

string

3.3.6. Status

Name Schema

description
optional

string

status
optional

string

4. Access PSP

Service paths and model definition for Access PSP.

4.1. What is Access PSP

Access PSP is an application used to obtain an access token needed to use other Aera PSP services (psp.aerahost.com). By being authenticated using a valid clientId (username) and clientSecret (password), you’ll get an accessToken and a refreshToken back. The accessToken can then be used in the Authorization header as the Bearer token.

Sequence diagram
Sequence diagram for Access Token
Figure 3. Sequence diagram for obtaining and using Access Token

4.2. Paths

Descriptions of resources/paths in the service.

4.2.1. Get Application Status (Health check)

GET /access/health
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Responses
HTTP Code Description Schema

200

OK

Status
Produces

  • application/json

Tags

  • Health

Example HTTP request
GET /access/health HTTP/1.1
x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE
Accept: application/json
Host: psp.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 21

{
  "status" : "UP"
}
Example Curl request
$ curl 'https://psp.aerahost.com/access/health' -i -X GET \
    -H 'x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE' \
    -H 'Accept: application/json'

4.2.2. Introspects an access token (@see https://tools.ietf.org/html/rfc7662)

POST /access/v1/oauth2/introspect
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

FormData

token
required

The token to introspect.

string
Responses
HTTP Code Description Schema

200

OK

IntrospectResponse
Consumes

  • application/x-www-form-urlencoded

Produces

  • application/json

Tags

  • AccessPSP

Example HTTP request
POST /access/v1/oauth2/introspect HTTP/1.1
Content-Type: application/x-www-form-urlencoded
x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE
Accept: application/json
Host: psp.aerahost.com
Content-Length: 746

token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic2NvcGUiOlsic2NvcGUxIiwic2NvcGUyIl0sInN1YiI6IjA3N2QwZTU1LWU2YzctNDFlNC05MTUyLTE1ZGVlZGVmMDg0OCIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTU3NjIzODcyMSwiaWF0IjoxNTc2MjM4NzIxLCJleHAiOjk5OTk5OTk5OTksImp0aSI6IjBkZmJlMTE1LTcyNmUtNGQyZS04MWMwLTZiY2UwODk3NWVlYSJ9.AtmCMc15jGhaLfURt-8-M0i_l4Owfsdk0eogbG4YEU6tBFV_FWHZ1p8O4OHNVPxMzSTKrIu3FIJ_0yd07xVcP4zUrFQcPWsTRCGb2t1sdJPqTUQaJA2DSqGI2hHJi7b0eBXT4MnhM_tcjFxnXjhRwiaYnsHqDzIb0E_XZ5JhgYevbOGhLkjgIYfCk8-P4XjD9h7z_gqXJbQ2688E8bJJe_Fh_ZCOmmbxRdLqvyDhFtFJ392rkFQ-qFPDvMf7qAOnSmje6O0BzbNkNqSKfTJKlT2SxMyvh6j4a-Uk-MzXFsI4MsWvP7OstGsJJxvtGtm3EqSWfbsmL2e2Ube7su8dKA
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: r2c4Z128KnhfouX+/w1mLy1K+JZKMFIVYJ5cFl9JykjWwLYg8+ztgP+ZSCf6GompoqHWI8Hob047G/p8BCV1z7Dl3PUUjk32kdvWaIn395QMPVMXOYthlr90nXZZymtmwinhxesfajaWgpDePMev1az6BT1DHOCLv8WJ2x8P5uAp2V0iR6M8G0VUTYuaKxtfeXTHcTPa1EwYBBTVosibMUvln2Kgu6qaC0a/7kEwvu7nFGtjauxYbfmNMWUz/KMTgCSfW4+c+J6ARSinpgahirW5onZYzbK6000rGjUpN6rjQhgyKfLw5TUcNQPcmqEJ93N+SfC+Kh82Pr5svSilYg==
Content-Length: 240

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-11T11:57:17.003Z"
  },
  "active" : true,
  "sub" : "077d0e55-e6c7-41e4-9152-15deedef0848",
  "jti" : "0dfbe115-726e-4d2e-81c0-6bce08975eea",
  "exp" : 9999999999
}
Example Curl request
$ curl 'https://psp.aerahost.com/access/v1/oauth2/introspect' -i -X POST \
    -H 'x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE' \
    -H 'Accept: application/json' \
    -d 'token=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic2NvcGUiOlsic2NvcGUxIiwic2NvcGUyIl0sInN1YiI6IjA3N2QwZTU1LWU2YzctNDFlNC05MTUyLTE1ZGVlZGVmMDg0OCIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTU3NjIzODcyMSwiaWF0IjoxNTc2MjM4NzIxLCJleHAiOjk5OTk5OTk5OTksImp0aSI6IjBkZmJlMTE1LTcyNmUtNGQyZS04MWMwLTZiY2UwODk3NWVlYSJ9.AtmCMc15jGhaLfURt-8-M0i_l4Owfsdk0eogbG4YEU6tBFV_FWHZ1p8O4OHNVPxMzSTKrIu3FIJ_0yd07xVcP4zUrFQcPWsTRCGb2t1sdJPqTUQaJA2DSqGI2hHJi7b0eBXT4MnhM_tcjFxnXjhRwiaYnsHqDzIb0E_XZ5JhgYevbOGhLkjgIYfCk8-P4XjD9h7z_gqXJbQ2688E8bJJe_Fh_ZCOmmbxRdLqvyDhFtFJ392rkFQ-qFPDvMf7qAOnSmje6O0BzbNkNqSKfTJKlT2SxMyvh6j4a-Uk-MzXFsI4MsWvP7OstGsJJxvtGtm3EqSWfbsmL2e2Ube7su8dKA'

4.2.3. Create an access token

POST /access/v1/oauth2/token
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : AccessRequest

Responses
HTTP Code Description Schema

201

Created

AccessResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • AccessPSP

Example HTTP request
POST /access/v1/oauth2/token HTTP/1.1
Content-Type: application/json;charset=UTF-8
x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE
Accept: application/json
Content-Length: 119
Host: psp.aerahost.com

{
  "grantType" : "password",
  "username" : "077d0e55-e6c7-41e4-9152-15deedef0848",
  "password" : "Secretpassw0rd!"
}
Example HTTP response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: Oc/abMNsSJMNsa5CHcPFDkXPKQ/vbzt4ARLofTKPkF709Vake47x/0h+NKSjEb3oIq1/QJ9NOynugjN29NHZ5nXGW5m0rw+Acrchd1fqz/W8cj+veQMWW5updfkiTUuAvzTwjgbS4OimJF0F6X9YVl1C1TlK1qCNqsiYbWA2VP2EOA14N7uZiMGlOwovo9oKhi2TrjI1qY1dgkhze8bIFNHVACXjjDyfsa+LTPUczD+nXjpzaleJSwj1eg08JdpgDy70+qW3BCXiODQY7fwQtMaNI3xKOWfNli4Hh7vNBPd8FoqS/c43sLfnJgGJepO2Qb6FzeVxJIlg4iFb9Ea4Gg==
Content-Length: 1706

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-11T11:57:17.258Z"
  },
  "accessToken" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIm50c0FsbCIsIm50c0ludGVybmFsQWxsIl0sInN1YiI6IjA3N2QwZTU1LWU2YzctNDFlNC05MTUyLTE1ZGVlZGVmMDg0OCIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6WyJhZXJhLnRlc3QtcmVzb3VyY2UiXSwibmJmIjoxNzU0OTEzNDM3LCJpYXQiOjE3NTQ5MTM0MzcsImV4cCI6MTc1NDkxNDAzNywianRpIjoiM2FlNjJiNzAtMTlhZi00ZTU5LTk4NjYtYjVlNzcyYzBjOTIxIn0.CAavTm6aPZIuEDairg1o8dMPwoo17EvI3qZFRj26olhK0sLn3wq3uMzBabrhoeDslUbpHxuNPT8zY9igkzSp6WVwnYPYVXPm61_XuQ7fx6CP8UOCa4gXqCkASPxsEZmVnGp3qHw3jVxLy4znnGkQyNwQ7JWdJW3kKOeBfjO_-zPc5IFoJRhaziyqpSwFaqYc9SdRLNI1Medk6Dc9yCw3RX1xzCko7t5-IMExEiSeb2vegb-BIRhLbTYhFCBmZinatb5OFsJeFHhDQSftzN8XrzcVpo4Aimr0UPZTfY0HtrmFzQL16YO5bmfD1Z8baTXLsj103kp7qjT562P3Q45rtg",
  "refreshToken" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InJlZnJlc2hfdG9rZW4iLCJhdGkiOiIzYWU2MmI3MC0xOWFmLTRlNTktOTg2Ni1iNWU3NzJjMGM5MjEiLCJzdWIiOiIwNzdkMGU1NS1lNmM3LTQxZTQtOTE1Mi0xNWRlZWRlZjA4NDgiLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOlsiYWVyYS50ZXN0LXJlc291cmNlIl0sIm5iZiI6MTc1NDkxMzQzNywiaWF0IjoxNzU0OTEzNDM3LCJleHAiOjE3NTQ5MTc2MzcsImp0aSI6IjE2MTU4OGI1LWViNDItNDRjNi05MzM3LTU5MjAxODU1NmUyNiJ9.G4QgsSeqxa990UC2PJ-BxdrLMS6Nz9N8AnBCVUkti_CoUmaYxEKfVMXyrwE13TrOn1VjNCqqkd3E9wzroYcKosyCa0bHxHASslNxQE8EOnn_eVQtzYt8GO-fNc6d2hLryXNd0QvIcZN_5PxK6vqxBIlecaDc6PFS1AYEvpH4QEMw6TZFFir28yTew1J3e2X_q713JohtvfuD_yYbc7zqG_JRfudDQVP3XpNHksylEXZJj3bkVJHiw_ngyyo_D1Y5kEZrNaYgOy06ABqzUfDxgIpC5rP7y621lGzjzVc9CEo-28o728WdL6DB7JKAp0dmZpF6YbQ1B1XVS9euR8ndsQ",
  "expiresIn" : "600"
}
Example Curl request
$ curl 'https://psp.aerahost.com/access/v1/oauth2/token' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'x-api-key: uEUDiHqyPOOnikgWX3e50hjfgGlqmrhjQLg7vfVE' \
    -H 'Accept: application/json' \
    -d '{
  "grantType" : "password",
  "username" : "077d0e55-e6c7-41e4-9152-15deedef0848",
  "password" : "Secretpassw0rd!"
}'

4.3. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

4.3.1. AccessRequest

Access Token request

Name Description Schema

grantType
required

The grant type.

enum (password, refresh_token)

password
optional

The subject’s password.
Length : 0 - 80
Pattern : "(?=.\\d)(?=.)[A-Za-z\\d!@.#$%&*+_?&=\\-]{8,}$"

string

refreshToken
optional

The refresh token.
Length : 0 - 2048
Pattern : "^[a-zA-Z0-9\\-]+?\\.[a-zA-Z0-9\\-]+?\\.([a-zA-Z0-9\\-_]+)?$"

string

username
optional

The subject (username) that should be authorized.
Length : 0 - 36
Pattern : "^[a-zA-Z0-9\\-]+$"

string

4.3.2. AccessResponse

Name Description Schema

accessToken
optional

The access token.

string

expiresIn
optional

Seconds until the Access token expires.

string

refreshToken
optional

The refresh token.

string

responseInfo
optional

ResponseInfo

4.3.3. IntrospectForm

Name Description Schema

token
required

The token to introspect.
Pattern : "^[A-Za-z0-9-=]+\\.[A-Za-z0-9-=]+\\.[A-Za-z0-9-_.+/=]+$"

string

4.3.4. IntrospectResponse

Name Description Schema

active
required

Boolean indicator of whether or not the presented token is currently active.

boolean

ati
optional

This value is a CaSe-SenSiTiVe unique identifier for the AccessToken linked to the refresh token.

string (uuid)

azp
optional

Authorized party - the party to which the ID Token was issued.

string

exp
required

Integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire.

integer (int64)

jti
required

This value is a CaSe-SenSiTiVe unique identifier for the JWT.

string (uuid)

responseInfo
optional

ResponseInfo

sub
required

The Subject/Client_Id that requested the token.

string

4.3.5. ResponseInfo

Info object that can provide specific messages

Name Description Schema

externalResponseCode
optional

Additional response code from external systems.

string

message
optional

Specific response message

string

responseCode
required

Minimum length : 1

string

timeStamp
required

Timestamp. Mandatory
Minimum length : 1
Example : "2021-12-21T10:23:19.279Z"

string

4.3.6. Status

Name Schema

description
optional

string

status
optional

string

5. id.Hosting

id.Hosting consists:
* id.Authenticate: use your favorite Identity Provider (IDP) to identify an end-user
* id.Sign: sign a text or PDF document (also support PAdES for certain IDPs)
* id.Archive: signed documents will be stored in id.Archive, and can be viewed using the view module

id.Authenticate and id.Sign supports different Identity Providers (IDPs) and will redirect to the IDP to perform the authentication. Aera also has support for IDPs delivered by Aera (e.g. Aera Basic). A merchant will upon agreement be configured with one or more IDPs. If a merchant has more than one IDP configured, the process will start with the Consumer choosing the IDP to use. In the OIDC /authorize or Authentication Session request, a merchant can choose one or more IDPs among the list of supported IDPs to limit even more.

id.Hosting supports Authorization Code Flow of OpenID Connect 1.0, and also a propriatary end-point that can be called by back-end server whenever a standardized OIDC approach is not preferred.

5.1. Custom Styling

CSS styles can be customized on merchant profile. A display name and logo can also be configured. This will only show in pages hosted by Aera, and not necessarily on pages hosted by the specific Identity Provider

5.2. id.Authenticate

The Authenticate module provides a list of Identity Providers to choose between, and will guide the end user through an authentication process. The authentication can later be verified by calling the verify authentication end-point. The supported Identity Providers(IDPs) for a merchant is pre-configured.

API OIDC: OIDC configuration

API Access Token: Get Access Token to be used in below services
API Auth Session: Session for Authentication
API Auth Session Verify: Verify Authentication Session

The following sub-chapters will show the different alternatives to perform an authentication.

Sequence diagram id.Authenticate OIDC
Sequence diagram for id.Authenticate OIDC
Figure 4. Sequence diagram for id.Authenticate OIDC
Sequence diagram id.Authenticate session with callback
Sequence diagram for id.Authenticate session with callback
Figure 5. Sequence diagram for id.Authenticate session with callback
Sequence diagram id.Authenticate session using PostMessage
Sequence diagram for id.Authenticate session using PostMessage
Figure 6. Sequence diagram for id.Authenticate session using PostMessage

5.3. id.Sign

id.Sign provides a list of Identity Providers (IDP) to choose between when signing a document. The end user will be guided through a signing process. The signing can later be verified by calling the verify authentication end-point.

API Access Token: Get Access Token to be used in below services
API Sign Session: Session for Sign documents
API Sign PAdES Session: Session for Sign PAdES documents
API Sign Session Verify: Verify Signing Session

A signed document will be long-termed stored in the Aera Document Archive (id.Archive). See Document Services for more details. Can be viewed using View Document Session.

The following sub-chapters will show the different alternatives to perform a signing of a document.

Sequence diagram id.Sign session with callback
Sequence diagram for id.Sign session with callback
Figure 7. Sequence diagram for id.Sign session with callback
Sequence diagram id.Sign session using PostMessage
Sequence diagram for id.Sign session using PostMessage
Figure 8. Sequence diagram for id.Sign session using PostMessage

5.4. Paths

Descriptions of resources/paths in the service.

5.4.1. Authentication session

POST /hosting/api/v1/session/authenticate
Description

Creates an Authentication Session.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CreateSessionHostingRequest

Responses
HTTP Code Description Schema

200

OK

CreateSessionResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Hosting_ext

Example HTTP request
POST /hosting/api/v1/session/authenticate HTTP/1.1
Content-Type: application/json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiNjc3YTBiYjYtNDVmZS00N2Y4LTgwODEtZmFlYTA0ODIxZjA0Iiwic2NvcGUiOlsiaG9zdGluZ0F1dGgiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.lpWLzD1w4Gns8uuVjqA5fInQKtirFeRFHCvx88tjAaR8Y82W7tnqAQCsl6jZV_U5rZSMoni69tJ5BkMVkLULGeuEOCeaeRisXOy9lTzjoBnmAlN44SoPeeGZO_U0Q6I5YWU12EFH1IAEMKf-hiJ7B0A6r9aNgWNBIlWqlgf3NfPnO3ZteMG3y3gMhJUgM0hwsNFUDzS9T0bgb4j87EQ16I1OHN4BtOsI30nBlUSZoZvWCTEIxGsu_joNY_8iAhqJfT2d9qxNJf3797YtneQ0YhcL9CdfgBLsSlCz0bFZkFki2gqS7KZGvTl2LuEmRFfVodSp0r9-InOPaorBsbgS8Q
Accept: application/json
Content-Length: 247
Host: api.aerahost.com

{
  "uiLocales" : "no",
  "identifiers" : [ {
    "identifierValue" : "17012099479",
    "identifierType" : "NIN"
  } ],
  "scope" : [ "profile", "https://aera.id/scopes/altsub", "https://aera.id/scopes/nin", "https://aera.id/scopes/nin_alias" ]
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 327

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T06:31:17.193Z"
  },
  "sessionExpirationTime" : "2018-05-03T07:30Z",
  "sessionId" : "a3ea8ab6-1a81-4f40-8aad-7f89c4a85a38",
  "url" : "https://foo.bar/hosting/init?sid=a3ea8ab6-1a81-4f40-8aad-7f89c4a85a38&sk=9cf8f9b7-61ef-42db-916e-f7c3e6531af8"
}
Example Curl request
$ curl 'https://api.aerahost.com/hosting/api/v1/session/authenticate' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiNjc3YTBiYjYtNDVmZS00N2Y4LTgwODEtZmFlYTA0ODIxZjA0Iiwic2NvcGUiOlsiaG9zdGluZ0F1dGgiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.lpWLzD1w4Gns8uuVjqA5fInQKtirFeRFHCvx88tjAaR8Y82W7tnqAQCsl6jZV_U5rZSMoni69tJ5BkMVkLULGeuEOCeaeRisXOy9lTzjoBnmAlN44SoPeeGZO_U0Q6I5YWU12EFH1IAEMKf-hiJ7B0A6r9aNgWNBIlWqlgf3NfPnO3ZteMG3y3gMhJUgM0hwsNFUDzS9T0bgb4j87EQ16I1OHN4BtOsI30nBlUSZoZvWCTEIxGsu_joNY_8iAhqJfT2d9qxNJf3797YtneQ0YhcL9CdfgBLsSlCz0bFZkFki2gqS7KZGvTl2LuEmRFfVodSp0r9-InOPaorBsbgS8Q' \
    -H 'Accept: application/json' \
    -d '{
  "uiLocales" : "no",
  "identifiers" : [ {
    "identifierValue" : "17012099479",
    "identifierType" : "NIN"
  } ],
  "scope" : [ "profile", "https://aera.id/scopes/altsub", "https://aera.id/scopes/nin", "https://aera.id/scopes/nin_alias" ]
}'

5.4.2. Sign document session

POST /hosting/api/v1/session/sign
Description

Creates a Session for signing documents (text, PDF).

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CreateSessionSignRequest

Responses
HTTP Code Description Schema

200

OK

CreateSessionResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Hosting_ext

Example HTTP request
POST /hosting/api/v1/session/sign HTTP/1.1
Content-Type: application/json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiaG9zdGluZ1NpZ24iXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.aIJR6RJ63Szm5zbSe-bdCNCkJo5mXMwfyl1IjSOxdZl9g3b-ZZxYUF1N5oWN3Bp_PBJdDUSgB7aqk4x3eMyzXcpv0soWBQpjLKyx-vqHZY4XOmZBlZBbFEHs9eMerOQ2WA6zjhrc5dhgNYWMBH6gyTt8tMZ0va_ljWJ2NnTcqev3vMlN8ZhdtLVsSU5IirQ--nmlirvgI8w5uIccdEOLKORIkrjrgWCNFtYX4e4rFKStGYOR8WT5LqWgGLFzNKWejmm5uEpDLdSK31GGdv9CBYB4-HDx071ChcEnynwZOrJK2IBb7dvxcbVyO8ZsRSJEbbo-5WaXYETQbRqZIlDt3g
Accept: application/json
Content-Length: 477
Host: api.aerahost.com

{
  "uiLocales" : "no",
  "scope" : [ "profile", "https://aera.id/scopes/altsub", "https://aera.id/scopes/nin", "https://aera.id/scopes/nin_alias" ],
  "dataToSign" : {
    "description" : "Kontraktsnummer 1001215646541321241123123123123132, version 20190201",
    "contract" : "QmVrcmVmdGVsc2UgcMOlIHNhbXR5a2tlIGF2IGJlaGFuZGxpbmcgb2cgbGFncmluZyBhdiBkaW5lIHBlcnNvbmxpZ2UgZGF0YSBvdmVyIHRpbCBBZXJhLiBEYXRhIHZpbCBiZWhhbmRsZXMgaWh0IHRpbCBicmE=",
    "mimeType" : "text/plain"
  }
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 327

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T06:31:11.513Z"
  },
  "sessionExpirationTime" : "2018-05-03T07:30Z",
  "sessionId" : "635e07c8-a4f9-4c74-8c28-8c71eeb51791",
  "url" : "https://foo.bar/hosting/init?sid=635e07c8-a4f9-4c74-8c28-8c71eeb51791&sk=aa903fe9-8b81-4dfd-a37f-32d25a750105"
}
Example Curl request
$ curl 'https://api.aerahost.com/hosting/api/v1/session/sign' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiaG9zdGluZ1NpZ24iXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.aIJR6RJ63Szm5zbSe-bdCNCkJo5mXMwfyl1IjSOxdZl9g3b-ZZxYUF1N5oWN3Bp_PBJdDUSgB7aqk4x3eMyzXcpv0soWBQpjLKyx-vqHZY4XOmZBlZBbFEHs9eMerOQ2WA6zjhrc5dhgNYWMBH6gyTt8tMZ0va_ljWJ2NnTcqev3vMlN8ZhdtLVsSU5IirQ--nmlirvgI8w5uIccdEOLKORIkrjrgWCNFtYX4e4rFKStGYOR8WT5LqWgGLFzNKWejmm5uEpDLdSK31GGdv9CBYB4-HDx071ChcEnynwZOrJK2IBb7dvxcbVyO8ZsRSJEbbo-5WaXYETQbRqZIlDt3g' \
    -H 'Accept: application/json' \
    -d '{
  "uiLocales" : "no",
  "scope" : [ "profile", "https://aera.id/scopes/altsub", "https://aera.id/scopes/nin", "https://aera.id/scopes/nin_alias" ],
  "dataToSign" : {
    "description" : "Kontraktsnummer 1001215646541321241123123123123132, version 20190201",
    "contract" : "QmVrcmVmdGVsc2UgcMOlIHNhbXR5a2tlIGF2IGJlaGFuZGxpbmcgb2cgbGFncmluZyBhdiBkaW5lIHBlcnNvbmxpZ2UgZGF0YSBvdmVyIHRpbCBBZXJhLiBEYXRhIHZpbCBiZWhhbmRsZXMgaWh0IHRpbCBicmE=",
    "mimeType" : "text/plain"
  }
}'

5.4.3. Sign PAdES document session

POST /hosting/api/v1/session/sign/pades
Description

Creates a Session for signing PAdES documents.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CreateSessionSignRequest

Responses
HTTP Code Description Schema

200

OK

CreateSessionResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Hosting_ext

Example HTTP request
POST /hosting/api/v1/session/sign/pades HTTP/1.1
Content-Type: application/json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiaG9zdGluZ1NpZ24iXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.aIJR6RJ63Szm5zbSe-bdCNCkJo5mXMwfyl1IjSOxdZl9g3b-ZZxYUF1N5oWN3Bp_PBJdDUSgB7aqk4x3eMyzXcpv0soWBQpjLKyx-vqHZY4XOmZBlZBbFEHs9eMerOQ2WA6zjhrc5dhgNYWMBH6gyTt8tMZ0va_ljWJ2NnTcqev3vMlN8ZhdtLVsSU5IirQ--nmlirvgI8w5uIccdEOLKORIkrjrgWCNFtYX4e4rFKStGYOR8WT5LqWgGLFzNKWejmm5uEpDLdSK31GGdv9CBYB4-HDx071ChcEnynwZOrJK2IBb7dvxcbVyO8ZsRSJEbbo-5WaXYETQbRqZIlDt3g
Accept: application/json
Content-Length: 46031
Host: api.aerahost.com

{
  "uiLocales" : "no",
  "identifiers" : [ {
    "identifierValue" : "17012099479",
    "identifierType" : "NIN"
  } ],
  "scope" : [ "profile", "https://aera.id/scopes/altsub", "https://aera.id/scopes/nin", "https://aera.id/scopes/nin_alias" ],
  "dataToSign" : {
    "description" : "Kontraktsnummer 1001215646541321241123123123123132, version 20190201",
    "contract" : "JVBERi0xLjcNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFIvTGFuZyhlbi1VUykgL1N0cnVjdFRyZWVSb290IDEwIDAgUi9NYXJrSW5mbzw8L01hcmtlZCB0cnVlPj4vTWV0YWRhdGEgMjAgMCBSL1ZpZXdlclByZWZlcmVuY2VzIDIxIDAgUj4+DQplbmRvYmoNCjIgMCBvYmoNCjw8L1R5cGUvUGFnZXMvQ291bnQgMS9LaWRzWyAzIDAgUl0gPj4NCmVuZG9iag0KMyAwIG9iag0KPDwvVHlwZS9QYWdlL1BhcmVudCAyIDAgUi9SZXNvdXJjZXM8PC9Gb250PDwvRjEgNSAwIFI+Pi9FeHRHU3RhdGU8PC9HUzcgNyAwIFIvR1M4IDggMCBSPj4vUHJvY1NldFsvUERGL1RleHQvSW1hZ2VCL0ltYWdlQy9JbWFnZUldID4+L01lZGlhQm94WyAwIDAgNjEyIDc5Ml0gL0NvbnRlbnRzIDQgMCBSL0dyb3VwPDwvVHlwZS9Hcm91cC9TL1RyYW5zcGFyZW5jeS9DUy9EZXZpY2VSR0I+Pi9UYWJzL1MvU3RydWN0UGFyZW50cyAwPj4NCmVuZG9iag0KNCAwIG9iag0KPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0xlbmd0aCAyMTg+Pg0Kc3RyZWFtDQp4nK3RTWvDMAwG4LvB/+E92oMqUuzYDZQemrRlg0JLAzuMnrqsDJbu+//PKb1skNOig0BI6EEI2RazWbapbmvwfI5FXeFdKybuo5QcjJByLHN8tFrd3+Cs1aLRKlsJRIg9mietJM0xBDEnzj0il1SkTpfm1vuI02faidOlml6rtVYPZm8PaO60WqaNO63+RUfi8Iu+iFfoubMTZ96sMy8txkOFPYUwhG7txJu6Tys8WvHmdUTZBXKD5x6/rTjTjcgVRe8McO35i0a0oiOZDll/voflpsIPFKeGsw0KZW5kc3RyZWFtDQplbmRvYmoNCjUgMCBvYmoNCjw8L1R5cGUvRm9udC9TdWJ0eXBlL1RydWVUeXBlL05hbWUvRjEvQmFzZUZvbnQvQkNERUVFK0NhbGlicmkvRW5jb2RpbmcvV2luQW5zaUVuY29kaW5nL0ZvbnREZXNjcmlwdG9yIDYgMCBSL0ZpcnN0Q2hhciAzMi9MYXN0Q2hhciAxMTcvV2lkdGhzIDE4IDAgUj4+DQplbmRvYmoNCjYgMCBvYmoNCjw8L1R5cGUvRm9udERlc2NyaXB0b3IvRm9udE5hbWUvQkNERUVFK0NhbGlicmkvRmxhZ3MgMzIvSXRhbGljQW5nbGUgMC9Bc2NlbnQgNzUwL0Rlc2NlbnQgLTI1MC9DYXBIZWlnaHQgNzUwL0F2Z1dpZHRoIDUyMS9NYXhXaWR0aCAxNzQzL0ZvbnRXZWlnaHQgNDAwL1hIZWlnaHQgMjUwL1N0ZW1WIDUyL0ZvbnRCQm94WyAtNTAzIC0yNTAgMTI0MCA3NTBdIC9Gb250RmlsZTIgMTkgMCBSPj4NCmVuZG9iag0KNyAwIG9iag0KPDwvVHlwZS9FeHRHU3RhdGUvQk0vTm9ybWFsL2NhIDE+Pg0KZW5kb2JqDQo4IDAgb2JqDQo8PC9UeXBlL0V4dEdTdGF0ZS9CTS9Ob3JtYWwvQ0EgMT4+DQplbmRvYmoNCjkgMCBvYmoNCjw8L0F1dGhvcihBdWR1biBXYW5nZW5zdGVlbikgL0NyZWF0b3Io/v8ATQBpAGMAcgBvAHMAbwBmAHQArgAgAFcAbwByAGQAIABmAG8AcgAgAE8AZgBmAGkAYwBlACAAMwA2ADUpIC9DcmVhdGlvbkRhdGUoRDoyMDIwMDIxMTEwNDMwOSswMScwMCcpIC9Nb2REYXRlKEQ6MjAyMDAyMTExMDQzMDkrMDEnMDAnKSAvUHJvZHVjZXIo/v8ATQBpAGMAcgBvAHMAbwBmAHQArgAgAFcAbwByAGQAIABmAG8AcgAgAE8AZgBmAGkAYwBlACAAMwA2ADUpID4+DQplbmRvYmoNCjE3IDAgb2JqDQo8PC9UeXBlL09ialN0bS9OIDcvRmlyc3QgNDYvRmlsdGVyL0ZsYXRlRGVjb2RlL0xlbmd0aCAyOTY+Pg0Kc3RyZWFtDQp4nG1R0WrCMBR9F/yH+we3sa1jIMKYyoZYSivsofgQ610NtomkKejfL3ftsANfwjk355ycJCKGAEQEsQDhQRCD8Oh1DmIGUTgDEUIU++EcopcAFgtMWR1AhjmmuL9fCXNnu9Kta2pwW0BwAEwrCFmzXE4nvSUYLCtTdg1p98wpuEp2gME1UuwtUWaMw8zUtJNX7sh5qbQ+i3e5Lk84JupjRrsJ3dyW7iCG6I3P0sYRJrys9elB9l56NDfMqXT4QfJEtsfs+cOfulaa8rPkhjx40z5BOmX0wK1T39KDX/Zl7OVozOVxe560ZyLHJR3uZGnNiL+f/TriKyVrU40Gea1ONNL253hZZWWDG1V1loa7Jl3TFvzH83+vm8iG2qKnj6efTn4AVAqiuw0KZW5kc3RyZWFtDQplbmRvYmoNCjE4IDAgb2JqDQpbIDIyNiAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDI1MiAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCA2MTUgMCA0NTkgMCAwIDAgMCAwIDAgMCAwIDAgNTE3IDAgMCA0NTkgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgNDIzIDUyNSA0OTggMCAwIDAgMjMwIDAgMCAyMzAgNzk5IDUyNSA1MjcgNTI1IDAgMCAwIDMzNSA1MjVdIA0KZW5kb2JqDQoxOSAwIG9iag0KPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0xlbmd0aCAyNzYzNi9MZW5ndGgxIDk1NDIwPj4NCnN0cmVhbQ0KeJzsXQdYVMfanjlbYVnYhaUusIsLWFZBxYIlstIUKwiroKIgRVRULNiihsREExITc1NNNT03piyrRjTN5Kb34k29KeYm9yY3Mb1YIvzvnG9H0aj5b/7cJzfPvx+8533nm2/mzMyZmTNrIDDOGLPgomVVBbn5ZVd8PCWX8YnfMabfVJA7Ls+w7JppjI+bzpjm6omlmf2vf7R6B2P8fJSqqplf3TSIRycwNu9y5L9es2ypc1fTmwMZu+lcxnQP1jfNnr/2Pc1gxhY2MmZ2z25cWb8pa8Qqxu7wMDYio6GuuvbA+JU+1BeG+gY1wGG+J3E/0vlIpzbMX7ri6/yk8Uh/wticuxsX1lQP+8btYOzjJoRPnl+9oinDnB6N/AbEO+fXLa2+5pwtyxifjPuzcxdUz6+74dD3Mxm3P81Y3yVNC5cs7bSz9ejPcBHftLiuKWp2t3jGVl+N233GxFjoh+5beuPmjTMjhn/P4o1M2AOfrX5e8BtFyycePnSkJeRz4yAkQ5jCyFBOzzoYfzx0y+FDh7aEfK7W1MXi7xYeey/WwixsBdOgpIVlsg2MRQ7CfRXkarRuvonpmFG3WZeFKpOJNS+z9QozMiVCpyiKVqNoP2IZnXtY6plqC2DjS51OhvFMe57aYLhBSXcy3inyNDt14aKnzKYNP9Ya/hL7zU37Obv715TT3PPryv1fTf/Gb3dfbbdT14X+jfqt7vN7m+Y5Nv9kfm0du+m4uJbj06esr/iX4/jnp49BvvVUecoHJy+r17ObtJeePE97F6v/pTZ1Nc0Tx+rR7D9hHCayopOWqWCJx91zI7vx37nn72GaWWzq6fL1nPK1A1jVceUOs8r/YLP+q42/zs77X8Rs/rUx+lq2GeN9yvLa7NM/s5/Fd6lLefaX23UyU+5lKT+rt/nnvpPF6KIoTv/WL8eLGLT38l/Txt/KlAksX/mYjVbaj9/jeQ2rPqpnsEbtZNao/ENFAeIbVf8PAf47cymfkv7/ZpjXjL/4e7ciaEELWtDIlGt56Cnzqtj+U+bp2FX/mRb995tmILvw925D0IIWtKAF7deb9tF/798+fsk0Y9nFgpWLiE96z/nH8pQ3u+gWVvhbtiVoQQta0IIWtKAFLWhBC1rQgvbHN/k583TW9XOmtK6fN4MWtKAFLWhBC1rQgha0oAUtaEELWtCC9vsa/1U/jR60oAUtaEELWtCCFrSgBS1oQQta0IIWtKAFLWhBC1rQgha0oAUtaEELWtCCFrSgBS1oQQta0IIWtKAFLWhBC1rQgha03946d//eLQha0H5n0wSQGPhLUh1IQSnfMS37EOkM5oQSf9PJzLohlc8K2XhWzEpZHZvDmthi1sy28H5JfZOGJI1whjjPSnu+U/2LUIh3Hhdfg/hGxC89STzv/B7N6NW5t/ODzh+ZgZlQ/jvGeAJWaQ0b+NkG8bW/+77q988ItLPXcb3oBqT+zBvooWaM5ipu4Qk8mS/kzXwZX8Mv4NfwHUzPf1Ajfjjxr2ghrQT+5pbCTm/82D1OMcDlv1BDV4sD0o/z5KvXKep1xi80Re1jQKt/C+dYf6EvAkSv/yim+U9Uyuv/H8xr5pm6/rylSxYvalq4YH7jvLlzGmbX19XOmjmjcvq0qRXl3rLSSSXFEyeMHzd2TNHoUYUF+Xm5Iz05I84YPmzokOzBgwZmZvTp3SM9LdXVzRFns1oizKbQEKNBr9NqFM56F7gKq5y+9CqfNt01enQfkXZVw1HdxVHlc8JVeHyMz1mlhjmPj/Qgsv6ESA9Feo5GcotzOBvep7ezwOX0vZDvcrbzqSXl0BvzXRVO335Vj1e1Nl1NmJFISUEJZ0FcQ77Tx6ucBb7CZQ2tBVX5qK/NFJrnyqsL7dObtYWaIE1Qvh6upjbeYwRXhdKjYGibwoxmcVufJq2gutZXXFJekG9PSalQfSxPrcunz/MZ1Lqcc0Sb2YXOtt57Wi9qt7BZVe6wWldt9fRyn6YahVo1Ba2tG3xWt6+nK9/Xc9VHcehyna+3K7/A53ahsrGTjt6A+3RpFpez9XuGxrv2f368pzrg0adZvmdCii4eHSbkS83QNrQQ/UtJEW25sN3DZiHhaykpp7STzbL7mSfTXeFTqkTOHpkT7RU5LTLnaPEqV4p4VAVVge9lDXG+llnOPr0x+up3Gr6R7/Rp0qtm1TQIrq5rdeXn07iVlfs8+RCe6kBfC9r6ZiK+ugqdmCOGoaTcl+lq8tlcuRQAh1M8gzml5WqRQDGfLc/HqmoCpXyZBfmiXc6C1qp8aqCoy1VSvotldX7QNsBp35bFBrAK0Q5fTB4eSnpBa3ltvc9RZa/F/Kx3lttTfJ4KDF+Fq7yuQjwll8XX8wPcLkW9o1oKfTshWgaLnhvSjM5yxa6pEE8LDmchLq7c4ciw4HGpSfFEc4c7y7mdyTDcJRAh1HH1IKFJyxstsjSiaN5oe0pFCtlpmmQPtEmX5jN2qcsCx9E20X1O2TSKFg3q6Syoy+/SwOMq1QUaGKjt5O1UxFgEbowSRvE4R8ssTRpWLnwKqlFd4inGOX2s2FnuqnNVuDCHPMXlom9irNXnO7bUNbZkarn6tAOzpOy4FOVnU8rHUpAtE0oe5mCh2y4fq5oepaaPJkefkF0ks12iXa2ttW1Mkyamsr2Nq0KXd2GFb6K7wuWb5XaliHb26d1mZGEpZVV5WKuF2O5chdUup8VZ2Frd3tkyq7XN42ltKqhqGIp10eoqqm11lZYPt6uNn1S+xr5K3DuSjeVjy3JRlcJy21z8/JI2Dz+/dGr5LgtjzvPLyv0KV/KqcivaUpFXvsuJF4DqVYRXOEXCKRKipklIGNV4+y4PYy1qrlZ1qOmads5Un1H6OKtpV8hnoRulqzfy4HRU066lHI+M1sJnJF8LRfcIRBuRYxE5u5kizpgik6yNiQH2hOo8Rk+IJ0wxKxhS4fLDsxuxIZxtC+Nmbm9DnZNUdztvaQvx2HepNU0KRLYgUvhajvrQchHWpSLcjzruPdYD79TybWEM9atXROQKwyyMa8AcwvukwFkr5t/qiobWqgqxe7AYzFV8cx93jWA+xTUCLdaH+UJddbk+kytX+HOEP4f8euE3YObzGI6HLTbd1ioXNmKsmHJm57TWNKJKZ3tnZ1l5ygv2/RUpWEvTganlvhA3Xm66tDGIGyVQBfcoX0tNtWgH85aLsoa0opoKrEtZIUKKfCGoISRQAyIK1TJivaFQDeZatUuVcGPraKnwVbjFTcvnVKjr1eJjo11Dffp0qlOXLm6UWdEa6eqvbj5Y66FpGwSFoG2stJw8diRxswoaJEMYWl7jQlZNlZPmSCnWMr0sQu3kqcOer02vUxFqD2Qy0S1Nmskc6gvJQIX4FtqUIfYcXZqhooIar6Y2BAJwb4vPhBaldxnKQAGMDrKKRFvwvQFNFaGPimpK2tkk1wpsnaLRak0GZPvMaUXVeLtReRM8rmxZ2Cg2QVOgjsfJaxA9D8O4Y0to77zDtTKli2HvEG8/Mf+YfRcWKqtoPdHhm+bu09t4otesultbjeaTF6DxMpqPsupU0mrEWwEsJpw635wF4lXpGtOmTHCrzFVuHePCG0RJE8BBR4Plk+KsrRBRaHKxupedMoh3CRKvabXyVsswmeKBFD3MVt/s45MNR5OFAjgMpmXQGQJdEXst5spcu68RM1OGiCfibHVaXENd4qIWHiVQhYd0dFlg+mPWiUXTUuMsn4XJjgoLq1oLW8URtaY6MGyBO/kWuI+rEuuCY/KgItEdX0uxs6rCWYWjKS8pT0mxYzWCnfU4p7qqxaugmPpTPFU9qlS3iinOcFKpsPsMeDHVV9e5UvAG8YkdiEZftFEbWDbM3trqavWp67YQwag+HcuuSBC+m9yu6jpxhK4XJ+g6tWwhmquOjqjNXuDCWq6DWx1LDBy2vlniUtMqDuiVVW6MhLU1stU5pBVbcCXeHtr0mslVeFWJN5JTfdTVdqQwCEUiVYGKKDAkTQTSEhCtme9uqzSkHfOo3wvdFGxUa0XLJpX7imWIup6EWOT2KbHZyBSd55Omlst9SiOyizC8Hswquyjt9Cll5YHHo5YvEkXt8oFRMXjUd0hgfR1928j30HQ7xvSUfrwcNCNLlaeVJ1k2cyhPBfhdlq28zbzKW+A3wG8G+HXwX8F7wa+BXwW/An4E/DD4IfCDzMu0yjtsAFAGaI6qWuBWYC+gY/NQE2cmlOfMpjzG8oFaYClwOaBD7MPIuxU1cuZUzt0eEsfH4IGuk+IcKc6WokWKs6RYK8UaKVZLcaYUq6RYKcUKKZZLsUyKZimWSrFEikVSNEmxUIoFUsyXolGKeVLMlWKOFA1SzJaiXoo6KWqlqJFilhTVUlRJMVOKGVJUSjFdimlSTJWiQopyKaZIMVkKrxRlUpRKMUmKEimKpZgoxQQpxksxToqxUoyRokiK0VKMkqJQigIp8qXIkyJXipFSeKTIkWKEFGdIMVyKYVIMlWKIFNlSDJZikBQDpRggRZYU/aXoJ0VfKTKlyJCijxS9pXBL0UuKnlL0kKK7FOlSpEmRKoVLim5SpEjhlMIhRbIUSVIkSmGXIkGKeCnipIiVIkaKaClsUkRJESmFVQqLFBFShEthliJMCpMUoVKESGGUwiCFXgqdFFopNFIoUnApWEDwTik6pDgixU9SHJbikBQHpTggxY9S/CDF91J8J8W3UnwjxddSfCXFl1J8IcV+KT6X4jMp/iXFp1J8IsU/pfiHFB9L8ZEUf5fiQyn2SfGBFO9L8Z4U70rxNynekeJtKd6S4k0p3pDidSn+KsVeKV6T4lUpXpHiZSlekuJFKV6Q4nkpnpPiWSmekeJpKZ6S4kkpnpDicSn+IsVjUjwqxR4pHpHiYSkekuJBKR6QYrcUu6Rol2KnFPdLsUOK7VJsk8IvRZsUPinuk+JeKe6R4m4ptkpxlxR/luJOKe6Q4nYpbpPiVilukeJmKW6SYosUN0pxgxTXS3GdFNdKcY0Um6W4WoqrpLhSiiukuFyKy6T4kxSXSrFJikukuFiKjVJcJMWFUrRKcYEU50uxQYr1UpwnhTz2cHns4fLYw+Wxh8tjD5fHHi6PPVwee7g89nB57OHy2MPlsYfLYw+Xxx4ujz1cHnu4PPZweezhi6WQ5x8uzz9cnn+4PP9wef7h8vzD5fmHy/MPl+cfLs8/XJ5/uDz/cHn+4fL8w+X5h8vzD5fnHy7PP1yef7g8/3B5/uHy/MPl+YfL8w+X5x8uzz9cnn+4PP9wef7h8vzD5fmHy/MPl8ceLo89XB57uDztcHna4fK0w+Vph8vTDpenHS5PO1yedrg87fC8bUK0K+f6k0c4cGb2J0eDzqHU2f7koaAWSp1FtNafHAZaQ6nVRGcSrSJa6U8aCVrhT8oDLSdaRtRMeUsptYRoMTkX+ZNyQU1EC4kWUMh8okaief7EAtBcojlEDUSzier9ifmgOkrVEtUQzSKqJqoimkk0g8pVUmo60TSiqUQVROVEU4gmE3mJyohKiSYRlRAVE00kmkA0nmgc0ViiMX57EaiIaLTfPgY0iqjQbx8LKvDbx4HyifKIcilvJJXzEOVQuRFEZxANp8hhREOp+BCibKLBRIOIBlJlA4iyqJb+RP2I+lJlmUQZVK4PUW8iN1Evop5EPYi6U9XpRGlUZyqRi6gbVZ1C5KRyDqJkoiSiRCI7UYI/YQIonijOnzARFEsUQ85oIhs5o4giiayUZyGKIGc4kZkojPJMRKFEIZRnJDIQ6f3xxSCdP74EpCXSkFOhFCdiKvFOog41hB+h1E9Eh4kOUd5BSh0g+pHoB6Lv/XFloO/8caWgbyn1DdHXRF9R3peU+oJoP9HnlPcZ0b/I+SnRJ0T/JPoHhXxMqY8o9XdKfUi0j+gDynuf6D1yvkv0N6J3iN6mkLco9SbRG/7YKaDX/bGTQX8l2kvO14heJXqF6GUKeYnoRXK+QPQ80XNEz1LIM0RPk/MpoieJniB6nOgvFPkYpR4l2kP0COU9TPQQOR8keoBoN9EuonaK3Emp+4l2EG0n2uaPyQH5/THTQG1EPqL7iO4luofobqKtRHf5Y7Bf8z9TLXcS3UF5txPdRnQr0S1ENxPdRLSF6Eaq7Aaq5Xqi6yjvWqJriDYTXU0FrqLUlURXEF1OeZdRLX8iupTyNhFdQnQx0UaiiyjyQkq1El1AdD7RBqL1/uhq0Hn+6Fmgc4nW+aPrQecQne2P9oJa/NHYjPlZ/uhBoLVEa6j4aip3JtEqf3QtaCUVX0G0nGgZUTPRUqIlVPViKr6IqMkfXQNaSJUtoMj5RI1E84jmEs2hcg1Es6ll9VS8jqiWImuIZhFVE1URzSSaQZ2upJZNJ5pGnZ5KVVfQjcqJplBzJ9ONvFRLGVEp0SSiEr/NAyr228QdJvptYnpP8NvWgcb7bX1A4yhkLNEYvw3nAl5EqdFEo8hZ6LetBRX4bRtA+X7bWaA8v60FlOuPLASNJPIQ5RCN8Efi/c7PoNRwv7UCNIxoqN8qpsYQomy/dRRosN9aDhrkt04FDaS8AURZfmtvUH+K7Oe3io719VvF2swkyqDifegOvYncVFkvop5UWQ+i7kTpRGl+qxilVCIX1dmN6kyhypxUi4MomcolESUS2YkSiOL9lkpQnN8yAxTrt8wExRBFE9mIoogiqYCVCljIGUEUTmQmCqNIE0WGkjOEyEhkINJTpI4iteTUEClEnIh5OiNmOQQ6ImocRyJqHT9BHwYOAQfhOwDfj8APwPfAd/B/C3yDvK+R/gr4EvgC2A//58BnyPsX0p8CnwD/BP4RPtvxcXiD4yPg78CHwD74PgC/D7wHvIv038DvAG8DbwFvmuc53jD3c7wO/qu50bHXnO54DXgV+hWz2/Ey8BLwIvJfgO9583zHc9DPQj8D/bR5ruMp8xzHk+YGxxPm2Y7HUfYvqO8x4FHA07kH10eAh4GHwhY5Hgxb7HggbIljd9hSxy6gHdgJ//3ADuRtR942+PxAG+AD7jOtdNxrWuW4x7TacbdpjWOraa3jLuDPwJ3AHcDtwG2mPo5bwbcAN6PMTeAtpnmOG6FvgL4euA76WtR1DerajLquhu8q4ErgCuBy4DLgTyh3KerbFDrBcUnoRMfFobMdG0Nvc1wUeofjPE2a41xNtmMdz3ac423xnr21xXuWd4137dY1XtMablpjXzN2zZlrtq55Z40nUh+62rvKe+bWVd6V3uXeFVuXe3cr61m9cp5nuHfZ1mavttnWvLRZ810z39rM85t532ausGZLs7NZE7bUu9i7ZOtiL1tcvLhlsW+xdphv8QeLFbaYh7Z37tm22J5cCPasXmy2FC7yLvQ2bV3oXVA/3zsXDZyTPdvbsHW2tz671lu3tdZbkz3LW51d5Z2ZXemdsbXSOz17qnfa1qneiuxy7xTET84u83q3lnlLs0u8k7aWeCdmT/BOgH989ljvuK1jvWOyR3uLto72jsou9Bag8yzRkuhM1FhEAyYkoiXMznP72j32D+xf2bXM7rPvsWsiIxIcCUrPiHieNzGeL4w/K/6SeE1E3EtxiieuZ+/CiNiXYt+P/TJWG+WJ7ZlRyGIsMc4YTbToW8z4skKVc/KJ+w1U++qIcaUXRkTziGhHtFLwZTRfzzTcybn48Ugn1xgRs51HOwo1D3HxI3c6xvkmVuYe225kk8b6jMXTfPx8X1qpuHpKpvr05/uYd+q08jbOL65QfybBZxM/VKKmz9u4kSXljvUllZb7NVu2JOVWjPW1CO3xqLpTaIaQCveMJc1L3OWeM5j1A+tXVk30I5aXLEpEBI+I6IxQPBFofES4I1wRl85wjSe83+DCCLPDrIhLp1kT4zHDI/rXPay4rDDC5DAp3hzTRJPiMeXkFXpMffoW/qyf20Q/6c7upTNwmbFkqVv9RqqCN4ukW3jF95KlSIuvZjXN3Kc1CgPNXAJbKp1LT1/qv934792AP77RT/KM7FTOZbXKOuAc4GygBTgLWAusAVYDZwKrgJXACmA5sAxoBpYCS4BFQBOwEFgAzAcagXnAXGAO0ADMBuqBOqAWqAFmAdVAFTATmAFUAtOBacBUoAIoB6YAkwEvUAaUApOAEqAYmAhMAMYD44CxwBigCBgNjAIKgQIgH8gDcoGRgAfIAUYAZwDDgWHAUGAIkA0MBgYBA4EBQBbQH+gH9AUygQygD9AbcAO9gJ5AD6A7kA6kAamAC+gGpABOwAEkA0lAImAHEoB4IA6IBWKAaMAGRAGRgBWwABFAOGAGwgATEAqEAEbAAOgBHaAd2YmrBlAADjBWy+HjHcAR4CfgMHAIOAgcAH4EfgC+B74DvgW+Ab4GvgK+BL4A9gOfA58B/wI+BT4B/gn8A/gY+Aj4O/AhsA/4AHgfeA94F/gb8A7wNvAW8CbwBvA68FdgL/Aa8CrwCvAy8BLwIvAC8DzwHPAs8AzwNPAU8CTwBPA48BfgMeBRYA/wCPAw8BDwIPAAsBvYBbQDO4H7gR3AdmAb4AfaAB9wH3AvcA9wN7AVuAv4M3AncAdwO3AbcCtwC3AzcBOwBbgRuAG4HrgOuBa4BtgMXA1cBVwJXAFcDlwG/Am4FNgEXAJcDGwELgIuBFqBC4DzgQ3AeuA8VjuyhWP9c6x/jvXPsf451j/H+udY/xzrn2P9c6x/jvXPsf451j/H+udY/xzrn2P9c6x/vhjAHsCxB3DsARx7AMcewLEHcOwBHHsAxx7AsQdw7AEcewDHHsCxB3DsARx7AMcewLEHcOwBHHsAxx7AsQdw7AEcewDHHsCxB3DsARx7AMcewLEHcOwBHHsAx/rnWP8c659j7XOsfY61z7H2OdY+x9rnWPsca59j7XOs/d97H/6DW8Xv3YA/uLElS7oczITFzRS/PmS4gbGOy477PZJiNpctYS34Ws82ssvYI+wdNoutg9rMtrDb2Z+Zjz3KnmFv/Lu/a3M661ipm8/CNDuZnkUx1nmoc3/H7UC7LryL5zKkorTOY55OS+cXJ/i+6Lis09LRro9koWpZs/IqvN/yI52H8MpFunOQSCsboCPUEl8bbui4r+OOE8aghE1l09h0VsmqWDX6X8sa2ByMzDzWyOazBWpqAfJm41qP1ExEYXtR9bGohawJEL8L1MyW4Uv8HtGSQErkLVLTzWw5vlawlWwVO5OtZmsC1+WqZzVyVqnpFcBadhaezNnsHFVJJs86di47D09tAzufXXDa1AVHVSu7kF2E53wxu+SUeuNxqU34upT9CfPhcnYFu5JdjXlxLbvuBO9Vqv8adgO7EXNG5F0Bz42qErkPsifZDnYvu4/dr45lDUaNRkSOS706hk0Yg9Xo4bouLabxW350tNai76JvrYGeroD/nC4llgXGUUSuQyTVQs9B1LLmhJHYhD6QPtYjSl2h9v+Yt+uonM4rx+O6LiNzrZoS6kTvqfSV7HqswJtwFaMq1M3QpG5UdVf/DUdjt6jpW9it7DY8iztUJZk8t0Pfwe7E2r6LbWV34+uY7qqI72X3qE/Ox9qYn21j2/Ek72c7WbvqP13eyfzbAn7/Uc8utps9gBnyMNuDneYxfEnPQ/A9EvA+rvoo/Rj7C9IiilJPsqewQz3LnmPPs5fYE0i9qF6fRupl9ip7jb3BzVCvsE9xPcJe1n3EwtlIfPzfjXG+js34pd+t/L+ZLoFFsy2dBzqXdx7QjGb1vAwHyLvxlLazi/CJfcGxSO5godoPmY1t7/xBMx3c48jbuoaOmzu/ZDrsmks0r2KX0zADG8LGswnsKt957vIHmRmnlBg2lO/YEZ2fb+xjeBgnEIU5cYYxMs7zPBFaxbwzISHHtXOgfqPGWtTO+2zPMWzE6TznyHtHXsw88t7+yCGZ+3nmu/ve22f5+kXrkMysfXv39etr99gSzDsbUXSga2fjQI1+Y6PGmiPKe0IaczyKYWMjKonLcSe86H4x0/2iG9W4+/ar4NYUqwpbuGIw2PSubhnKwO7pg7Ky+o9QBg5Id3ULV1TfgEGDR2iy+icrGpv0jFBEmmte/WmqZuIRvbLWlTM5S5ecEGEz63VKYlxkn+FpltJpacMzkgwag16jMxp6DM7tNraxoNvbBmtSdExSpNEYmRQTnWQ1HHlHF37oG1344Txt4+HLNfph03NSNVeHGhWtXt+eHBffa1hK0eSIKIvWFGWxxhgNkdawHvnTj6yPThR1JEZHU11HxmM472ZMewlGP5I52NVi3D1JOSk8Ks7Cx0dZInCxmXGJDMMlzoTLA/j4xlhC5yfbEJHQ3vnVtogAm1X+YVuYyp9sQ3TCA/igFcLieJg/vMTeztPbdGUsZ38Onsk+9fW9l6hf30p7W3hcOw/b3hheohOR/kaE4hHkqAMvhjGlW/pA64BBWSkYR8OADMXlsopx114y+bavbu/4IrZnz1ieducn15fsGLDwrvX3ta2+a/EQ5Zo7D982ydFde053x5RbPtk8Z8e5Y36yjmh5lHF2d+chTRl63p2tE/1uM0S1U6+iAr2KCvQqKtCrqECvotoV6w5zEktOMqDF26Ki4vXtvMe2biXxXpaTE5hzmY9bh1Dn+mPCtUWJ0B2NiO0mgrc3qtFxOTlH55baRavoXDRJOXVknzVl2lCzoSOd7zGYQ7Wq9hhtzoS4bjZjz1ilUPU+HpVoNXaMNljs0VF2a8iRjw1mg06Hi/be7g48c+q33o1+D2evq8/bUjWiaYRi7ts3NjMzNCMuLqH9f/lwMQye5NR+YWGhYraEitkSakFgaCiiQsVsCd2N588693jikWCpg0pMcbHmzLh+GXpHjxKHN9KrEyOWkxMZO8SalcMz97oDQ2bNshxV1iFnZGZlWbPEJPHYTlpH3LFKMJRpR0fOxcM1QnXnruOGUyzFWJ7FsUiFjNa7jTZHfGxKlFHpyNKYopNs0ck2k9IximOA4+OcUYbe9gZn39S4EL5cx9ebEhzp8fMj7FFhCcYwMbxhRu3sw5cbQg0arSFUj0W5+aj/9l6pYQk97D9N0dye3CveFBKVFC1WHebeU3gGiawnu1Gdfan6wLDrA8OuDwy7PjDs+sCw68Wwx1qTxJgniTFPsoSZ+bgkJ/KSxI92MGtaOw/dpteHudq5aVt0SViXaUkLztJlZupF9I5GhEeL+O2NaoETZ6brxOmo7bIENU95lt+z4rKQqJT4+BSbsVcCj+41fs78cT13DJtS2fvGayfMLkzVXFZ93YLhHRlHB+auHt0MsTnTV06ZOHdA+JGDPUbVYG6O6tyvqdGlsCLeQ4zKLjay85PtERY+bmRgNFS2BDhMZXVURrYrvT3u/p4oGx/X32Pl41P7p/YPs8eJsnYxKe0Wi7igiF3MTPtupZ+YmdvsmJjiH5XjA2wjvj/Cis/EYRkP8O5sMAvl6R6T1TmYD/aYwvg4q/gX61ChBlsHW2OGi6U90q7rWRrTznu26SaLLS5yyJD91iFDMjPd7krLfosYejHkNPCRlCE3P3vb4Azx3xEbraHY+XY2qrX2FNXubFTr1YmKsSNOVndElHYHqpaPp1uGVr5i6F2UoQ+k9dGBBydeTtG2ZL2mJm/5TZUjF04ZFmvSGsOM4VnFi8ZkV+al9p80Z0HDpKxhcy4tc08ZPzxKr1U0epPBlJlfOXRQ8YCE/qVzF8wtzeLzpl1c0z/G2S0uzYGXkqFbD1fy4OKswROG9csaUbZoYslZk/tExDuiTNa4qMjEqJBEV1JS39y0QROG9886o3SR+H9LzO/8SrNO25cNZPPEU/bHse7tyghPaFjM4cyknCQlqVs7j8SA1ysHnP369lP69W7nA9sMc/Be31u5X73gBbL3cYzc/UkxhxuTrGqB0EZrfT/lQGM/g4j3N6IAhutxtwBtC9ou72LtCQOjDpz6zl5nTBhQVDm40X9W4aiWbY2ZU8YMSwjBwjaY0nMqPYVLSnpnTl5edMaUM3qY9Uad5uqklISUxKhRFzxzztnPXzzGkpiS4EqJTLAaHanJg2dfWTnrytqsZFey3poo/r8bNzGm+Qmf9MT7dgSdc6KUIeKVqtg8ISFxB8Nr7Qd1s+Vbko4rYeFxBxvDa3X2g43IOu6t6Dr5W1HzU1Hr0xsP21JTbdza+ui6fF8P74bGSzfVr6/orTguen79yKQUza0pSQXnPrJ20kWzh/70Rb+6q8SzEe0LR/t6s3J1X0rAo7F5bCHOKGcUC0n4MT1dH3/AXNv9gJ7aSNvKC2I6WvaJDcUTlZ7wYyPCzPEHGs21+u4HGvWBNgc2lLQT3+bRP3v3qe+7cK3BpD/yT9EHJdJgMmiRNnRU8dkGk1GjMUJv5ndghmrzMdoG6g9efJGR8RHGjucNloQoa7zF0HGbwRKv9gyfnb9Cz1ysWO2Zzip6FploMtlZol130GqN1R521sY2HP8Sl92KsOoONiLGqT3cqEYdt0XqT/fujlG+iojoWMmb9GGiE2H6jk1G7JVx2CvxeA5GRGjeSXV2bDda4qMiE9D2MiN11qh5NiUpJdB2PlabjvN2Ku2LTLFtD7XU6URjMU3QwG1qCo067g0Y2BSi+Vj1TYY7hticcfFOmzFWjqjmWz0pPevsZFbcabruPCUdn2cY0yvp1sCsUN7C/ePYALp/FO7PDOY6WzsPb9OqUwGzQG2HuU4rvP5GLT12tT36wAMPNEcdK+UtS0SHw5ZqtKWoLeILxXuhIBV9/h/2vgQ+jqvMs46+7/tUd1fr6JbUUrfUui1Zalmy1LqsWL7t+GipW3Y7pbNbVuwYA7lYwhImIU4wZBiY3w4wuwuJYzs2JAyzv1EIDGsgbGDZ2RDILhAIq0BmNiGZieX93ntV3SX5wGRmh9+yyhdVvXr1ru//fe973/eqys3+Z3FM735QafYSBOQZkF4rdRSN4HyNvTYMDuPVhLpUH9PU1pY2atCVmSptStc6tKwvlPYdMR3BAGHfALkXr8Qt4EyA/QSZggXFYl1bXPQl1noSCsXv9CQcdnlGaeWcbs6iZFY+IiurBI9bza6cYZQWzu0OWJQhFx+oCYIbUSWj4zp3sKpk0l1elMTiu/fqdKxCrWBPvvvhQu7zpRxyIa40Mt/wV3u0XKmgEexvQCLt1DDW5qAFvQxXIqu7RH8roadKmjPaaifSU/YwQgB4JgAI2qyV3ncJBQRJgUkJ06FQuMyGJHUNt1aHw9kQZYvCZH9T6skFQqaVX1SOhmmaoZXmEofLh7g9afbawB+N7KhiaPhPYSlxunxmxaZSLhBktEOfHC4dHBosvfJXUl5VRpdppXzrZ8cqd+zYWUm/CWuUDC1UyHpOXn1d1iuLU1bw2pOI769RNqYdFNUPRw3lpo1PGSfBjTGelWdXmdCzRjfknueNk3J0G9bS7Go7KgnSsBmVLAqy3u73P3vixMW7OjZ94NkTCxdOJp4KDt65e/fxoTJuCM4nhoOM/+7vPLSl90N/e/+py3+ypff+r39s98f5jsTMx7fue3SqfdPsaWT5QWJHQYN9VITagmUWUjzD2CgzDL4DRGYOvymX6yresqd1R6QOm2h/5OE3eShgr3iLx0V+l4vmcPpZZWMoHAqJa8LRxomPZR4RDUHIRevLerkN+xKl5zZ12mOOhz/dPlDvZn627e59sZWHpCJRKHUNWzKDyXGzXL4yFWgZogR+Hgd+GqgElSZWQcPYz9ebIuZG9KJyqB0bWGNJxPzz9nZn21tI28h8xLy1gWziL74CivcDvMhZIu3mn/NQkmt7ixfKIs3ETLZJZmM4HGWvdUix6VX6WafT4WAlC+HjKntFiTdo17A7jeV13Y2HRf7B9HoO3bevztc0XO+trQia9miU/8teN5Q4/WDnlrjbqoRpyKoN2r+v7o15VkYLeHwr6Av1He5u3Lk5btIG6xKVv/S4mZfLOiLulS+5Y+jflRi4+jrzLmjpEHUvwWUTY7kQagw1GnzovWzKAJNUn1C3db7j65FHJsFwmZ/mrHVWxgoWTY9VFzs6AM2VF7EOYIcR63Ebrqvn2yKd7/C4uhXVP8db5aiyqNhLxE1ckui34lY9RObd9skHtzUcHG4yKeUMA+uQtrYv1VE73BKI9O3dv7e/uvH2k8nqsZ56A76vVqqrNo41hBM1rpr+vQf29tfQ4cH8aI3FW2LSmuwmm8+m9pX5HFXtoaqNsYrqhs2p7kR2sMrkcBvBSzRZwVfy+Dz2igZfpDMaroz3HkAWrgT0qxP0i6M24NlCyUCdzjmMMhOsLue8aQ2eJXE6tvTGc4DMUzIvunGex3fQ5IgXVuaCqgTFaY4djE6jYeUVtSXo9gRsqpVXRLeC+QWSNfvfK4Lv3l2Q+imVGTwLr1mJliMY3Z9dfZ19HexvhEoQL45jrGCHHIztgiaUMWW8RSPUJRqhC+gG2t0o2p8uqf0pLo+C5ZHY2Nc3Tn96/ODjMxtAfV0eiFTLNh9sazvQG1RZOZcvYFXSn8w/lm1tyJx+PzMrLp5XHk9lektLeyd2MzOFRZ6m9kKUxbHfBP/7GxjZEhz5mHDk8xMUZcH5F+dRyB4WgtKwEJTC+XUUdoWFsAvOr6EK4CRqE/qYgTa4Xw0kNPpkoPwSzZy3DrK/qkevJqn1SeTEK86qR5BuR5bxgY7tJyHQkhCMJnQB96s8acCKWrjIWwfr2V/xqJELqBE1auUpHprBSo59e8GnVEhsOOi0gqi0YpVrzzFypbtjaHcs9WimqXvuzJ7I1t4ml1rBWPTGcMeODYvvDyb2d7Tt7IroUDT/52a3We+u8FkSd51buO9rJ9pNnlKXweqyhAPByuDFL+26Z3ekPFKmsvoIqvKvyWeoU9RL2EOhFrOjLPrUM9kyiva23kloGzY2jAIt2kJ7EWCOxa6x0TGmLp1IM2PpsfTBXa8OnkweBA4T6vmRBteyYWOy5BItu1A70rOs6sMLWlfDchwfcQS4fz8OhLB5QHsmcdPXYcEArxWB6TGOBcYYKm1KMzoWt39y16s89DCPu9Dz0MdG1zIPvdSibhJqvnZE1bPMQ1d4bexqiMTxEfd18MD+/UhbQyHRkNjt+IhcBrPNIYJsF+MsM4pNUNGGpuKKKru+ZOyr5OdgWhy26L67t21731jk5yqdWmY2/bylz1leYlfJVQpWaSgJx739Ewn/otEiU+uVi+7aTVWVm6Juf51azlh0+orWrW1rhCkVfYJ/cNQeYc97eyObZsai0Z0f3HFAafZYwQ33zx1Ua9Ryg8viL9XrtcqKodw4/Y9cOVgp5WDHrhZvSbyvunVr3GBxm8MBf3lAqgY2qcLc+9U7WxVopTwE8+1x+RQVotqoZ/GeW6CrndZ629DGRBvaLWtDuxNtaDenDe1OtD1DvwPGJEZmY0yYhDFhEsaEvY+YMAljlxhNQmMN9mnbwl6ZoRq9pOsabASJnjOMyIeRlYQVF3vAq3Zd4214S00jVnShmud516AB1T3P48rIkMISvMYfblJIpeUsmqlQSOo5tbCPgy9oQ/vO/Wf2TfzbXZXx8YcOjt6TUNoC4PJb1J/reV9v1+4Wt71xZ3dwY6Iv7FaREEm1OLJz5J6z4/ln7u3f3MNoxW3MK5u37eoYP5novTuz0VLdUw/o7gd0z7B/C5a4kXoNo1sda+5qnmlmrRzaveXQVq41WIP2fmoQujUI9hoT2hoCa/LOhd7Iv4swEQD1ApSMNMoEIygTbB2+1uIz2YuSIbyDwZrnPyD7Exnz1zL6uzJaJiuJvRQadL12yDBrYAzq10pGhEUc+Tr75+bFLe/4jyLE6CGvBm98J0plNc/zx3AbodhLfGjQ4HqNpwwmA2NkDSXq1/gSYu1gApIgen8h5rzhDILrcDOWhZI9E3ZfecrfN7s1kR6I6WAJYBlWqW3eOZeY+fz8ho65z0wcPX2o9nPs8cWNt3eWMgwTDg7duTNq99iVBrdFbzXqtG6XtfPEpRP5L39wc2/uU7utdz8SHc60IN2+D+LFrfIYRKZB6vMI/YtdZaNlM2WsA2knwOgQ9i/xtRWff4K02SFos0PQYsczzBxVQtnJPp9dqGUX7sL5Nxh8+yX67ac1gQTURB8HnHebBrCK/2A5IiAsaDd5qOBGhS7wpBTo8tcj1w2PrcgogbFqBm2mO1UWsukLsRzSUpW1pn1DBP25VVoUi4CfcK+SRCVKum5DdVUb/MEKcAaw6GSflUTp9NsQpZMBilG6MJDrR+nXdC3pUaVVgz+qVVFiT/I56Gkrwdw56pxxspSwS0oJ6FECepSIHnUJj6hPHJGI0zmc9R6GJW8thGd4VPLvwky8jfbjeei1mLTCc6OQCW2Xhl3oODtG9137TIXs60qevbxGnr3Qbyf8fgck/f44ebKAnzHgxwt4DoP7+87F29Ce722dYaFZiX/ymzX+CwYo/Az9NhWnTOBLDA2W49Wwe7Czr7Z1oHbYPYzRISGx5FlVm/B0wgwTV8gB6PAbxd6zQ+B7Ks7zQ4PduDUDv7o5l9geiTglEOOVUGm+SYa41jY34/CbPFi0y78LMgFZWFW2mt5oW24z8gOdQavSUdMTbcv3ihJDIbfDZ1IOf2ygdU9vnal261B/+a5jA4GCCJkycCPLd++48pEb5xS1b3HHqCfWXVnfW23dOPnhYSJ19jMg9Th1CUvdSKSODl2NdPV1JHuDp2ogaa9fi1ZCLRKxFi2HWiRxLRK2Fu5fpBJIq/0I7ISmdrDaXT4gisvShkQlisa0SkLes7W4ipaX1CG7Hr9THqvht7OfIbhbVK7oQF3nyWuBfmxk713DwSK8xpGbgQkgHkJ2FPnkLwOKaGfjmxjHkq4qutJCV5npkJ4O6eiQig4p6WqWrmJov+AS+AVQ/cKa5RfWLL8Aqh8tVf6YhtbY0PMiG4LUhlZFG3qia0O42r7CaNCTkItGamQWxOlG3/EYB8vA+z4rHxE2UfYLsIoOO8Aq/ke2VujzvHEQba0wENqM3PLWCvvyhtwX52f+Yrq5Lfcfc3Bu+ZK38+joQLY36O06Opo82svRP5v+8v1Dm06dn4fzIJxPDtw93tZ48O6RwbtTbY0H7kbonVl5hP0+oFdNbaTOIvQugHkLNmsEXdMIuqYR7aBGwEeDlM5pjyBIIgiSCH5iFEHARBB2asquaW4KyuQQdsufDg16B0yjbZAUoOnCjtXqx2rErbpIqoVQPXCsSU05qloAqAv7VRKUwtdROzLdRdyUZgf2s9nvN0w8fKCytztRLtE/m91rUVYNj2ytHX9gV+WX7A07E1wnOFW9J3o697R46F8ee/aeflNpY9lKp2i1Zb9Uk6hXfby6s8o+fO8TC5s/mO6wVvXUr3xy2+6O9Ekyw5nPA7oN1P04spltokNGAVKjgKRRhNYoYG5E0FqoBCz5FDLOFMKY8gDiFQl1ZDBktHMDdjRzsZmFKF58OobhOxvBBTV8saRLsKASwAgkNwBNwXyeUahVKqev3O6ua9pQtnamVnRvaPPpg+U+nYyl2XGH36xWq1W26HDLlSevnav3NPeGjaxKo1Eb0H508OqvmSnZF6kN1IcxJlWUuaxWmI21AgS1Aka1wmytFbCqRdDonPra5bKkT7/sTNaDv31WSSbbZQRGg+ChX17CYTE0vcxDWWfCqV/mnUklqvAUrxQmmsd0uWvVEy5p5HWzUI2ZUpm4qqizL53wnTJa5Cq96n3iEv8qCrssxldb+iHssqnkarlsn6/UZFArICLawhhIRPQDJZSSqXWQIOGTZr8QPl29ijBify2PMSH6CxDNKJkK5tPoZSCc/xJg100dwc//Yt0m5JdE/P6IEcXJOrYp0p00RZbbm5I2FMZUjKhJGHMZgl86Fv/RKxb8XCaGwNFD0abIMt+eaEpW2HDkgsvjyMVzGUJYpDFxh2QrO/i7wlURNPYLfocK7+hbVSsxCRQ3xo296PW8+1hBf+xFRCy+oPmG8Am4yF6Q/ZDKUJ8TcDGgfxUgsmU3QiWg36QvAaKaItupLcnuZHs7l6xLMsndhshyU9KCVKJi5HaJKnUtx+NL+9tiyNVbijVIdgkE6NykGSppSjJaNtm024CABBgtAozK21cpWlckHjehOAS1uUrh1iCquCGiweIm1/U0UvaCyuyvijn6013+lW4J4BCyGP2V14ec/hpyfmBqq/BegcXwanO/o6LErlSokNIGTQaNgLpEGGabWa/X30gcNC2+qLBy9fqardiGNfs80Ww5I2q2ohskeJQ6hyUY6BzFCn00ftRwdP/+owbWuwX9ew+b6pEn/lSFdxvad3GmR5LDncn6ZCTCtda1Mq2jlHe5IilDorQTUYqC7CLWAc0AJ0iTiBPJ8mwaN+Xni21RraZWEGtrxShV4V3mK5J2GZamXZCmRJZdxKze6rQISh/k/e6JRWekM8ccuMHMKYqR6fE5Ie12cjblSkwizKJysFHpxLqJXZJK8sYzU9IAkuMjaMcGIjnRpw2AJ6sNI680jBzSsArFFjj6CJtwmEG/8zRZ5QKC7Q8Ith/Ob+N1ESWQ8Q+ICyUuiTNAQ9TW2oGwVu4egPBBXty2IY/thID2RUnY4U2ohQqGcrxrU9ysKTzJW7NXs2Z3ubmluGvzuNLiszt9ZsXIo9h5VdqIHJyxZF3nXZuVtgAsnBZ1wadd3LGl4/CHx5lScXG88r9HD/ZU7N7BLEij1F7mOcYld1N11JjwnkfFJfqBhFFjf8xX+gnjHHumpvJxZR5tlKAN4cJLHQmHz/4Y7zOWfoI3ztWwZ/gaZeXjPBSUvs5BY/UKXfsQA5Kgg8RdZ1yMTFm6t/3+ByJDRzptkcqQU6tgWYVGqdRUdgX7h4cGI90hrVIJ9qVRb9FrXMFHPzqaGypXaM1mjcFi0NosGlnQeSh1aJ+vTG12ga+ZBK5OKMxUOdVE7cV8qd1Nz9DoB1Fq6Q8nTObAlFvNVj7pmIt/Spdnc8L+G5Hki6/E8d6sFRdyVD7JO+Z08U/xuKCw10bkRwvvl97SVltzC3PCHTQ7jIpYqmPTvjYP132wq36sUmn02Gwek+LfVPZXljcGjDp/PFQ+EGV+qtPLFGpFd6w+Nprt6MuNRkIhOipXyVhWppKvbItGucaesvK+pmCkCfnX/cDztNxLVVBR6iR+ZhCVoX/ezGs2e0OX6F0JJ+W1PmIwqKMPcWgjy1X1MDenPu3Ki++IzBVexbUU3qgIGKyP8FBHFn2Ip2S0l4V6XNXDPDfnUp/mXfnCSyNo40v6pkVh18thX6UExT0vZtpjXXnIUrWpPtQVD2o0KkNppL6FO306PHhHbx+Yjw/JNveWNZZbGRnlcYc3Vju0Rp3VU+I26NTyh0/3zW2pruw70GzuG3JWNvoRAinmWzQj/ye8z5UgT54d9N9RJaDnuygNFaA9592mWTmS9svFp85o+8nzNO9O4FsgX8+3ERfWa1zWFskG1Jtyo8eOpKYweWx2j1GuL62LBkujdUHmpyA0GZIc41KoFAwDh4vVfn9VdcAP841nvkX9g8Iq3X/adV5jmsKjEvefpshArjuKf5CbiL4oyFle7JAtkaOHfXCgSE/sa6APfdQ01obmMvTvikQ7zGgelFB9oBE2jeFs9xx3tm2uo7kqPluVc+bwOKT7KrFX2uB/pAvObsNZvnuujTvLr66wZudE8qwstCZQX3uNoCRhu0PcNGFfA8asiMHGJq6nUmH0WO1eozLeVLqpSmTdXVbmjB+oH9jh8jbEYq4NW+ptRRTo1mR/rHbl9I2uGZcO/tvUEG2JlYTc2vKNY60ELeYuQKtGeO5fDjDtApi09O6EgSoxPBmeK3dysyJAZCcDPfjH0BjChid5SQnJvsVN0ChyD3wzdyGBWoHV5tay/koRBHdZ0B0/1NA+Vu+QsjiAWHrkGpYwMzATNoMt+CxwYwVrILzBZkM/xUT5wfqpNe5HjXNln5Dn17zBZnQ/CsZcXvYJXp6/xe2BZuazVaPzydHZgdLw8MKWwemBio8aKzZGqzdW2tB5yw72tz2zY7Xh4an+npmtNVVDUwOV/U3+ksb+muq+Rt8BNFqefpv5UxhtiGqhxolPVqdB8NupMKxFNspe82TpnKYuFpDJvbOmhYazZOj4FSDx/QssB0dpzZO8tKi84azIDC4duUkoX5CFUthhspNAnvnTYNeBjZ6a6kqnqIByg8NU6mlIdST2tnoe1Afi5RXJ2sq+yvKGgIn9bf/caERt9dlWrsjR+wkKtZxZRtMTRFRfFxu9o7eit4mLNH61Nhpo7CG6R78A/NdSfYj7c6UeyogMts6jWQrPlRrt/ll7rhiFv7Fkwczqw5olvnj/FmJvonB4osnoF2DZlau0RrvZWMKVOaRzy1UdKrMagg4lrBPfM7sMSrlCrnVV+la+sFrj+gOVTpVMpTA4gYsy5jn6CflnwR/bibmgygJhxIXJatQGZsKPubWPWWciZ5RE6y7jl9GW3nju+9ibsAdmrOHHeLc1YdU+xltnlJEzgjOBQ+dIl8SbMAtWeFXg7ChGKViG9BMKjcMfNB7avkWr1epGFMIq+xG40n6Eq/aEFDKFnGFNDpdWpZDdfoAOuXwlrvfJwYOVweF9rhKfa+X1+rhRprVgGT3HnJLbYG0lbyaqy4g74UP2wVymZqtmnbPckwVnAskCzyzyBptQQMc9KXEjUJnreBESJ9CxygdkTrnLLE69vC7T0L613qEweW02t0nR0hZMVonGo+A2xLExoIcVRAUVK9/oH4jV0rx4jX5fjr2InwtpKR1VKb6zOHdeoWZ1Sarr5ctkOTqvZhNw7eryvHxZHK34GIbeKj52WXlCdll4yrJyFrUt4+gh+X2r217EbafXtJ2+QdtDNW2t1ZG21sjKBXlFS6SqpRXaXqIYWnP1Lfol+QEwD1VUBd5JlFd4R0x9APyPvo1eOJZXJPA1Wsx/9G2pEWNDhadJa776+aoSfXVTYlGaaZW9rMRbZlcZ1O7KQKDKpVa7qgKBSreaXhD35Niv6Cw6uUJn1v1TWzDi1Wq9kWCw1q3VumuRRVu+ukw/ITuIR9hK7K+DSVMcZWfantaaqmG8WQoGa1oSre/TKDPhRW+ceFC+1E6xjTca9Gml0Wt3eE0K2qywlpd4S61KtdpR7isJOdVqZ6jEV+5Q003oyToLB+aqzqSRy8GNepfzhV1arSvs81W6NRp3JWj4Y1d/S09TPwGJVZF3eRToHXv0VYOahUgHJBb5T8g7USdYFMV4LguvIhYENh3r7Iiiv6n+WHQz/CEkPsJOMp+UL0hl5Q31m/pBVpfjWFbeBL5GsrocXyUrccVZk+OwM/coTE6LxWVUODW2oNMVtKnplQ+tyqsLsfeLwqK/I6ZW6lfnmUwUZaImqb2yfbItlJIyUk4qQIWpGKxEXVQ/NUrtog5Sh6kZapF6P43f4kxM33aE38633nmy42TlbL4mzx1Kl6dVyWHdMJXolfWa6hptjfzJfHq4t7GxdzidP8krS3bf7ioZnD+25dimE6f6TsWPTjdPe/Ye8B+wjO107GQ2dCo6NdVRQ/TYqekDOzuj0c6dB6ZPHVOGJsdLQ1TscuyyGW8kxMhmwuX4zQ80qmH5fWogE9X63saXCFGumOf3HSIWc1lpU2NDPCycrcLZKZzF+8o112vPa+8rHauvK9a0L/bHvljX2Fj3CDr8tqG+ob4cpVZa4vDfFxvq6xuYMXS84kEZzD2Fsle+VNcYj5fT9Y2N9fTz6ObK7ej4W1T6EZRiH4VDHVyt/NeGhvofwwX9GCR2otbuggP91Xis6UoSUqfr6hoZTii0ooTEL1C1/9ZY1xiFxNWr1IPMC8wb8p9CDHER7109yFxmuuU/pbzi+/H6S/SehM6mpmzyJb3eLFtyXWLuO2vOSV5OXTJdwUusTi9f4qGMS7bEi6XWvh8vWUgVxa8WHEy3xrzyxlWTXm+66g+H/B4PnTZr5F/wBX7iCPpKV35osFoNzN8EbD485u+wP5b/Asb81xSFr78FKyfi4TnMQx+spBvkv6Y2k7jky1QHvftCeX15vd4D4WpCT+mNDcYGZ9vZDo+86hJz/zmn4O4VPtcBppbxRukydoNw8aq2s7xQ4YLcWXD6Ct/hFAxLKBxlkfzRq7ewuqLXnnAOsTVOB/CPCqHIHb/9BMWYDdUDmfaO/SUGi5p1aj06bSBc52tPOkMN3vJke3nFpr3N3qZouVajcuicWltnbXOTMxwvKR/cUMGea9uzMeA1qQwmh7nHrFSajJr2Rk/Y79GZQ01DzY23NZeojFaNxmHrNci1vqaQJxRww73mQbCegvzxlyibhC9R6AfQlyj0nnNq95Ie5HjOs6SYFzz55RcRJOf1bpA03Lqg8CzxcPO6X6MUPF3yEi7zRuPkxzNfMHi9hvOTHztU/6B3w+7effu6d7X7ZYcnz2TiVhfzVZe1Kf3R21smkpVXXindfARrJJY21U4dwhpZ60b/iGVZnQadqLImNIqoU8v6K1HKnzMXIkzyuv9y3LSM7M+XqabrlZS+6V+MpFjhk0G2zCp1bsmr7w1W8ZNB9sdKk9tu9RqUv6TVRofR5DCo6ZdoWmly2ZGv5Lf2OTlwoL7J/helxe62DGqsOjXzP+VKGfwHkXTiyrMs8hFlChmk/6aQ/wOPHZowX/l7Rm/xGBVynVmPZYX1HH8vuF34XvAZeg9lBh/xgYSGMpcvoe/9luxo7umkM3RZnKGK8iXykd8SL5a6+RvkDas/8mNOVfSPb96uMqC9CaPSY/733rru/pj7QV+k1rFlONRQapFd6ZzYHF75dYGZH7ptMkOodbCposGlXHnXXtG46jeJdYgTLz7s2VMH8/fqV5QfY+qUb1IspUKOXqyhrp4N2oN9zLErDyjfnMS1vvb7Ed1xE7r03ok5cSvEKlbRO/8aJFuU0POE5I3XoYevoefX0PekpLBK6FNKh4TyN6CXEKmyhNQ6Ce0T6Mv/0qRJrybtnHZOxwn04z8k6TPX0CevoZ8VyfAT4z1SMpXegF5AZN53E1ou0DtryXKfdS/Q5FqyDdqW/3lk323/nmObQH+B6e+cc84fumKuJ1xPuC1AH3T/6g9HHrenf53W6V+APrGK/l5KXt8flGbWaZ3+uKnk2VukpZIln2MV+TGFMD27Tuu0Tuu0Tuu0ToT8+mvo4QK9vU7rtE7rtE7rtE7r9MdAAcU6rdM6rdM6rdM6rdM6rdM6rdM6rdM6rdM6rdM6rdM6rdM6rdMfATnXaZ3+/yX8XVktUwpHFiUZE85h8TelBnyF0gxlkD0ppFmqXPZXQlomKSOnXLL/IaQVknwldUz2j0JaRVXLTwlpNcUp7xbSGuYzhfJaaqfyz4W0jqpWvi2k9QaFShyngRqEMsIXdbTKUSmkaUrprBPSDKV0fUBIs5TL9SEhLZOUkVM6158JaYUkX0m1u/6DkFZRdkdMSKspk+vnQlpD31Yor6UirreEtI6yu4NCWq9k3c1C2kBVQBmWomVqGJxFPiukCc4kTXAmaYIzScskZQjOJK2Q5BOcSZrgTNIEZ5ImOJM0wZmkCc4krTe4uDYhTXD+S4qj4lQdVU+1QmoE/9rzPDVD5eBvkspDXg/+lWzyW9kpyMlCapqKwp1uigfiqDHIO0wdgXs5fJWBcwZKH4NjGkrqqSSkxiEnQy1CiVFoLQNtbKeO4xRHDUPLx6HdBdwjD6nDeCQc/M3g35meL/TBFcZcRzVAKlS4aqFqcP8paGEWynLQbwr6QW1MUHcIZQfh6gjkorsLML5cgZ/t+Neuc3gENxrPJMaBozbB9TjcQbkpjMJqHkk7MwKnHO5lAe5OYH5FdBeh7jzOWYBSaYwaB/lHcN4INQBjQuhkcb1pjGs7rp/BJTLUFPSJUE7jIyeMSCzL4fwclmkWxiJKr8gHup+HUWShZg5Q6MHcZDEn2QIfKfibghpkhISfFO6DE2SdhRZRqykoh9o6DleLkMpjOaDfUR+HNI/HNI+xQPyi32k/LCBFWs1jnkif05ijCTzSadxLDstpAEtlEnJS+HfC5zGPHD4TWWQxTwSLHNaKHLSaEvQVSWxWyBd7mYJ2eIzPrDDKaciZwr2SNnMYqeIIUI+zmBfxd+QJtmTsPNYapAlHBM1Fo0K/mY5+iz6Pr6axrEW9JpiRXogcpwW+ZjC247hkccRSjhBqd+J6hOs74DqK565UmmHc2hRu4TjGYUGYpVK8Re2bFjQZ8U/kMo+1QdTRDJY10tzZAjdkjIeFMjm4OiG0ngcuiISOFaSUwjqCZsDUKr5EyzMBI0nh/ieE/qPYuhzGskJ3rrVXG67heqegOaLmN0MrcbAcN9b0PO4zjTUR9XJHQQbFmXmtnTws6PVsoTTSXCLxaSifwbrzr2NvNesW9/8ZizsMI5mgKvEsqxLuc1Q/1ooZPLI8ELJXG6gYUBpji2pOXaM9UUHnYpA+jnXoMNYiJJvjkJuCsROMxVZJmzweAxrBJB4tsXOkrevpaA7r+SzmnaAg1kNS3YP7IJbmOEaaIJMvSFssLdqFCcF2o1legzFA5WYFrZDa6VmM67RgH0grGeE6JdjkDLYoWcwhGd04Hoco5bUSyws1iP7MX5MzWeCh5pYsAVkV0hjTvLD6kPlJ+q0p9LOWA2JFFzFOE3g+XQ+zRYHTLJ5pPJ5TZOZfiz2qQ1aWSihftUqDr986GcN7xVY6P8jqzgnrcx5LbmLVOrmWg+KquHZc7RIdQJwQXoi3INrK+YLnkcZr7zS2I6kbckp0L7VKq4g9mBGOhCuSXsDzhdinNF7HsoJtIe2gkjy2/jfWUWLFpwXJFFsXZ0hW4lUcwfYuK+CMrLoe28uMwIPoYYgor9bqGiyZFE6nKdG/Wmvn1s6EyjV2IYPt9CL2KLJY+kiqKchDCB2GEuK9mNDmwTW2s0qYvUVrUfQGxNH8PqvTLa4GXMmaNobFNjhfQZuPQh6Rk6g1xDvhhVWkqN03W+FErbzxKockd1th5uQkvgiRN9GCjNAXsdjTgtxrMM/zwuoj+hXELzosyFnUY6JXs4K/Q3qYwX53CvMpakqKKq7ya+3Z/wVZFBBKYd4RblnB1qeFuToh+NrTeKzSNTOLvfEc1k1hjDeWLaS3rV7nQdpVEozSkghBOh9uuT2qGNWIpa9v3WrWWDcR+7W1eRwVZNfwLY6r6IMVZ01xJRJlWEOJ0RmKwsTrjERDZnH8xWN9OyJZYcmox/FYMsJKtVCQpdSWEBnGBInn8CzhC2MQ5/VqXbp1VKUrPOFSutKs1ukiEosYx6n3KEdxNVjA0SVBJiMZQRofUZ9FXI5CiQnJ2pG/iT0mlj+NORBXvA2rrDjxxo7h9PW87mm8RoirjDQ+E9eJ69mU1bVy2FYQWY0LfF9/zU3dQKLzBe5zWEuncetkFl0b+b5XDRDXtyS1Gd8dpfrgaheslmM4ZwDyOLCiY3BnJ1z1Qm4v5IShxDbhfhhLahdeh5JQbgde40gbY3DcAtd7sI3rozh8ja6GoPwWaAvV3Uztxn1shta24ZJjuO0RyB2G82ahHKrRAzk74Bql+7EVJP1tgVokhhgQ1kQy0u2QzxU4XD2qAdyjOLIRuBqD9pPC3W5oewC3h8aP+u/D6S2FcfYJI+3GGKGWUZs9MKJhfIVyd8D5Nii3DfffjXkmo92CeeiD+4SXzXgEqOeowCsph/DZKdxBMkLjGwYqctWNMUji0RTx64HzbTBy1H4/3N2OV4hRqNmLOd2G0dssYIa4HcZXRa6IpHowNwhVhEEvpEfgr7+A3Rg+krGMSVpbjd0ufL9YivDXLRx7MHKj+IpIowdfbceyQndrBFmOYT7W9roLa+JmXKobc7ytoCF9WHvJ6EXtJH2MSkZC+kOylY5F1GruJnOEtCLe3yFI+lpcEOrdGBM0rm2Fnm/UMszNv+TidfWt3Eh2Yn4mNzOZ53pm5mdn5lP57Mx0lOvmeW4se/hIPseNZXKZ+WOZdFSfzIzPZxa50dnM9PbjsxluOHV8ZiHP8TOHsxPcxMzs8XlUg0Mt1zVwIXRqqeHGUvzsES6Zmp6YmbgDcgdnjkxzyYV0DvWz/Ug2x/HSdiZn5rlN2XE+O5HiOaFHKDMDnXK5mYX5iQyHhruYms9wC9PpzDyXP5LhRga2c8PZicx0LtPO5TIZLjM1nkmnM2mOJ7lcOpObmM/OIvZwH+lMPpXlc9GeFJ8dn8+iPlLc1Aw0CP2kpnPQynx2kptMTWX549xiNn+Eyy2M5/kMNz8D/WanD8OgoGg+MwU1p9MAwPx0Zj4X5Qby3GQmlV+Yz+S4+Qxwkc1DHxO5Gi43lQJcJ1KzkEZVphb4fHYWmpxemMrMQ8lcJo8byHGz8zMgDTRaaJ3nZxa5IwAul52aTU3kuew0l0dYw8igCvA4DX3NTHLj2cO4YdJRPnNnHipn78hEOYHNcI6bSk0f5yYWQKRk3Ai+aQB5PgW8zGdzCNFMaopbmEXdQIuHISeXPQHF8zPA0DHEUooDAUyRvpDyTBxJzcPAMvPRsczhhf/TzpfHQ7X//8+ZfbEVSiIjCtnOWKJNJgZTtsaeirFPmNEYa9uYJEqlUrSivduCtKcQlcotablaaVEJkTZF+b7PGTS63Xu7f9zH5/d7PHofzLzf5/V+PV+v1/u1nDPvM6K4wgG/mtgPPRHxB0tvYCJkCcabmJkPMr1IyA0JjeYKIxE90CUd8MxwYPEYZDhYANTn80JjTZzjgvW5sQZgFemOQoFAFCESxcRONDUNEQTHmkT3zzQBE0xFSTGCcCE3JiLJlBsE/AwhBZRRccHc2DABHxgcUH0Di42LiYniAcdBzpnQ/QRxwGJJ9DjgQiLEWZFhxBDBYGlFoUb0EF5sDHBg6YLGCHngbDAgCQWvXLCMocJonkgE2AUloVr1uyMwFfAbgbD/TRiCYPRn3YEfhMQFi4wQd4wHc42QOf0AYH0SInjBETKSJQBQHj84Kg74/jfpBXzgKfo8A2lYyJADDn8nrTSKgK+DdY8VCXnBUofsB0D9sJ/XJNQC+jyAAmICSSVCJHJCBAn8KAE3ZLD1uFJTAc8C6oDlQ97EiWJAFggJRdREaCJCo2IGWxTkJeC7UnJkQXhonETwgngiJD/JewKRwwRItCAi95naiB7EjQWyCvgDmaJ/EfT7fCGUb5LAi+TFhIbwuCYCYbgp0jMFlAF9OcUALC/qFmgMIGx+nAR/lLzq+iicEYqbiJnnCYBOiGlALEWBxIaae3CaREw5KFHKy7sjixOLBg/QG5ggFMwCjg0sE2JEDxOCpIeECAjEcKAzYmNgK7CiYDpdEASSHR8xChdN1P1+9vNaIAJxY2MFwTwu4h8gzkDK4ou40nzKiwKW0Uc4DtKW7tGXqW8aoBKFoNlQug4/pEPzLDIs425Gfe6GSN9/OooH/FSKjfASSisVQECDCNHQCMnlvDDkNRQ1SEwcUCg2Ag1YwDooDgneWGSwz0uAhqZA8dhQJEULYnjSjPqXokoDHkBKg6bP0qgQCRGC6L/REQmDOCEfCBOKMggRgByKyjIvNFjU72Df/Bg4fwgPDbyJUhcHaSw+VKbg8gUiJGSkyZzXF8ZST+k7FRuB1IOg0EGRy5VRVIjAx4qAM/HAEg1Unr8zABJvTiy6h5uDpw+Tw6KzPejuHDdvtj3Lnq7H9AB9PSO6D9vTyc3Lkw4oOExXTz+6mwOd6epHn8F2tTeis3zdOSwPD7obh852cXdms8AY29XO2cue7epInwbmubqBus4GkQiYerrREcA+VmyWB8LMhcWxcwJd5jS2M9vTz4juwPZ0RXg6AKZMujuT48m283JmcujuXhx3Nw8WgLcHbF3Zrg4cgMJyYbl6gpLrCsboLG/QoXs4MZ2dUSimF5Ceg8pn5+bux2E7OnnSndyc7VlgcBoLSMac5sySQgGl7JyZbBcjuj3ThenIQme5AS4clKxPOh8nFjoE8Jjgx86T7eaKqGHn5urJAV0joCXHc2CqD9uDZURnctgeiEEcOG6APWJOMMMNZQLmubKkXBBT0wetCCBB+l4erG+y2LOYzoCXBzJZlthE/te2wK9tgX9h21/bAv/dtgAV/f21NfD/59aAdPV+bQ/82h74tT3wa3vg+2z+a4tg8BZBv3V+bRP82ib4tU3w/9w2AYhN6XcNMJheNUwa5kcN2/dEPgbSB68R6JP9f9fUcDlychCggbJ+ll5eHqXv+ll6RUWEHhv4s/RKSih99c/SDxmC0OPgn6VXVgb04BWDfEMBj9Ljwa8KRg38HQvMbI9RB2bXw8zFWEBKGCakjnGGRmH8oDmYEEiAmQ/FYRZD8ZgMaBEmG8rA5EGZmIPQZswJ6BimEjcdcw3ni7kPuD8G3Jq/w2n7AY4pwJkMcNgAxxPgBAGcaICTDHDSAc56gLMd4OwHOMcBTgXAuQZw7gKcF4A7wvP9YBzoiQyOAsDRADjmAIcJcNwAjj/AmQdw4gFOKsBZD3D2AJwjAOccwPkd4NwFOC8AzlucL4TF5UAUwHfoYBzsOxkcRYAzCuBYARwHgOMFcLgAZz7AWQRwVgKcLQDnMMA5DXAuApzbAOcxwGkHON0AhwZwhgKckYNx8IoyOEpoyvQBN6dzMTMAjj/AiQA4SQAnDeBsADh7AM4ZgFMNcG4DnCaA0wkdgyDcdEgB4GgBnLEAx3QwDsFGBkcT4JgAnBkAZzbAiQY4CwDOKoCzBeAcAjhlAOcOwHkGcDqhTAgHbYaGABxtgGMKcJgAxwngcJC4JBMhMrkjPRW09A4yHiITO8Ri8CMWk8kQmVpZuRu0TZvIBORMeno6cgolC8wS29KVsgKJeIhIiEEmxCBEJDI5EZClJxIJEJEUk94lFieSIYiMF2PEaJN2+hqRDBGpxy9ngIbSF1Ujc/umgoawJJIQXASYiIOI+EZ0IgmPIeFtO2xBg1FyhCQ3QoY5RgyBhhPjcBCZkJ+f/zeKUiAyrUJcId4BjmxwpIMD1eUvFSZKFaYQIApQuF9j5ERgVgdiCVmNKRBEGdD436qMWLeoHBUTjyHjbf+ssyx7GaUpiNIUEkShdKVKkJbahYoLFkTchYpFhShy5aAV2BbYrkOPTHBQiBCF3AWsJCVCpsSkIyqR02NIBIhERHri9BgqEaKS8Xi8KBPQZopIRIhETkxN7RGLF0ol6tNeTIUg6jf1xSQKRJIrwdSgVpYe6NyTVcjSpPbzAS2ROjBedRJdc4jUZwsxBY+hEPqMYQujk9A5mSIqhKUSBswhxkIQFqDj8RCVmAUalQxRqT2SFLRJeqgEiPrNJGIqDaLKlweWBwLb5a+lr6WvAEcqOFBtEatIzYJOQwwRqNRvF1KfXWhEiIbY5Z8NQ4Mgmoxh/nPL0CAsrd8yg01DQ01DI0M0alea1DaStC5Ukx6EuEcqrzxEUyxXK1fL18/Xz3LKckL8bxl5GVlCppEgmtTPpPZBpyamisW2MLBFaiISfCRre+SUvbUcCZKjYEGb6ID4pcNENDSt7RET2VtL3aXfRmJwGSAnayQxmQaRFU6VX0SXpf8gkyAy5WQV6ucStGNtj7y1t6Z9O4OaCg3lPlOhy0i0te1CbWVrjU6U8nCYKAdh5YgDqIPMJUdCzCVHheTkvmIqQeIol2kV4krxVwyq41ek/1U6LKcAySk1ajRqdEyuNaqPqo+qdq6pqcq8lFkpVyknR4bkqD0XKysrL/ZIqZHpk8PKyxsTNRSIxJpEJJDJyABoYZPlyZA8FQfapPBKpIVPopBBoE8Ou3gRwAVNlsdC8vjycgxmQKq+EZlGkYMoig8aX8AXBx0II+qD55XShvYmh6HvwybLyZx7/gDhgWSH+sY+jjQCcKTAwK5AabNGJ/cxCp8kj8XKE7/BA9EQFyCUlxOIkDy5Bmky10nIdSI2JIof3vfeJFb63ht5zxRyg4zoTGE034hulySMMqI7hgoi0b9C8FcYCt4ju5JGdGeuiP/vqFEZIFQO8KuZh9ZetGnmwBLN9UTKuDSntI/yEAmbL9FMBUOIYzBoMIVIMFTAYdUJGJhLpBoSITwkscJC+HwPeCZsJDOisWOUWAMzGT3c0PtnAfqJFvJ5iw1ywNoyzPAqO3GLDtz2POrdrVW2cVLh3uCZ3rqL8iVqXrAEXwlLcAfycVgIi1U2ByJeTBSPh+LUeUJU4Iuw/IC0EAHIlYCKifPCE5WxXh4MZXgI0iErU324sRE8frhIwGcowQrIIEmZxAkNiRbwQxijYA1khKqs+sNHgRjasBZyHqes9u28Jy861NhDxI2OobvbMeFRw+UZ4+EJsBXDytLa0nwW6FrLdOGUkv9EMnmYhpynKeNd3Nw5DD14jLQ7im/Hi0EeEbD3YNFZHq4THSzNrI3NraysjK2ZVuMZY2AdqUYaP9TIQ/qgBSyBRstaGCJgcBJIEQPGqVgJuJo/RNMZue9Kur7K+KeVEXOIqfpxzOVD923db4ENLDjkcJwqf3D3TXkH1svC7RpvY+f2CnqO5xpv+DBSJ/3DzJIXW3y8v7hc3WF5qol7NVwFO9y+K0PVMd+YugZTeHV5+fSQy9bnHmcavqpMMz9uWK5e9ElvMxGOsW4oVa4SX58emDv/6eNKwYmsiY5PlGgHhOmzF+vaKdz5ba+2Rfq9gwlZTY8VF64fnqazasTNS/Mv7v5Q5G6UN6tmVhF0KVtSBXWrYkNb+eeGY4yXE9aumLvKKpOSdy6skR99uzF/+v1H2duTF90dFlYOjTN10/s8q6nrjWaLAv5DJGuUyqLykI33a0/1OlybVxarhcWBONopgSjAIgRYE5hUUwE/DK9yq+yDWVE6Q/H5iOw3NmWMz/5YRQrqQ5o6eDV4mFhFx6LrLschhtpm2x3fXWJYVGlZogh7IgRaeBd4BszOd8xnpdn1PZsRLIz67oGemEgeMmra92hMrOnAMiKriC4i8EoTQAL7EskgMAkEEgThneHpsFN/H8amTe4DSEhI+BFAqPBvOItgZUTeMXg5mNrPEkf+LiBxiJfk+mMetO90WvnMfUJ4tm65YM0524YJe4xcMoz2+dmYUefV9Mwejs+F3ep65XYsezTmPH4i+aPrM6jkEd8u1LVxigkrxiCuzo3nNiyx5NoCm/YRB12KD8eZcXQJOVn1Tvde2ndncYf5zf292NBrQx5ndkU5rEd6fcdZL6mk8uN0S/kRLjsZFx7cVB+9So9iYWt1bbuTxoq4FXbb6g08j+6zilLZXp0YdWLEb8sTd1qFnIPWtT60XRIwRMkzmzDr3pIS/RlDt1tIVprqB1opvQlXvyWJvd9g1t1gvvOpraV2qZW/WYTgar3hS4gbvDYn/fmrjiJs4aePs3saUiotFh+d+XCkViun9TMsIUIgjTXLpLGq5oyu5BT35l40jVXJWo0G0tji/yRZ6MNjpUGvJXs+JJTuwQtHH4wBC4s8EclAs5kVbM1gmMHgsJBms29dWPSfyNd3HvcX5/8xG6WvOKlbSVqzWZyk2jM2sEeYbvT53c6c9I0OJ3ZeDcgwnWhuMmpt4ueF+7Uk0LHkq+qluCsOLRc2fezGa3Yuo/aO5hd0hk+5oKfWpK/1Hp/NDG59elo1s015s+Uj6xhPwaTWQywKzK44twbeJHc1/vLH2A3DEm6sPJN9ibyM3jZqn+Wb+ecbRZgZK+oerG25k/h11edDgelTzp7SOhyUU3YhtTjr8J1Cw5ue3Zb3fp+/7vmo3tb5kVeXkONFjUoznW69wVQ7Oe8kWTb5yX9ZuLX6+ayny97f2ayotXrPs9ThFXeu5GlCl7447VVeZ56j7WTWdV53B+bIOY8rS/kG/int1nzx2zOtyrSW/mwkBhZZKE03Y5B0M1CZncGNWX+k4mTS1dU7QanXAye86g0/P7uu+syBE5XKuTAHOT0ED3LRLkeY9X2lsYDNkC5B2dDMHIYZZobB1rBFkGUo19hiQpCFsYWZubWxtfl4M+MQa0tGGNfMzNIiLHhQCnTihzS5E25KfhtuZTX6WPS+K3HYDX+dAn+YoQQxsWgWBO4C/Bh4MXBgxH8DkD/GsJUxbI2mQK5MCvSCwdWKTApk/SNAfxb8GwgRLIcIrgxBvXgsjPkunHESLIQhDtO673PevVrHbcfMxD/aur78fvZ2+ZtPI73bPKp5joTbVVdbn/Rs8t8QMMRav5zAUm7cnJReGnbg/pkWrJfOiSk6iczow11vMLOyN63QqKFsqN2sYQ/v3z3s0mlH//eGFivz1vhaVbpqFI6+ovR7vURpv2XH4dHVa3T3pKxs0NN4FqaZYWPS64NzqeAvzTdrOVpi6u49h1ismlmtGXwiVu7pneSxiuM2svaaLbXZaOPDTtDJ+FqsdGlFE1l15gXDWQz/CfM27tuVHrlRX/Cm6vCrs6zhNUGuKcc81R1X5+6OLufrXezS06puo++nFb+5Rtuc/WTeNt7SgvF/RNO/LrvdW3kyZzzl6xSVilyV/eVpNe2SigNeunZqx5yWJabVfqrbNnXEXZWMF6vyInTTIybtvyR2HfuCrO0c/GXrelUX82PegW5/TD9lvbrX5GFxwC67yMuJ14vPRK5ZGrVc+Nur3d15D9XvTOgJuRxtQ25auLT4UOnO0wuub/Telex7dahjUJ12e8/kKgbto6lNyG4rQaD71BP2WW75tJXnFvt+uBS+nHt/e25VdeZVgePjcpPstuIPRXB06zz2vuaN8dVnyVVfJ70/HGtFPOJ9fcStM++zryzX6BTPg9yOj0yJLbnpP3rqRF+1hvTX4VXsvaYPxqycMre21cJ+rWbpWrl4iU17Vb1xAR672ulT+0PsddwOUARIoAi0S4sAlTsswgLN/RrfX8IGoOmUSlk3NmN9p1EINGIYDngjYwQ8fNAgZcBZgRsaSvOm7re8yREIQPIErssL4wVzRaF0ZpwoQiDkiZKQ5A5bwRawOcPM0hyeAJK7GQPtmsNI9393Df1P+T2vIKq44b7TunELI01GPD775OmFTTN13A9de6jmqqv4+sbeG86HRDB9SAvptucGVXb2yGnrDufOhsfew0S+XHC2NYOk+FEBn9uRUaN11Vx3+bbOd+EaRj0LXqRrvnrhurOgQsfjyqrPrOuU2rmFtUXT8Ds+7YlaH/6H/gMHj6K02iZ9BxO9g2luXhy5Zzij7nlZWTB/+Vs/eNvnxXdySl5q5yzuqlN+Sz7hEc05ysrKc8JMdwwbomcQti/n2U1iyvQdn1L3DnFUoUjyUtu8Er9CmzXdycswSrBD24lHOg5nqow98wpHJTIZCTVbGiYtXV/AxR7TlC/u+bjlCHRt9AzP3k+EyvN0Wn9+PwAsshdWHMg4BBgHXmTy+Q+vLpH0ramIxwP/S4OViJS+mqAKISMYOCVXmptTsuCUVWIVhYOSQFtvvZymMco94x5TPTb4PdtVELyL+5+7p0Qp6dCwgun5uw85x/q+IymbhMLu0qLAhkEdyrfLZ6ZN/fnr4oHTyBPySCpHC4KnTEFwgh1ge5mCYP1vrokRPeykXH/yehjYWilnReVsnP34h81HDyXcv5Y00wUqNhHN94+WUz5w7dyCNSdNbg3dkRkddNIHe9WVruy+6WGy7ROfM4W+mzUea0JpB88kdq6sbZ0EvX5ybg2VUL3K6UmHh+pDtwPrnr1YNe+2uOJ5difRdBmuee043dEx3R96niVuMpH/SHoSU6rmum11JFW44WTBhK3hxhdmKrwKmj11WO5K+tQnJHWzTzWM6fGMKYZCWvWrmCm9y6jKDeep3NUdf5wc3uK6cskFS8O5O8taShfRpi245SHUfg1fOZMYOtsfGk5VUai7p5L7fvKpMN8SY9MXn5al1cz0frktJjvq4ATnWx+Syn5TSw4yaN+xxcCCmKAedHnKqGgtSQftktGZ63YlTZ9aFx17umufyPKk64X5OkPHxtMmczLnz3KwUyktKSlyCa/Om9YrTtIWb1eFw15OGzpXvXr7aO1au2bD5jPvnGqMbtWbiZ3HjnPSDZj1yrt9z6NN265MFJxN0RMRh7yO1y7bIqnQ8zxePG9KRkE89yi/QHlP2W+OHUMFX1aYRR352jCzOlPnctjZbZrLh4ZgpxgX+q05+Uy76VjRleCjiZ6EW0wT94PZRbsTD5Tkb4xTv7tuuXLcaFOzfWR+vn/mmLL89tQr2ndaRrld3vya3fgRChVk0BZV86qf81/tzbnGMOhVuOA/u95lZEH9Z9PtU028hkVeVt75BZaQkmEJIai/FChk1aGlAPf9bUBK+n+Sis1gWBqQBj8TkN/uCBigbFibwZYTpEVjPNplwEj3f37HIsH+uXZgkdqBBbUDxNyBjs9CJQ2TQ/X83yRKLhanO4/7audNGzkusnmW+28nidbqePbpJZVyox5aRV4cWk/rsD6/iVhUPeE2pMKYdjNDPilk+eLsQN2owu3src0Rc+satngcoRpVFt7db3g4mVL4x0a/K4HqhOaw+JdmnLFDTV8cILtfL7E/Mae+ygQXdyDi7dXotxNnFwx753C60TrkID/EMnFPfrCi8U3b9V1PH5Hkb89O2s02eCF/Ll854Vz2lPbup4azlLRcvPV3JAsbh048wZ5b39Zmt3bp3QVHFqSNvGtTnDnnZYZbqnpnganfs6xJxofNfS+csPlqdrMEN6X4SOE668V128RG712912pbjqmcwA9Z4nF6q+KhETqpV9+dxqWt+hjQUcspy8xeXlquLRoToKZ/vEZP33pM7oTp468vLF53WENn7/6wVq7WvMf67G0B6U/GzLmpPcOGU3XMZ6ouruNGsr/pbZ2nMXMUZzoklHRhHpcexEoC7perlpwdectrxosJBYrNOuxStZP2C1nPKiqFyY3CF7oNZQ6bLrSf1/C5v3RVqwsb3ntgdUOrf15hz8OisCcVOSkL2u60zXjBNtirrL9n76Jw8fMVQYkBR0xT//DZOrssQV//TVt0pf4aozW2Vm4Vj5fZZ1RRnC/c2m1nKtrwkd+VSPc1Up4TuGGzjZt56r2i9OGPtru+21hU6pAflVvXeCc9c6B2toHa2fyD8veteP7wvmTEwAQVLF5uFBXjgT4YZIdhDq6rfyrKsnc8QuOJWEaW3SkVguvjV3svMW7oZFjAs6TFDfkI1S3fJX9GGvtffegD4hZELQjWgZuSANg8wMwMLXNzZcocB3aHXWXK3LSfK3N/w18Ep+QhwtPxKTlwSjacsnbASCY4OGUpPLUfDgsNM/+n2yzkW2tAM140V5gUHBNrEiGKhm0HGGBhi1FmdE2MMwb5R1nIM1gB6DNY0mf2kkAvtu9pwtCBZypN6Jo/uhEL70zbndvomaRucrNeFD56C23jkMfB6zZN27ioLkkuqyI0wMTIpqtSeCN66ddzU19Sr0wqc9y/8y3vfnDZaMvdOXNCU7MWrXRw96qXW7ewTn2GxtvJ01Zyaou+RD61IZkYbHk+ZeTuW8c0E7InPGkOuWw/JTFZ563yoj1ZoqWr3l0di3UYd36F0pld+wlyW9oiPkeYbMgfN3VcpC87WIvC48/K3fhs6bvyNW8dDB/1TKo9a9nOH3O4qVCvrfbhW4XCTfo5uS4KU2id5Iw7WpVmak86Lhhf899+lD2BepF6/uKhw01H7t5XTZ/J8rU2m6+nvqT4nV7XI6OJdF7uEb+MCL5g7wlRpS2BuAcap28jmarsEkYrL3F5/3jNEg2B6iLW3vgm23GhOyvncILSKjWDx+ekNdx729U5rGCz3uPfd+fUvp4TzHzqT9q63IaYQLxBLI7TUjnH5R7reHBxJP5cA/OSgv7rR6GmrTkfCmZvrMfcKXA46/c2ZzdlhpPSJrFWLcbgQvGW3VNZCaMsL9bt2JGXnDz6s9MGrQPdjjri99u7yiJPzMh50hKXqN76ympTktqM3jslOhFxzws/96xsoYlf8SYV9sBteOfVDQ1x0cFrp9zY5u3qVib2GV2QOMRMO7mdSS2e2r2vZtecioL0LT7zvV2dWOXTLm+J96eKnSK/JOVVnI2OnneZE6ssn+z+O0OCL4Il+INYCIJTNvyvC9ePPw78tjmSn1KFJJ8+J6bgGHKyOy9Aim89GkMBlj2rCut8m4hngNT2Jdt+7+rON3dShjYYnI3OSj3eov4IDpGZIsfwhj3zx4n1f/hVD88///etgrFi3b+MbM+Bb53Sv6vNeAmE8XBcvWfp8e2CWXrE+4y5HNMzJTNJUxkKmsmHExw9Z5dZWShaKd30CNP1It7jrFV9mbt5GE/ob3S45JmJgdIYBQdqN2/5Oseoi+tCZtw/vwLfENHOSPvj0dErh9a2rdozc4kgcT+EL/1SeuJUdXPblwvLMfdenNkWsrNu0qWoSwHdzd2nVWtzrKPaDImd7Y7LhyTWavb6TPr9ie8o75eX0slDz++J2rS1qbvcILRr8mTcQaejo5nJ2ntLn6vUZNl1+49sc4tXY/72Zb+T4opJXifnnS/dY/YwWOnceN/VBJOpGllzdqx68VI942V27u9JH2xaNCIlCvOgK6XeYyN2yWs1jPWsn2Hkr72iQILVB5cnut/WiMiQYFXB0BDUNVf/z27Ef7zTJuOTc2A1WZekfdsxhAD4wBkCQxH94Hg8w9KMgbRZf/JIu+bUSdvd9S+1jM1U5d8qj9Dccjzpu1smxFcYrspLsBk+OA2/6TmiFurS6Qbm6gaX5ry997Tz9cID2Vt0XpqFD22Re3Lv9irXMfPG7mzYLJ67ybhu/NxQlf13nxYuHhb9ijm8VvSwV9BOKZi2vXP6/CXjOLO2a73Glhizs+21b73+RCNxW7ySFpOTFufEKAfkh/rrE7TCLh2pDtt26zX3ETPe8cSXR/eavki+NgX7XT/99EiOPK+qbv6GN+/j7U81ViXd+Hpt10laHoPg0eR88swpLa85BW9Tm9c9WlVaREtpUd5mM35e5NaaOcwbzbtu399Z8vLefblFyr7104xu8c/8YTAptWWafPlS0szHE98e8HM+siIeai88b9AZt3sFY8KDVfaY/wMuL97LDQplbmRzdHJlYW0NCmVuZG9iag0KMjAgMCBvYmoNCjw8L1R5cGUvTWV0YWRhdGEvU3VidHlwZS9YTUwvTGVuZ3RoIDMwODc+Pg0Kc3RyZWFtDQo8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/Pjx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IjMuMS03MDEiPgo8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPgo8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiAgeG1sbnM6cGRmPSJodHRwOi8vbnMuYWRvYmUuY29tL3BkZi8xLjMvIj4KPHBkZjpQcm9kdWNlcj5NaWNyb3NvZnTCriBXb3JkIGZvciBPZmZpY2UgMzY1PC9wZGY6UHJvZHVjZXI+PC9yZGY6RGVzY3JpcHRpb24+CjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiICB4bWxuczpkYz0iaHR0cDovL3B1cmwub3JnL2RjL2VsZW1lbnRzLzEuMS8iPgo8ZGM6Y3JlYXRvcj48cmRmOlNlcT48cmRmOmxpPkF1ZHVuIFdhbmdlbnN0ZWVuPC9yZGY6bGk+PC9yZGY6U2VxPjwvZGM6Y3JlYXRvcj48L3JkZjpEZXNjcmlwdGlvbj4KPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgIHhtbG5zOnhtcD0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLyI+Cjx4bXA6Q3JlYXRvclRvb2w+TWljcm9zb2Z0wq4gV29yZCBmb3IgT2ZmaWNlIDM2NTwveG1wOkNyZWF0b3JUb29sPjx4bXA6Q3JlYXRlRGF0ZT4yMDIwLTAyLTExVDEwOjQzOjA5KzAxOjAwPC94bXA6Q3JlYXRlRGF0ZT48eG1wOk1vZGlmeURhdGU+MjAyMC0wMi0xMVQxMDo0MzowOSswMTowMDwveG1wOk1vZGlmeURhdGU+PC9yZGY6RGVzY3JpcHRpb24+CjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiICB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyI+Cjx4bXBNTTpEb2N1bWVudElEPnV1aWQ6MDhEOUY0MjUtMjVCOS00QTNELTk0RjItNDU1NTBCM0REMDU2PC94bXBNTTpEb2N1bWVudElEPjx4bXBNTTpJbnN0YW5jZUlEPnV1aWQ6MDhEOUY0MjUtMjVCOS00QTNELTk0RjItNDU1NTBCM0REMDU2PC94bXBNTTpJbnN0YW5jZUlEPjwvcmRmOkRlc2NyaXB0aW9uPgogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKPC9yZGY6UkRGPjwveDp4bXBtZXRhPjw/eHBhY2tldCBlbmQ9InciPz4NCmVuZHN0cmVhbQ0KZW5kb2JqDQoyMSAwIG9iag0KPDwvRGlzcGxheURvY1RpdGxlIHRydWU+Pg0KZW5kb2JqDQoyMiAwIG9iag0KPDwvVHlwZS9YUmVmL1NpemUgMjIvV1sgMSA0IDJdIC9Sb290IDEgMCBSL0luZm8gOSAwIFIvSURbPDI1RjREOTA4QjkyNTNENEE5NEYyNDU1NTBCM0REMDU2PjwyNUY0RDkwOEI5MjUzRDRBOTRGMjQ1NTUwQjNERDA1Nj5dIC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDg2Pj4NCnN0cmVhbQ0KeJwty7sVQFAQhOG5Tw6RUC3a0sBNdSGgAMU4RyLUxrVmbLBfMj9gV6uzPwAfu7iJe0joxEHiKk6SesAz9yKIKJJw4l9m6/LIvNlIu5D5ImUCXqb/CtoNCmVuZHN0cmVhbQ0KZW5kb2JqDQp4cmVmDQowIDIzDQowMDAwMDAwMDEwIDY1NTM1IGYNCjAwMDAwMDAwMTcgMDAwMDAgbg0KMDAwMDAwMDE2NiAwMDAwMCBuDQowMDAwMDAwMjIyIDAwMDAwIG4NCjAwMDAwMDA0ODYgMDAwMDAgbg0KMDAwMDAwMDc3OCAwMDAwMCBuDQowMDAwMDAwOTQ2IDAwMDAwIG4NCjAwMDAwMDExODUgMDAwMDAgbg0KMDAwMDAwMTIzOCAwMDAwMCBuDQowMDAwMDAxMjkxIDAwMDAwIG4NCjAwMDAwMDAwMTEgNjU1MzUgZg0KMDAwMDAwMDAxMiA2NTUzNSBmDQowMDAwMDAwMDEzIDY1NTM1IGYNCjAwMDAwMDAwMTQgNjU1MzUgZg0KMDAwMDAwMDAxNSA2NTUzNSBmDQowMDAwMDAwMDE2IDY1NTM1IGYNCjAwMDAwMDAwMTcgNjU1MzUgZg0KMDAwMDAwMDAwMCA2NTUzNSBmDQowMDAwMDAxOTU3IDAwMDAwIG4NCjAwMDAwMDIxODYgMDAwMDAgbg0KMDAwMDAyOTkxMyAwMDAwMCBuDQowMDAwMDMzMDgzIDAwMDAwIG4NCjAwMDAwMzMxMjggMDAwMDAgbg0KdHJhaWxlcg0KPDwvU2l6ZSAyMy9Sb290IDEgMCBSL0luZm8gOSAwIFIvSURbPDI1RjREOTA4QjkyNTNENEE5NEYyNDU1NTBCM0REMDU2PjwyNUY0RDkwOEI5MjUzRDRBOTRGMjQ1NTUwQjNERDA1Nj5dID4+DQpzdGFydHhyZWYNCjMzNDEzDQolJUVPRg0KeHJlZg0KMCAwDQp0cmFpbGVyDQo8PC9TaXplIDIzL1Jvb3QgMSAwIFIvSW5mbyA5IDAgUi9JRFs8MjVGNEQ5MDhCOTI1M0Q0QTk0RjI0NTU1MEIzREQwNTY+PDI1RjREOTA4QjkyNTNENEE5NEYyNDU1NTBCM0REMDU2Pl0gL1ByZXYgMzM0MTMvWFJlZlN0bSAzMzEyOD4+DQpzdGFydHhyZWYNCjM0MDI5DQolJUVPRg==",
    "mimeType" : "application/pdf"
  }
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 327

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T06:31:14.801Z"
  },
  "sessionExpirationTime" : "2018-05-03T07:30Z",
  "sessionId" : "ca5e5a1f-12c7-47ca-b47f-5a71dd67b49b",
  "url" : "https://foo.bar/hosting/init?sid=ca5e5a1f-12c7-47ca-b47f-5a71dd67b49b&sk=dd28788a-7931-4ab8-8259-4ed58e7be7a0"
}
Example Curl request
$ curl 'https://api.aerahost.com/hosting/api/v1/session/sign/pades' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiaG9zdGluZ1NpZ24iXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.aIJR6RJ63Szm5zbSe-bdCNCkJo5mXMwfyl1IjSOxdZl9g3b-ZZxYUF1N5oWN3Bp_PBJdDUSgB7aqk4x3eMyzXcpv0soWBQpjLKyx-vqHZY4XOmZBlZBbFEHs9eMerOQ2WA6zjhrc5dhgNYWMBH6gyTt8tMZ0va_ljWJ2NnTcqev3vMlN8ZhdtLVsSU5IirQ--nmlirvgI8w5uIccdEOLKORIkrjrgWCNFtYX4e4rFKStGYOR8WT5LqWgGLFzNKWejmm5uEpDLdSK31GGdv9CBYB4-HDx071ChcEnynwZOrJK2IBb7dvxcbVyO8ZsRSJEbbo-5WaXYETQbRqZIlDt3g' \
    -H 'Accept: application/json' \
    -d '{
  "uiLocales" : "no",
  "identifiers" : [ {
    "identifierValue" : "17012099479",
    "identifierType" : "NIN"
  } ],
  "scope" : [ "profile", "https://aera.id/scopes/altsub", "https://aera.id/scopes/nin", "https://aera.id/scopes/nin_alias" ],
  "dataToSign" : {
    "description" : "Kontraktsnummer 1001215646541321241123123123123132, version 20190201",
    "contract" : "JVBERi0xLjcNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFIvTGFuZyhlbi1VUykgL1N0cnVjdFRyZWVSb290IDEwIDAgUi9NYXJrSW5mbzw8L01hcmtlZCB0cnVlPj4vTWV0YWRhdGEgMjAgMCBSL1ZpZXdlclByZWZlcmVuY2VzIDIxIDAgUj4+DQplbmRvYmoNCjIgMCBvYmoNCjw8L1R5cGUvUGFnZXMvQ291bnQgMS9LaWRzWyAzIDAgUl0gPj4NCmVuZG9iag0KMyAwIG9iag0KPDwvVHlwZS9QYWdlL1BhcmVudCAyIDAgUi9SZXNvdXJjZXM8PC9Gb250PDwvRjEgNSAwIFI+Pi9FeHRHU3RhdGU8PC9HUzcgNyAwIFIvR1M4IDggMCBSPj4vUHJvY1NldFsvUERGL1RleHQvSW1hZ2VCL0ltYWdlQy9JbWFnZUldID4+L01lZGlhQm94WyAwIDAgNjEyIDc5Ml0gL0NvbnRlbnRzIDQgMCBSL0dyb3VwPDwvVHlwZS9Hcm91cC9TL1RyYW5zcGFyZW5jeS9DUy9EZXZpY2VSR0I+Pi9UYWJzL1MvU3RydWN0UGFyZW50cyAwPj4NCmVuZG9iag0KNCAwIG9iag0KPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0xlbmd0aCAyMTg+Pg0Kc3RyZWFtDQp4nK3RTWvDMAwG4LvB/+E92oMqUuzYDZQemrRlg0JLAzuMnrqsDJbu+//PKb1skNOig0BI6EEI2RazWbapbmvwfI5FXeFdKybuo5QcjJByLHN8tFrd3+Cs1aLRKlsJRIg9mietJM0xBDEnzj0il1SkTpfm1vuI02faidOlml6rtVYPZm8PaO60WqaNO63+RUfi8Iu+iFfoubMTZ96sMy8txkOFPYUwhG7txJu6Tys8WvHmdUTZBXKD5x6/rTjTjcgVRe8McO35i0a0oiOZDll/voflpsIPFKeGsw0KZW5kc3RyZWFtDQplbmRvYmoNCjUgMCBvYmoNCjw8L1R5cGUvRm9udC9TdWJ0eXBlL1RydWVUeXBlL05hbWUvRjEvQmFzZUZvbnQvQkNERUVFK0NhbGlicmkvRW5jb2RpbmcvV2luQW5zaUVuY29kaW5nL0ZvbnREZXNjcmlwdG9yIDYgMCBSL0ZpcnN0Q2hhciAzMi9MYXN0Q2hhciAxMTcvV2lkdGhzIDE4IDAgUj4+DQplbmRvYmoNCjYgMCBvYmoNCjw8L1R5cGUvRm9udERlc2NyaXB0b3IvRm9udE5hbWUvQkNERUVFK0NhbGlicmkvRmxhZ3MgMzIvSXRhbGljQW5nbGUgMC9Bc2NlbnQgNzUwL0Rlc2NlbnQgLTI1MC9DYXBIZWlnaHQgNzUwL0F2Z1dpZHRoIDUyMS9NYXhXaWR0aCAxNzQzL0ZvbnRXZWlnaHQgNDAwL1hIZWlnaHQgMjUwL1N0ZW1WIDUyL0ZvbnRCQm94WyAtNTAzIC0yNTAgMTI0MCA3NTBdIC9Gb250RmlsZTIgMTkgMCBSPj4NCmVuZG9iag0KNyAwIG9iag0KPDwvVHlwZS9FeHRHU3RhdGUvQk0vTm9ybWFsL2NhIDE+Pg0KZW5kb2JqDQo4IDAgb2JqDQo8PC9UeXBlL0V4dEdTdGF0ZS9CTS9Ob3JtYWwvQ0EgMT4+DQplbmRvYmoNCjkgMCBvYmoNCjw8L0F1dGhvcihBdWR1biBXYW5nZW5zdGVlbikgL0NyZWF0b3Io/v8ATQBpAGMAcgBvAHMAbwBmAHQArgAgAFcAbwByAGQAIABmAG8AcgAgAE8AZgBmAGkAYwBlACAAMwA2ADUpIC9DcmVhdGlvbkRhdGUoRDoyMDIwMDIxMTEwNDMwOSswMScwMCcpIC9Nb2REYXRlKEQ6MjAyMDAyMTExMDQzMDkrMDEnMDAnKSAvUHJvZHVjZXIo/v8ATQBpAGMAcgBvAHMAbwBmAHQArgAgAFcAbwByAGQAIABmAG8AcgAgAE8AZgBmAGkAYwBlACAAMwA2ADUpID4+DQplbmRvYmoNCjE3IDAgb2JqDQo8PC9UeXBlL09ialN0bS9OIDcvRmlyc3QgNDYvRmlsdGVyL0ZsYXRlRGVjb2RlL0xlbmd0aCAyOTY+Pg0Kc3RyZWFtDQp4nG1R0WrCMBR9F/yH+we3sa1jIMKYyoZYSivsofgQ610NtomkKejfL3ftsANfwjk355ycJCKGAEQEsQDhQRCD8Oh1DmIGUTgDEUIU++EcopcAFgtMWR1AhjmmuL9fCXNnu9Kta2pwW0BwAEwrCFmzXE4nvSUYLCtTdg1p98wpuEp2gME1UuwtUWaMw8zUtJNX7sh5qbQ+i3e5Lk84JupjRrsJ3dyW7iCG6I3P0sYRJrys9elB9l56NDfMqXT4QfJEtsfs+cOfulaa8rPkhjx40z5BOmX0wK1T39KDX/Zl7OVozOVxe560ZyLHJR3uZGnNiL+f/TriKyVrU40Gea1ONNL253hZZWWDG1V1loa7Jl3TFvzH83+vm8iG2qKnj6efTn4AVAqiuw0KZW5kc3RyZWFtDQplbmRvYmoNCjE4IDAgb2JqDQpbIDIyNiAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDI1MiAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCA2MTUgMCA0NTkgMCAwIDAgMCAwIDAgMCAwIDAgNTE3IDAgMCA0NTkgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgNDIzIDUyNSA0OTggMCAwIDAgMjMwIDAgMCAyMzAgNzk5IDUyNSA1MjcgNTI1IDAgMCAwIDMzNSA1MjVdIA0KZW5kb2JqDQoxOSAwIG9iag0KPDwvRmlsdGVyL0ZsYXRlRGVjb2RlL0xlbmd0aCAyNzYzNi9MZW5ndGgxIDk1NDIwPj4NCnN0cmVhbQ0KeJzsXQdYVMfanjlbYVnYhaUusIsLWFZBxYIlstIUKwiroKIgRVRULNiihsREExITc1NNNT03piyrRjTN5Kb34k29KeYm9yY3Mb1YIvzvnG9H0aj5b/7cJzfPvx+8533nm2/mzMyZmTNrIDDOGLPgomVVBbn5ZVd8PCWX8YnfMabfVJA7Ls+w7JppjI+bzpjm6omlmf2vf7R6B2P8fJSqqplf3TSIRycwNu9y5L9es2ypc1fTmwMZu+lcxnQP1jfNnr/2Pc1gxhY2MmZ2z25cWb8pa8Qqxu7wMDYio6GuuvbA+JU+1BeG+gY1wGG+J3E/0vlIpzbMX7ri6/yk8Uh/wticuxsX1lQP+8btYOzjJoRPnl+9oinDnB6N/AbEO+fXLa2+5pwtyxifjPuzcxdUz6+74dD3Mxm3P81Y3yVNC5cs7bSz9ejPcBHftLiuKWp2t3jGVl+N233GxFjoh+5beuPmjTMjhn/P4o1M2AOfrX5e8BtFyycePnSkJeRz4yAkQ5jCyFBOzzoYfzx0y+FDh7aEfK7W1MXi7xYeey/WwixsBdOgpIVlsg2MRQ7CfRXkarRuvonpmFG3WZeFKpOJNS+z9QozMiVCpyiKVqNoP2IZnXtY6plqC2DjS51OhvFMe57aYLhBSXcy3inyNDt14aKnzKYNP9Ya/hL7zU37Obv715TT3PPryv1fTf/Gb3dfbbdT14X+jfqt7vN7m+Y5Nv9kfm0du+m4uJbj06esr/iX4/jnp49BvvVUecoHJy+r17ObtJeePE97F6v/pTZ1Nc0Tx+rR7D9hHCayopOWqWCJx91zI7vx37nn72GaWWzq6fL1nPK1A1jVceUOs8r/YLP+q42/zs77X8Rs/rUx+lq2GeN9yvLa7NM/s5/Fd6lLefaX23UyU+5lKT+rt/nnvpPF6KIoTv/WL8eLGLT38l/Txt/KlAksX/mYjVbaj9/jeQ2rPqpnsEbtZNao/ENFAeIbVf8PAf47cymfkv7/ZpjXjL/4e7ciaEELWtDIlGt56Cnzqtj+U+bp2FX/mRb995tmILvw925D0IIWtKAF7deb9tF/798+fsk0Y9nFgpWLiE96z/nH8pQ3u+gWVvhbtiVoQQta0IIWtKAFLWhBC1rQgvbHN/k583TW9XOmtK6fN4MWtKAFLWhBC1rQgha0oAUtaEELWtCC9vsa/1U/jR60oAUtaEELWtCCFrSgBS1oQQta0IIWtKAFLWhBC1rQgha0oAUtaEELWtCCFrSgBS1oQQta0IIWtKAFLWhBC1rQgha03946d//eLQha0H5n0wSQGPhLUh1IQSnfMS37EOkM5oQSf9PJzLohlc8K2XhWzEpZHZvDmthi1sy28H5JfZOGJI1whjjPSnu+U/2LUIh3Hhdfg/hGxC89STzv/B7N6NW5t/ODzh+ZgZlQ/jvGeAJWaQ0b+NkG8bW/+77q988ItLPXcb3oBqT+zBvooWaM5ipu4Qk8mS/kzXwZX8Mv4NfwHUzPf1Ajfjjxr2ghrQT+5pbCTm/82D1OMcDlv1BDV4sD0o/z5KvXKep1xi80Re1jQKt/C+dYf6EvAkSv/yim+U9Uyuv/H8xr5pm6/rylSxYvalq4YH7jvLlzGmbX19XOmjmjcvq0qRXl3rLSSSXFEyeMHzd2TNHoUYUF+Xm5Iz05I84YPmzokOzBgwZmZvTp3SM9LdXVzRFns1oizKbQEKNBr9NqFM56F7gKq5y+9CqfNt01enQfkXZVw1HdxVHlc8JVeHyMz1mlhjmPj/Qgsv6ESA9Feo5GcotzOBvep7ezwOX0vZDvcrbzqSXl0BvzXRVO335Vj1e1Nl1NmJFISUEJZ0FcQ77Tx6ucBb7CZQ2tBVX5qK/NFJrnyqsL7dObtYWaIE1Qvh6upjbeYwRXhdKjYGibwoxmcVufJq2gutZXXFJekG9PSalQfSxPrcunz/MZ1Lqcc0Sb2YXOtt57Wi9qt7BZVe6wWldt9fRyn6YahVo1Ba2tG3xWt6+nK9/Xc9VHcehyna+3K7/A53ahsrGTjt6A+3RpFpez9XuGxrv2f368pzrg0adZvmdCii4eHSbkS83QNrQQ/UtJEW25sN3DZiHhaykpp7STzbL7mSfTXeFTqkTOHpkT7RU5LTLnaPEqV4p4VAVVge9lDXG+llnOPr0x+up3Gr6R7/Rp0qtm1TQIrq5rdeXn07iVlfs8+RCe6kBfC9r6ZiK+ugqdmCOGoaTcl+lq8tlcuRQAh1M8gzml5WqRQDGfLc/HqmoCpXyZBfmiXc6C1qp8aqCoy1VSvotldX7QNsBp35bFBrAK0Q5fTB4eSnpBa3ltvc9RZa/F/Kx3lttTfJ4KDF+Fq7yuQjwll8XX8wPcLkW9o1oKfTshWgaLnhvSjM5yxa6pEE8LDmchLq7c4ciw4HGpSfFEc4c7y7mdyTDcJRAh1HH1IKFJyxstsjSiaN5oe0pFCtlpmmQPtEmX5jN2qcsCx9E20X1O2TSKFg3q6Syoy+/SwOMq1QUaGKjt5O1UxFgEbowSRvE4R8ssTRpWLnwKqlFd4inGOX2s2FnuqnNVuDCHPMXlom9irNXnO7bUNbZkarn6tAOzpOy4FOVnU8rHUpAtE0oe5mCh2y4fq5oepaaPJkefkF0ks12iXa2ttW1Mkyamsr2Nq0KXd2GFb6K7wuWb5XaliHb26d1mZGEpZVV5WKuF2O5chdUup8VZ2Frd3tkyq7XN42ltKqhqGIp10eoqqm11lZYPt6uNn1S+xr5K3DuSjeVjy3JRlcJy21z8/JI2Dz+/dGr5LgtjzvPLyv0KV/KqcivaUpFXvsuJF4DqVYRXOEXCKRKipklIGNV4+y4PYy1qrlZ1qOmads5Un1H6OKtpV8hnoRulqzfy4HRU066lHI+M1sJnJF8LRfcIRBuRYxE5u5kizpgik6yNiQH2hOo8Rk+IJ0wxKxhS4fLDsxuxIZxtC+Nmbm9DnZNUdztvaQvx2HepNU0KRLYgUvhajvrQchHWpSLcjzruPdYD79TybWEM9atXROQKwyyMa8AcwvukwFkr5t/qiobWqgqxe7AYzFV8cx93jWA+xTUCLdaH+UJddbk+kytX+HOEP4f8euE3YObzGI6HLTbd1ioXNmKsmHJm57TWNKJKZ3tnZ1l5ygv2/RUpWEvTganlvhA3Xm66tDGIGyVQBfcoX0tNtWgH85aLsoa0opoKrEtZIUKKfCGoISRQAyIK1TJivaFQDeZatUuVcGPraKnwVbjFTcvnVKjr1eJjo11Dffp0qlOXLm6UWdEa6eqvbj5Y66FpGwSFoG2stJw8diRxswoaJEMYWl7jQlZNlZPmSCnWMr0sQu3kqcOer02vUxFqD2Qy0S1Nmskc6gvJQIX4FtqUIfYcXZqhooIar6Y2BAJwb4vPhBaldxnKQAGMDrKKRFvwvQFNFaGPimpK2tkk1wpsnaLRak0GZPvMaUXVeLtReRM8rmxZ2Cg2QVOgjsfJaxA9D8O4Y0to77zDtTKli2HvEG8/Mf+YfRcWKqtoPdHhm+bu09t4otesultbjeaTF6DxMpqPsupU0mrEWwEsJpw635wF4lXpGtOmTHCrzFVuHePCG0RJE8BBR4Plk+KsrRBRaHKxupedMoh3CRKvabXyVsswmeKBFD3MVt/s45MNR5OFAjgMpmXQGQJdEXst5spcu68RM1OGiCfibHVaXENd4qIWHiVQhYd0dFlg+mPWiUXTUuMsn4XJjgoLq1oLW8URtaY6MGyBO/kWuI+rEuuCY/KgItEdX0uxs6rCWYWjKS8pT0mxYzWCnfU4p7qqxaugmPpTPFU9qlS3iinOcFKpsPsMeDHVV9e5UvAG8YkdiEZftFEbWDbM3trqavWp67YQwag+HcuuSBC+m9yu6jpxhK4XJ+g6tWwhmquOjqjNXuDCWq6DWx1LDBy2vlniUtMqDuiVVW6MhLU1stU5pBVbcCXeHtr0mslVeFWJN5JTfdTVdqQwCEUiVYGKKDAkTQTSEhCtme9uqzSkHfOo3wvdFGxUa0XLJpX7imWIup6EWOT2KbHZyBSd55Omlst9SiOyizC8Hswquyjt9Cll5YHHo5YvEkXt8oFRMXjUd0hgfR1928j30HQ7xvSUfrwcNCNLlaeVJ1k2cyhPBfhdlq28zbzKW+A3wG8G+HXwX8F7wa+BXwW/An4E/DD4IfCDzMu0yjtsAFAGaI6qWuBWYC+gY/NQE2cmlOfMpjzG8oFaYClwOaBD7MPIuxU1cuZUzt0eEsfH4IGuk+IcKc6WokWKs6RYK8UaKVZLcaYUq6RYKcUKKZZLsUyKZimWSrFEikVSNEmxUIoFUsyXolGKeVLMlWKOFA1SzJaiXoo6KWqlqJFilhTVUlRJMVOKGVJUSjFdimlSTJWiQopyKaZIMVkKrxRlUpRKMUmKEimKpZgoxQQpxksxToqxUoyRokiK0VKMkqJQigIp8qXIkyJXipFSeKTIkWKEFGdIMVyKYVIMlWKIFNlSDJZikBQDpRggRZYU/aXoJ0VfKTKlyJCijxS9pXBL0UuKnlL0kKK7FOlSpEmRKoVLim5SpEjhlMIhRbIUSVIkSmGXIkGKeCnipIiVIkaKaClsUkRJESmFVQqLFBFShEthliJMCpMUoVKESGGUwiCFXgqdFFopNFIoUnApWEDwTik6pDgixU9SHJbikBQHpTggxY9S/CDF91J8J8W3UnwjxddSfCXFl1J8IcV+KT6X4jMp/iXFp1J8IsU/pfiHFB9L8ZEUf5fiQyn2SfGBFO9L8Z4U70rxNynekeJtKd6S4k0p3pDidSn+KsVeKV6T4lUpXpHiZSlekuJFKV6Q4nkpnpPiWSmekeJpKZ6S4kkpnpDicSn+IsVjUjwqxR4pHpHiYSkekuJBKR6QYrcUu6Rol2KnFPdLsUOK7VJsk8IvRZsUPinuk+JeKe6R4m4ptkpxlxR/luJOKe6Q4nYpbpPiVilukeJmKW6SYosUN0pxgxTXS3GdFNdKcY0Um6W4WoqrpLhSiiukuFyKy6T4kxSXSrFJikukuFiKjVJcJMWFUrRKcYEU50uxQYr1UpwnhTz2cHns4fLYw+Wxh8tjD5fHHi6PPVwee7g89nB57OHy2MPlsYfLYw+Xxx4ujz1cHnu4PPZweezhi6WQ5x8uzz9cnn+4PP9wef7h8vzD5fmHy/MPl+cfLs8/XJ5/uDz/cHn+4fL8w+X5h8vzD5fnHy7PP1yef7g8/3B5/uHy/MPl+YfL8w+X5x8uzz9cnn+4PP9wef7h8vzD5fmHy/MPl8ceLo89XB57uDztcHna4fK0w+Vph8vTDpenHS5PO1yedrg87fC8bUK0K+f6k0c4cGb2J0eDzqHU2f7koaAWSp1FtNafHAZaQ6nVRGcSrSJa6U8aCVrhT8oDLSdaRtRMeUsptYRoMTkX+ZNyQU1EC4kWUMh8okaief7EAtBcojlEDUSzier9ifmgOkrVEtUQzSKqJqoimkk0g8pVUmo60TSiqUQVROVEU4gmE3mJyohKiSYRlRAVE00kmkA0nmgc0ViiMX57EaiIaLTfPgY0iqjQbx8LKvDbx4HyifKIcilvJJXzEOVQuRFEZxANp8hhREOp+BCibKLBRIOIBlJlA4iyqJb+RP2I+lJlmUQZVK4PUW8iN1Evop5EPYi6U9XpRGlUZyqRi6gbVZ1C5KRyDqJkoiSiRCI7UYI/YQIonijOnzARFEsUQ85oIhs5o4giiayUZyGKIGc4kZkojPJMRKFEIZRnJDIQ6f3xxSCdP74EpCXSkFOhFCdiKvFOog41hB+h1E9Eh4kOUd5BSh0g+pHoB6Lv/XFloO/8caWgbyn1DdHXRF9R3peU+oJoP9HnlPcZ0b/I+SnRJ0T/JPoHhXxMqY8o9XdKfUi0j+gDynuf6D1yvkv0N6J3iN6mkLco9SbRG/7YKaDX/bGTQX8l2kvO14heJXqF6GUKeYnoRXK+QPQ80XNEz1LIM0RPk/MpoieJniB6nOgvFPkYpR4l2kP0COU9TPQQOR8keoBoN9EuonaK3Emp+4l2EG0n2uaPyQH5/THTQG1EPqL7iO4luofobqKtRHf5Y7Bf8z9TLXcS3UF5txPdRnQr0S1ENxPdRLSF6Eaq7Aaq5Xqi6yjvWqJriDYTXU0FrqLUlURXEF1OeZdRLX8iupTyNhFdQnQx0UaiiyjyQkq1El1AdD7RBqL1/uhq0Hn+6Fmgc4nW+aPrQecQne2P9oJa/NHYjPlZ/uhBoLVEa6j4aip3JtEqf3QtaCUVX0G0nGgZUTPRUqIlVPViKr6IqMkfXQNaSJUtoMj5RI1E84jmEs2hcg1Es6ll9VS8jqiWImuIZhFVE1URzSSaQZ2upJZNJ5pGnZ5KVVfQjcqJplBzJ9ONvFRLGVEp0SSiEr/NAyr228QdJvptYnpP8NvWgcb7bX1A4yhkLNEYvw3nAl5EqdFEo8hZ6LetBRX4bRtA+X7bWaA8v60FlOuPLASNJPIQ5RCN8Efi/c7PoNRwv7UCNIxoqN8qpsYQomy/dRRosN9aDhrkt04FDaS8AURZfmtvUH+K7Oe3io719VvF2swkyqDifegOvYncVFkvop5UWQ+i7kTpRGl+qxilVCIX1dmN6kyhypxUi4MomcolESUS2YkSiOL9lkpQnN8yAxTrt8wExRBFE9mIoogiqYCVCljIGUEUTmQmCqNIE0WGkjOEyEhkINJTpI4iteTUEClEnIh5OiNmOQQ6ImocRyJqHT9BHwYOAQfhOwDfj8APwPfAd/B/C3yDvK+R/gr4EvgC2A//58BnyPsX0p8CnwD/BP4RPtvxcXiD4yPg78CHwD74PgC/D7wHvIv038DvAG8DbwFvmuc53jD3c7wO/qu50bHXnO54DXgV+hWz2/Ey8BLwIvJfgO9583zHc9DPQj8D/bR5ruMp8xzHk+YGxxPm2Y7HUfYvqO8x4FHA07kH10eAh4GHwhY5Hgxb7HggbIljd9hSxy6gHdgJ//3ADuRtR942+PxAG+AD7jOtdNxrWuW4x7TacbdpjWOraa3jLuDPwJ3AHcDtwG2mPo5bwbcAN6PMTeAtpnmOG6FvgL4euA76WtR1DerajLquhu8q4ErgCuBy4DLgTyh3KerbFDrBcUnoRMfFobMdG0Nvc1wUeofjPE2a41xNtmMdz3ac423xnr21xXuWd4137dY1XtMablpjXzN2zZlrtq55Z40nUh+62rvKe+bWVd6V3uXeFVuXe3cr61m9cp5nuHfZ1mavttnWvLRZ810z39rM85t532ausGZLs7NZE7bUu9i7ZOtiL1tcvLhlsW+xdphv8QeLFbaYh7Z37tm22J5cCPasXmy2FC7yLvQ2bV3oXVA/3zsXDZyTPdvbsHW2tz671lu3tdZbkz3LW51d5Z2ZXemdsbXSOz17qnfa1qneiuxy7xTET84u83q3lnlLs0u8k7aWeCdmT/BOgH989ljvuK1jvWOyR3uLto72jsou9Bag8yzRkuhM1FhEAyYkoiXMznP72j32D+xf2bXM7rPvsWsiIxIcCUrPiHieNzGeL4w/K/6SeE1E3EtxiieuZ+/CiNiXYt+P/TJWG+WJ7ZlRyGIsMc4YTbToW8z4skKVc/KJ+w1U++qIcaUXRkTziGhHtFLwZTRfzzTcybn48Ugn1xgRs51HOwo1D3HxI3c6xvkmVuYe225kk8b6jMXTfPx8X1qpuHpKpvr05/uYd+q08jbOL65QfybBZxM/VKKmz9u4kSXljvUllZb7NVu2JOVWjPW1CO3xqLpTaIaQCveMJc1L3OWeM5j1A+tXVk30I5aXLEpEBI+I6IxQPBFofES4I1wRl85wjSe83+DCCLPDrIhLp1kT4zHDI/rXPay4rDDC5DAp3hzTRJPiMeXkFXpMffoW/qyf20Q/6c7upTNwmbFkqVv9RqqCN4ukW3jF95KlSIuvZjXN3Kc1CgPNXAJbKp1LT1/qv934792AP77RT/KM7FTOZbXKOuAc4GygBTgLWAusAVYDZwKrgJXACmA5sAxoBpYCS4BFQBOwEFgAzAcagXnAXGAO0ADMBuqBOqAWqAFmAdVAFTATmAFUAtOBacBUoAIoB6YAkwEvUAaUApOAEqAYmAhMAMYD44CxwBigCBgNjAIKgQIgH8gDcoGRgAfIAUYAZwDDgWHAUGAIkA0MBgYBA4EBQBbQH+gH9AUygQygD9AbcAO9gJ5AD6A7kA6kAamAC+gGpABOwAEkA0lAImAHEoB4IA6IBWKAaMAGRAGRgBWwABFAOGAGwgATEAqEAEbAAOgBHaAd2YmrBlAADjBWy+HjHcAR4CfgMHAIOAgcAH4EfgC+B74DvgW+Ab4GvgK+BL4A9gOfA58B/wI+BT4B/gn8A/gY+Aj4O/AhsA/4AHgfeA94F/gb8A7wNvAW8CbwBvA68FdgL/Aa8CrwCvAy8BLwIvAC8DzwHPAs8AzwNPAU8CTwBPA48BfgMeBRYA/wCPAw8BDwIPAAsBvYBbQDO4H7gR3AdmAb4AfaAB9wH3AvcA9wN7AVuAv4M3AncAdwO3AbcCtwC3AzcBOwBbgRuAG4HrgOuBa4BtgMXA1cBVwJXAFcDlwG/Am4FNgEXAJcDGwELgIuBFqBC4DzgQ3AeuA8VjuyhWP9c6x/jvXPsf451j/H+udY/xzrn2P9c6x/jvXPsf451j/H+udY/xzrn2P9c6x/vhjAHsCxB3DsARx7AMcewLEHcOwBHHsAxx7AsQdw7AEcewDHHsCxB3DsARx7AMcewLEHcOwBHHsAxx7AsQdw7AEcewDHHsCxB3DsARx7AMcewLEHcOwBHHsAx/rnWP8c659j7XOsfY61z7H2OdY+x9rnWPsca59j7XOs/d97H/6DW8Xv3YA/uLElS7oczITFzRS/PmS4gbGOy477PZJiNpctYS34Ws82ssvYI+wdNoutg9rMtrDb2Z+Zjz3KnmFv/Lu/a3M661ipm8/CNDuZnkUx1nmoc3/H7UC7LryL5zKkorTOY55OS+cXJ/i+6Lis09LRro9koWpZs/IqvN/yI52H8MpFunOQSCsboCPUEl8bbui4r+OOE8aghE1l09h0VsmqWDX6X8sa2ByMzDzWyOazBWpqAfJm41qP1ExEYXtR9bGohawJEL8L1MyW4Uv8HtGSQErkLVLTzWw5vlawlWwVO5OtZmsC1+WqZzVyVqnpFcBadhaezNnsHFVJJs86di47D09tAzufXXDa1AVHVSu7kF2E53wxu+SUeuNxqU34upT9CfPhcnYFu5JdjXlxLbvuBO9Vqv8adgO7EXNG5F0Bz42qErkPsifZDnYvu4/dr45lDUaNRkSOS706hk0Yg9Xo4bouLabxW350tNai76JvrYGeroD/nC4llgXGUUSuQyTVQs9B1LLmhJHYhD6QPtYjSl2h9v+Yt+uonM4rx+O6LiNzrZoS6kTvqfSV7HqswJtwFaMq1M3QpG5UdVf/DUdjt6jpW9it7DY8iztUJZk8t0Pfwe7E2r6LbWV34+uY7qqI72X3qE/Ox9qYn21j2/Ek72c7WbvqP13eyfzbAn7/Uc8utps9gBnyMNuDneYxfEnPQ/A9EvA+rvoo/Rj7C9IiilJPsqewQz3LnmPPs5fYE0i9qF6fRupl9ip7jb3BzVCvsE9xPcJe1n3EwtlIfPzfjXG+js34pd+t/L+ZLoFFsy2dBzqXdx7QjGb1vAwHyLvxlLazi/CJfcGxSO5godoPmY1t7/xBMx3c48jbuoaOmzu/ZDrsmks0r2KX0zADG8LGswnsKt957vIHmRmnlBg2lO/YEZ2fb+xjeBgnEIU5cYYxMs7zPBFaxbwzISHHtXOgfqPGWtTO+2zPMWzE6TznyHtHXsw88t7+yCGZ+3nmu/ve22f5+kXrkMysfXv39etr99gSzDsbUXSga2fjQI1+Y6PGmiPKe0IaczyKYWMjKonLcSe86H4x0/2iG9W4+/ar4NYUqwpbuGIw2PSubhnKwO7pg7Ky+o9QBg5Id3ULV1TfgEGDR2iy+icrGpv0jFBEmmte/WmqZuIRvbLWlTM5S5ecEGEz63VKYlxkn+FpltJpacMzkgwag16jMxp6DM7tNraxoNvbBmtSdExSpNEYmRQTnWQ1HHlHF37oG1344Txt4+HLNfph03NSNVeHGhWtXt+eHBffa1hK0eSIKIvWFGWxxhgNkdawHvnTj6yPThR1JEZHU11HxmM472ZMewlGP5I52NVi3D1JOSk8Ks7Cx0dZInCxmXGJDMMlzoTLA/j4xlhC5yfbEJHQ3vnVtogAm1X+YVuYyp9sQ3TCA/igFcLieJg/vMTeztPbdGUsZ38Onsk+9fW9l6hf30p7W3hcOw/b3hheohOR/kaE4hHkqAMvhjGlW/pA64BBWSkYR8OADMXlsopx114y+bavbu/4IrZnz1ieducn15fsGLDwrvX3ta2+a/EQ5Zo7D982ydFde053x5RbPtk8Z8e5Y36yjmh5lHF2d+chTRl63p2tE/1uM0S1U6+iAr2KCvQqKtCrqECvotoV6w5zEktOMqDF26Ki4vXtvMe2biXxXpaTE5hzmY9bh1Dn+mPCtUWJ0B2NiO0mgrc3qtFxOTlH55baRavoXDRJOXVknzVl2lCzoSOd7zGYQ7Wq9hhtzoS4bjZjz1ilUPU+HpVoNXaMNljs0VF2a8iRjw1mg06Hi/be7g48c+q33o1+D2evq8/bUjWiaYRi7ts3NjMzNCMuLqH9f/lwMQye5NR+YWGhYraEitkSakFgaCiiQsVsCd2N588693jikWCpg0pMcbHmzLh+GXpHjxKHN9KrEyOWkxMZO8SalcMz97oDQ2bNshxV1iFnZGZlWbPEJPHYTlpH3LFKMJRpR0fOxcM1QnXnruOGUyzFWJ7FsUiFjNa7jTZHfGxKlFHpyNKYopNs0ck2k9IximOA4+OcUYbe9gZn39S4EL5cx9ebEhzp8fMj7FFhCcYwMbxhRu3sw5cbQg0arSFUj0W5+aj/9l6pYQk97D9N0dye3CveFBKVFC1WHebeU3gGiawnu1Gdfan6wLDrA8OuDwy7PjDs+sCw68Wwx1qTxJgniTFPsoSZ+bgkJ/KSxI92MGtaOw/dpteHudq5aVt0SViXaUkLztJlZupF9I5GhEeL+O2NaoETZ6brxOmo7bIENU95lt+z4rKQqJT4+BSbsVcCj+41fs78cT13DJtS2fvGayfMLkzVXFZ93YLhHRlHB+auHt0MsTnTV06ZOHdA+JGDPUbVYG6O6tyvqdGlsCLeQ4zKLjay85PtERY+bmRgNFS2BDhMZXVURrYrvT3u/p4oGx/X32Pl41P7p/YPs8eJsnYxKe0Wi7igiF3MTPtupZ+YmdvsmJjiH5XjA2wjvj/Cis/EYRkP8O5sMAvl6R6T1TmYD/aYwvg4q/gX61ChBlsHW2OGi6U90q7rWRrTznu26SaLLS5yyJD91iFDMjPd7krLfosYejHkNPCRlCE3P3vb4Azx3xEbraHY+XY2qrX2FNXubFTr1YmKsSNOVndElHYHqpaPp1uGVr5i6F2UoQ+k9dGBBydeTtG2ZL2mJm/5TZUjF04ZFmvSGsOM4VnFi8ZkV+al9p80Z0HDpKxhcy4tc08ZPzxKr1U0epPBlJlfOXRQ8YCE/qVzF8wtzeLzpl1c0z/G2S0uzYGXkqFbD1fy4OKswROG9csaUbZoYslZk/tExDuiTNa4qMjEqJBEV1JS39y0QROG9886o3SR+H9LzO/8SrNO25cNZPPEU/bHse7tyghPaFjM4cyknCQlqVs7j8SA1ysHnP369lP69W7nA9sMc/Be31u5X73gBbL3cYzc/UkxhxuTrGqB0EZrfT/lQGM/g4j3N6IAhutxtwBtC9ou72LtCQOjDpz6zl5nTBhQVDm40X9W4aiWbY2ZU8YMSwjBwjaY0nMqPYVLSnpnTl5edMaUM3qY9Uad5uqklISUxKhRFzxzztnPXzzGkpiS4EqJTLAaHanJg2dfWTnrytqsZFey3poo/r8bNzGm+Qmf9MT7dgSdc6KUIeKVqtg8ISFxB8Nr7Qd1s+Vbko4rYeFxBxvDa3X2g43IOu6t6Dr5W1HzU1Hr0xsP21JTbdza+ui6fF8P74bGSzfVr6/orTguen79yKQUza0pSQXnPrJ20kWzh/70Rb+6q8SzEe0LR/t6s3J1X0rAo7F5bCHOKGcUC0n4MT1dH3/AXNv9gJ7aSNvKC2I6WvaJDcUTlZ7wYyPCzPEHGs21+u4HGvWBNgc2lLQT3+bRP3v3qe+7cK3BpD/yT9EHJdJgMmiRNnRU8dkGk1GjMUJv5ndghmrzMdoG6g9efJGR8RHGjucNloQoa7zF0HGbwRKv9gyfnb9Cz1ysWO2Zzip6FploMtlZol130GqN1R521sY2HP8Sl92KsOoONiLGqT3cqEYdt0XqT/fujlG+iojoWMmb9GGiE2H6jk1G7JVx2CvxeA5GRGjeSXV2bDda4qMiE9D2MiN11qh5NiUpJdB2PlabjvN2Ku2LTLFtD7XU6URjMU3QwG1qCo067g0Y2BSi+Vj1TYY7hticcfFOmzFWjqjmWz0pPevsZFbcabruPCUdn2cY0yvp1sCsUN7C/ePYALp/FO7PDOY6WzsPb9OqUwGzQG2HuU4rvP5GLT12tT36wAMPNEcdK+UtS0SHw5ZqtKWoLeILxXuhIBV9/h/2vgQ+jqvMs46+7/tUd1fr6JbUUrfUui1Zalmy1LqsWL7t+GipW3Y7pbNbVuwYA7lYwhImIU4wZBiY3w4wuwuJYzs2JAyzv1EIDGsgbGDZ2RDILhAIq0BmNiGZieX93ntV3SX5wGRmh9+yyhdVvXr1ru//fe973/eqys3+Z3FM735QafYSBOQZkF4rdRSN4HyNvTYMDuPVhLpUH9PU1pY2atCVmSptStc6tKwvlPYdMR3BAGHfALkXr8Qt4EyA/QSZggXFYl1bXPQl1noSCsXv9CQcdnlGaeWcbs6iZFY+IiurBI9bza6cYZQWzu0OWJQhFx+oCYIbUSWj4zp3sKpk0l1elMTiu/fqdKxCrWBPvvvhQu7zpRxyIa40Mt/wV3u0XKmgEexvQCLt1DDW5qAFvQxXIqu7RH8roadKmjPaaifSU/YwQgB4JgAI2qyV3ncJBQRJgUkJ06FQuMyGJHUNt1aHw9kQZYvCZH9T6skFQqaVX1SOhmmaoZXmEofLh7g9afbawB+N7KhiaPhPYSlxunxmxaZSLhBktEOfHC4dHBosvfJXUl5VRpdppXzrZ8cqd+zYWUm/CWuUDC1UyHpOXn1d1iuLU1bw2pOI769RNqYdFNUPRw3lpo1PGSfBjTGelWdXmdCzRjfknueNk3J0G9bS7Go7KgnSsBmVLAqy3u73P3vixMW7OjZ94NkTCxdOJp4KDt65e/fxoTJuCM4nhoOM/+7vPLSl90N/e/+py3+ypff+r39s98f5jsTMx7fue3SqfdPsaWT5QWJHQYN9VITagmUWUjzD2CgzDL4DRGYOvymX6yresqd1R6QOm2h/5OE3eShgr3iLx0V+l4vmcPpZZWMoHAqJa8LRxomPZR4RDUHIRevLerkN+xKl5zZ12mOOhz/dPlDvZn627e59sZWHpCJRKHUNWzKDyXGzXL4yFWgZogR+Hgd+GqgElSZWQcPYz9ebIuZG9KJyqB0bWGNJxPzz9nZn21tI28h8xLy1gWziL74CivcDvMhZIu3mn/NQkmt7ixfKIs3ETLZJZmM4HGWvdUix6VX6WafT4WAlC+HjKntFiTdo17A7jeV13Y2HRf7B9HoO3bevztc0XO+trQia9miU/8teN5Q4/WDnlrjbqoRpyKoN2r+v7o15VkYLeHwr6Av1He5u3Lk5btIG6xKVv/S4mZfLOiLulS+5Y+jflRi4+jrzLmjpEHUvwWUTY7kQagw1GnzovWzKAJNUn1C3db7j65FHJsFwmZ/mrHVWxgoWTY9VFzs6AM2VF7EOYIcR63Ebrqvn2yKd7/C4uhXVP8db5aiyqNhLxE1ckui34lY9RObd9skHtzUcHG4yKeUMA+uQtrYv1VE73BKI9O3dv7e/uvH2k8nqsZ56A76vVqqrNo41hBM1rpr+vQf29tfQ4cH8aI3FW2LSmuwmm8+m9pX5HFXtoaqNsYrqhs2p7kR2sMrkcBvBSzRZwVfy+Dz2igZfpDMaroz3HkAWrgT0qxP0i6M24NlCyUCdzjmMMhOsLue8aQ2eJXE6tvTGc4DMUzIvunGex3fQ5IgXVuaCqgTFaY4djE6jYeUVtSXo9gRsqpVXRLeC+QWSNfvfK4Lv3l2Q+imVGTwLr1mJliMY3Z9dfZ19HexvhEoQL45jrGCHHIztgiaUMWW8RSPUJRqhC+gG2t0o2p8uqf0pLo+C5ZHY2Nc3Tn96/ODjMxtAfV0eiFTLNh9sazvQG1RZOZcvYFXSn8w/lm1tyJx+PzMrLp5XHk9lektLeyd2MzOFRZ6m9kKUxbHfBP/7GxjZEhz5mHDk8xMUZcH5F+dRyB4WgtKwEJTC+XUUdoWFsAvOr6EK4CRqE/qYgTa4Xw0kNPpkoPwSzZy3DrK/qkevJqn1SeTEK86qR5BuR5bxgY7tJyHQkhCMJnQB96s8acCKWrjIWwfr2V/xqJELqBE1auUpHprBSo59e8GnVEhsOOi0gqi0YpVrzzFypbtjaHcs9WimqXvuzJ7I1t4ml1rBWPTGcMeODYvvDyb2d7Tt7IroUDT/52a3We+u8FkSd51buO9rJ9pNnlKXweqyhAPByuDFL+26Z3ekPFKmsvoIqvKvyWeoU9RL2EOhFrOjLPrUM9kyiva23kloGzY2jAIt2kJ7EWCOxa6x0TGmLp1IM2PpsfTBXa8OnkweBA4T6vmRBteyYWOy5BItu1A70rOs6sMLWlfDchwfcQS4fz8OhLB5QHsmcdPXYcEArxWB6TGOBcYYKm1KMzoWt39y16s89DCPu9Dz0MdG1zIPvdSibhJqvnZE1bPMQ1d4bexqiMTxEfd18MD+/UhbQyHRkNjt+IhcBrPNIYJsF+MsM4pNUNGGpuKKKru+ZOyr5OdgWhy26L67t21731jk5yqdWmY2/bylz1leYlfJVQpWaSgJx739Ewn/otEiU+uVi+7aTVWVm6Juf51azlh0+orWrW1rhCkVfYJ/cNQeYc97eyObZsai0Z0f3HFAafZYwQ33zx1Ua9Ryg8viL9XrtcqKodw4/Y9cOVgp5WDHrhZvSbyvunVr3GBxm8MBf3lAqgY2qcLc+9U7WxVopTwE8+1x+RQVotqoZ/GeW6CrndZ629DGRBvaLWtDuxNtaDenDe1OtD1DvwPGJEZmY0yYhDFhEsaEvY+YMAljlxhNQmMN9mnbwl6ZoRq9pOsabASJnjOMyIeRlYQVF3vAq3Zd4214S00jVnShmud516AB1T3P48rIkMISvMYfblJIpeUsmqlQSOo5tbCPgy9oQ/vO/Wf2TfzbXZXx8YcOjt6TUNoC4PJb1J/reV9v1+4Wt71xZ3dwY6Iv7FaREEm1OLJz5J6z4/ln7u3f3MNoxW3MK5u37eoYP5novTuz0VLdUw/o7gd0z7B/C5a4kXoNo1sda+5qnmlmrRzaveXQVq41WIP2fmoQujUI9hoT2hoCa/LOhd7Iv4swEQD1ApSMNMoEIygTbB2+1uIz2YuSIbyDwZrnPyD7Exnz1zL6uzJaJiuJvRQadL12yDBrYAzq10pGhEUc+Tr75+bFLe/4jyLE6CGvBm98J0plNc/zx3AbodhLfGjQ4HqNpwwmA2NkDSXq1/gSYu1gApIgen8h5rzhDILrcDOWhZI9E3ZfecrfN7s1kR6I6WAJYBlWqW3eOZeY+fz8ho65z0wcPX2o9nPs8cWNt3eWMgwTDg7duTNq99iVBrdFbzXqtG6XtfPEpRP5L39wc2/uU7utdz8SHc60IN2+D+LFrfIYRKZB6vMI/YtdZaNlM2WsA2knwOgQ9i/xtRWff4K02SFos0PQYsczzBxVQtnJPp9dqGUX7sL5Nxh8+yX67ac1gQTURB8HnHebBrCK/2A5IiAsaDd5qOBGhS7wpBTo8tcj1w2PrcgogbFqBm2mO1UWsukLsRzSUpW1pn1DBP25VVoUi4CfcK+SRCVKum5DdVUb/MEKcAaw6GSflUTp9NsQpZMBilG6MJDrR+nXdC3pUaVVgz+qVVFiT/I56Gkrwdw56pxxspSwS0oJ6FECepSIHnUJj6hPHJGI0zmc9R6GJW8thGd4VPLvwky8jfbjeei1mLTCc6OQCW2Xhl3oODtG9137TIXs60qevbxGnr3Qbyf8fgck/f44ebKAnzHgxwt4DoP7+87F29Ce722dYaFZiX/ymzX+CwYo/Az9NhWnTOBLDA2W49Wwe7Czr7Z1oHbYPYzRISGx5FlVm/B0wgwTV8gB6PAbxd6zQ+B7Ks7zQ4PduDUDv7o5l9geiTglEOOVUGm+SYa41jY34/CbPFi0y78LMgFZWFW2mt5oW24z8gOdQavSUdMTbcv3ihJDIbfDZ1IOf2ygdU9vnal261B/+a5jA4GCCJkycCPLd++48pEb5xS1b3HHqCfWXVnfW23dOPnhYSJ19jMg9Th1CUvdSKSODl2NdPV1JHuDp2ogaa9fi1ZCLRKxFi2HWiRxLRK2Fu5fpBJIq/0I7ISmdrDaXT4gisvShkQlisa0SkLes7W4ipaX1CG7Hr9THqvht7OfIbhbVK7oQF3nyWuBfmxk713DwSK8xpGbgQkgHkJ2FPnkLwOKaGfjmxjHkq4qutJCV5npkJ4O6eiQig4p6WqWrmJov+AS+AVQ/cKa5RfWLL8Aqh8tVf6YhtbY0PMiG4LUhlZFG3qia0O42r7CaNCTkItGamQWxOlG3/EYB8vA+z4rHxE2UfYLsIoOO8Aq/ke2VujzvHEQba0wENqM3PLWCvvyhtwX52f+Yrq5Lfcfc3Bu+ZK38+joQLY36O06Opo82svRP5v+8v1Dm06dn4fzIJxPDtw93tZ48O6RwbtTbY0H7kbonVl5hP0+oFdNbaTOIvQugHkLNmsEXdMIuqYR7aBGwEeDlM5pjyBIIgiSCH5iFEHARBB2asquaW4KyuQQdsufDg16B0yjbZAUoOnCjtXqx2rErbpIqoVQPXCsSU05qloAqAv7VRKUwtdROzLdRdyUZgf2s9nvN0w8fKCytztRLtE/m91rUVYNj2ytHX9gV+WX7A07E1wnOFW9J3o697R46F8ee/aeflNpY9lKp2i1Zb9Uk6hXfby6s8o+fO8TC5s/mO6wVvXUr3xy2+6O9Ekyw5nPA7oN1P04spltokNGAVKjgKRRhNYoYG5E0FqoBCz5FDLOFMKY8gDiFQl1ZDBktHMDdjRzsZmFKF58OobhOxvBBTV8saRLsKASwAgkNwBNwXyeUahVKqev3O6ua9pQtnamVnRvaPPpg+U+nYyl2XGH36xWq1W26HDLlSevnav3NPeGjaxKo1Eb0H508OqvmSnZF6kN1IcxJlWUuaxWmI21AgS1Aka1wmytFbCqRdDonPra5bKkT7/sTNaDv31WSSbbZQRGg+ChX17CYTE0vcxDWWfCqV/mnUklqvAUrxQmmsd0uWvVEy5p5HWzUI2ZUpm4qqizL53wnTJa5Cq96n3iEv8qCrssxldb+iHssqnkarlsn6/UZFArICLawhhIRPQDJZSSqXWQIOGTZr8QPl29ijBify2PMSH6CxDNKJkK5tPoZSCc/xJg100dwc//Yt0m5JdE/P6IEcXJOrYp0p00RZbbm5I2FMZUjKhJGHMZgl86Fv/RKxb8XCaGwNFD0abIMt+eaEpW2HDkgsvjyMVzGUJYpDFxh2QrO/i7wlURNPYLfocK7+hbVSsxCRQ3xo296PW8+1hBf+xFRCy+oPmG8Am4yF6Q/ZDKUJ8TcDGgfxUgsmU3QiWg36QvAaKaItupLcnuZHs7l6xLMsndhshyU9KCVKJi5HaJKnUtx+NL+9tiyNVbijVIdgkE6NykGSppSjJaNtm024CABBgtAozK21cpWlckHjehOAS1uUrh1iCquCGiweIm1/U0UvaCyuyvijn6013+lW4J4BCyGP2V14ec/hpyfmBqq/BegcXwanO/o6LErlSokNIGTQaNgLpEGGabWa/X30gcNC2+qLBy9fqardiGNfs80Ww5I2q2ohskeJQ6hyUY6BzFCn00ftRwdP/+owbWuwX9ew+b6pEn/lSFdxvad3GmR5LDncn6ZCTCtda1Mq2jlHe5IilDorQTUYqC7CLWAc0AJ0iTiBPJ8mwaN+Xni21RraZWEGtrxShV4V3mK5J2GZamXZCmRJZdxKze6rQISh/k/e6JRWekM8ccuMHMKYqR6fE5Ie12cjblSkwizKJysFHpxLqJXZJK8sYzU9IAkuMjaMcGIjnRpw2AJ6sNI680jBzSsArFFjj6CJtwmEG/8zRZ5QKC7Q8Ith/Ob+N1ESWQ8Q+ICyUuiTNAQ9TW2oGwVu4egPBBXty2IY/thID2RUnY4U2ohQqGcrxrU9ysKTzJW7NXs2Z3ubmluGvzuNLiszt9ZsXIo9h5VdqIHJyxZF3nXZuVtgAsnBZ1wadd3LGl4/CHx5lScXG88r9HD/ZU7N7BLEij1F7mOcYld1N11JjwnkfFJfqBhFFjf8xX+gnjHHumpvJxZR5tlKAN4cJLHQmHz/4Y7zOWfoI3ztWwZ/gaZeXjPBSUvs5BY/UKXfsQA5Kgg8RdZ1yMTFm6t/3+ByJDRzptkcqQU6tgWYVGqdRUdgX7h4cGI90hrVIJ9qVRb9FrXMFHPzqaGypXaM1mjcFi0NosGlnQeSh1aJ+vTG12ga+ZBK5OKMxUOdVE7cV8qd1Nz9DoB1Fq6Q8nTObAlFvNVj7pmIt/Spdnc8L+G5Hki6/E8d6sFRdyVD7JO+Z08U/xuKCw10bkRwvvl97SVltzC3PCHTQ7jIpYqmPTvjYP132wq36sUmn02Gwek+LfVPZXljcGjDp/PFQ+EGV+qtPLFGpFd6w+Nprt6MuNRkIhOipXyVhWppKvbItGucaesvK+pmCkCfnX/cDztNxLVVBR6iR+ZhCVoX/ezGs2e0OX6F0JJ+W1PmIwqKMPcWgjy1X1MDenPu3Ki++IzBVexbUU3qgIGKyP8FBHFn2Ip2S0l4V6XNXDPDfnUp/mXfnCSyNo40v6pkVh18thX6UExT0vZtpjXXnIUrWpPtQVD2o0KkNppL6FO306PHhHbx+Yjw/JNveWNZZbGRnlcYc3Vju0Rp3VU+I26NTyh0/3zW2pruw70GzuG3JWNvoRAinmWzQj/ye8z5UgT54d9N9RJaDnuygNFaA9592mWTmS9svFp85o+8nzNO9O4FsgX8+3ERfWa1zWFskG1Jtyo8eOpKYweWx2j1GuL62LBkujdUHmpyA0GZIc41KoFAwDh4vVfn9VdcAP841nvkX9g8Iq3X/adV5jmsKjEvefpshArjuKf5CbiL4oyFle7JAtkaOHfXCgSE/sa6APfdQ01obmMvTvikQ7zGgelFB9oBE2jeFs9xx3tm2uo7kqPluVc+bwOKT7KrFX2uB/pAvObsNZvnuujTvLr66wZudE8qwstCZQX3uNoCRhu0PcNGFfA8asiMHGJq6nUmH0WO1eozLeVLqpSmTdXVbmjB+oH9jh8jbEYq4NW+ptRRTo1mR/rHbl9I2uGZcO/tvUEG2JlYTc2vKNY60ELeYuQKtGeO5fDjDtApi09O6EgSoxPBmeK3dysyJAZCcDPfjH0BjChid5SQnJvsVN0ChyD3wzdyGBWoHV5tay/koRBHdZ0B0/1NA+Vu+QsjiAWHrkGpYwMzATNoMt+CxwYwVrILzBZkM/xUT5wfqpNe5HjXNln5Dn17zBZnQ/CsZcXvYJXp6/xe2BZuazVaPzydHZgdLw8MKWwemBio8aKzZGqzdW2tB5yw72tz2zY7Xh4an+npmtNVVDUwOV/U3+ksb+muq+Rt8BNFqefpv5UxhtiGqhxolPVqdB8NupMKxFNspe82TpnKYuFpDJvbOmhYazZOj4FSDx/QssB0dpzZO8tKi84azIDC4duUkoX5CFUthhspNAnvnTYNeBjZ6a6kqnqIByg8NU6mlIdST2tnoe1Afi5RXJ2sq+yvKGgIn9bf/caERt9dlWrsjR+wkKtZxZRtMTRFRfFxu9o7eit4mLNH61Nhpo7CG6R78A/NdSfYj7c6UeyogMts6jWQrPlRrt/ll7rhiFv7Fkwczqw5olvnj/FmJvonB4osnoF2DZlau0RrvZWMKVOaRzy1UdKrMagg4lrBPfM7sMSrlCrnVV+la+sFrj+gOVTpVMpTA4gYsy5jn6CflnwR/bibmgygJhxIXJatQGZsKPubWPWWciZ5RE6y7jl9GW3nju+9ibsAdmrOHHeLc1YdU+xltnlJEzgjOBQ+dIl8SbMAtWeFXg7ChGKViG9BMKjcMfNB7avkWr1epGFMIq+xG40n6Eq/aEFDKFnGFNDpdWpZDdfoAOuXwlrvfJwYOVweF9rhKfa+X1+rhRprVgGT3HnJLbYG0lbyaqy4g74UP2wVymZqtmnbPckwVnAskCzyzyBptQQMc9KXEjUJnreBESJ9CxygdkTrnLLE69vC7T0L613qEweW02t0nR0hZMVonGo+A2xLExoIcVRAUVK9/oH4jV0rx4jX5fjr2InwtpKR1VKb6zOHdeoWZ1Sarr5ctkOTqvZhNw7eryvHxZHK34GIbeKj52WXlCdll4yrJyFrUt4+gh+X2r217EbafXtJ2+QdtDNW2t1ZG21sjKBXlFS6SqpRXaXqIYWnP1Lfol+QEwD1VUBd5JlFd4R0x9APyPvo1eOJZXJPA1Wsx/9G2pEWNDhadJa776+aoSfXVTYlGaaZW9rMRbZlcZ1O7KQKDKpVa7qgKBSreaXhD35Niv6Cw6uUJn1v1TWzDi1Wq9kWCw1q3VumuRRVu+ukw/ITuIR9hK7K+DSVMcZWfantaaqmG8WQoGa1oSre/TKDPhRW+ceFC+1E6xjTca9Gml0Wt3eE0K2qywlpd4S61KtdpR7isJOdVqZ6jEV+5Q003oyToLB+aqzqSRy8GNepfzhV1arSvs81W6NRp3JWj4Y1d/S09TPwGJVZF3eRToHXv0VYOahUgHJBb5T8g7USdYFMV4LguvIhYENh3r7Iiiv6n+WHQz/CEkPsJOMp+UL0hl5Q31m/pBVpfjWFbeBL5GsrocXyUrccVZk+OwM/coTE6LxWVUODW2oNMVtKnplQ+tyqsLsfeLwqK/I6ZW6lfnmUwUZaImqb2yfbItlJIyUk4qQIWpGKxEXVQ/NUrtog5Sh6kZapF6P43f4kxM33aE38633nmy42TlbL4mzx1Kl6dVyWHdMJXolfWa6hptjfzJfHq4t7GxdzidP8krS3bf7ioZnD+25dimE6f6TsWPTjdPe/Ye8B+wjO107GQ2dCo6NdVRQ/TYqekDOzuj0c6dB6ZPHVOGJsdLQ1TscuyyGW8kxMhmwuX4zQ80qmH5fWogE9X63saXCFGumOf3HSIWc1lpU2NDPCycrcLZKZzF+8o112vPa+8rHauvK9a0L/bHvljX2Fj3CDr8tqG+ob4cpVZa4vDfFxvq6xuYMXS84kEZzD2Fsle+VNcYj5fT9Y2N9fTz6ObK7ej4W1T6EZRiH4VDHVyt/NeGhvofwwX9GCR2otbuggP91Xis6UoSUqfr6hoZTii0ooTEL1C1/9ZY1xiFxNWr1IPMC8wb8p9CDHER7109yFxmuuU/pbzi+/H6S/SehM6mpmzyJb3eLFtyXWLuO2vOSV5OXTJdwUusTi9f4qGMS7bEi6XWvh8vWUgVxa8WHEy3xrzyxlWTXm+66g+H/B4PnTZr5F/wBX7iCPpKV35osFoNzN8EbD485u+wP5b/Asb81xSFr78FKyfi4TnMQx+spBvkv6Y2k7jky1QHvftCeX15vd4D4WpCT+mNDcYGZ9vZDo+86hJz/zmn4O4VPtcBppbxRukydoNw8aq2s7xQ4YLcWXD6Ct/hFAxLKBxlkfzRq7ewuqLXnnAOsTVOB/CPCqHIHb/9BMWYDdUDmfaO/SUGi5p1aj06bSBc52tPOkMN3vJke3nFpr3N3qZouVajcuicWltnbXOTMxwvKR/cUMGea9uzMeA1qQwmh7nHrFSajJr2Rk/Y79GZQ01DzY23NZeojFaNxmHrNci1vqaQJxRww73mQbCegvzxlyibhC9R6AfQlyj0nnNq95Ie5HjOs6SYFzz55RcRJOf1bpA03Lqg8CzxcPO6X6MUPF3yEi7zRuPkxzNfMHi9hvOTHztU/6B3w+7effu6d7X7ZYcnz2TiVhfzVZe1Kf3R21smkpVXXindfARrJJY21U4dwhpZ60b/iGVZnQadqLImNIqoU8v6K1HKnzMXIkzyuv9y3LSM7M+XqabrlZS+6V+MpFjhk0G2zCp1bsmr7w1W8ZNB9sdKk9tu9RqUv6TVRofR5DCo6ZdoWmly2ZGv5Lf2OTlwoL7J/helxe62DGqsOjXzP+VKGfwHkXTiyrMs8hFlChmk/6aQ/wOPHZowX/l7Rm/xGBVynVmPZYX1HH8vuF34XvAZeg9lBh/xgYSGMpcvoe/9luxo7umkM3RZnKGK8iXykd8SL5a6+RvkDas/8mNOVfSPb96uMqC9CaPSY/733rru/pj7QV+k1rFlONRQapFd6ZzYHF75dYGZH7ptMkOodbCposGlXHnXXtG46jeJdYgTLz7s2VMH8/fqV5QfY+qUb1IspUKOXqyhrp4N2oN9zLErDyjfnMS1vvb7Ed1xE7r03ok5cSvEKlbRO/8aJFuU0POE5I3XoYevoefX0PekpLBK6FNKh4TyN6CXEKmyhNQ6Ce0T6Mv/0qRJrybtnHZOxwn04z8k6TPX0CevoZ8VyfAT4z1SMpXegF5AZN53E1ou0DtryXKfdS/Q5FqyDdqW/3lk323/nmObQH+B6e+cc84fumKuJ1xPuC1AH3T/6g9HHrenf53W6V+APrGK/l5KXt8flGbWaZ3+uKnk2VukpZIln2MV+TGFMD27Tuu0Tuu0Tuu0ToT8+mvo4QK9vU7rtE7rtE7rtE7r9MdAAcU6rdM6rdM6rdM6rdM6rdM6rdM6rdM6rdM6rdM6rdM6rdM6rdMfATnXaZ3+/yX8XVktUwpHFiUZE85h8TelBnyF0gxlkD0ppFmqXPZXQlomKSOnXLL/IaQVknwldUz2j0JaRVXLTwlpNcUp7xbSGuYzhfJaaqfyz4W0jqpWvi2k9QaFShyngRqEMsIXdbTKUSmkaUrprBPSDKV0fUBIs5TL9SEhLZOUkVM6158JaYUkX0m1u/6DkFZRdkdMSKspk+vnQlpD31Yor6UirreEtI6yu4NCWq9k3c1C2kBVQBmWomVqGJxFPiukCc4kTXAmaYIzScskZQjOJK2Q5BOcSZrgTNIEZ5ImOJM0wZmkCc4krTe4uDYhTXD+S4qj4lQdVU+1QmoE/9rzPDVD5eBvkspDXg/+lWzyW9kpyMlCapqKwp1uigfiqDHIO0wdgXs5fJWBcwZKH4NjGkrqqSSkxiEnQy1CiVFoLQNtbKeO4xRHDUPLx6HdBdwjD6nDeCQc/M3g35meL/TBFcZcRzVAKlS4aqFqcP8paGEWynLQbwr6QW1MUHcIZQfh6gjkorsLML5cgZ/t+Neuc3gENxrPJMaBozbB9TjcQbkpjMJqHkk7MwKnHO5lAe5OYH5FdBeh7jzOWYBSaYwaB/lHcN4INQBjQuhkcb1pjGs7rp/BJTLUFPSJUE7jIyeMSCzL4fwclmkWxiJKr8gHup+HUWShZg5Q6MHcZDEn2QIfKfibghpkhISfFO6DE2SdhRZRqykoh9o6DleLkMpjOaDfUR+HNI/HNI+xQPyi32k/LCBFWs1jnkif05ijCTzSadxLDstpAEtlEnJS+HfC5zGPHD4TWWQxTwSLHNaKHLSaEvQVSWxWyBd7mYJ2eIzPrDDKaciZwr2SNnMYqeIIUI+zmBfxd+QJtmTsPNYapAlHBM1Fo0K/mY5+iz6Pr6axrEW9JpiRXogcpwW+ZjC247hkccRSjhBqd+J6hOs74DqK565UmmHc2hRu4TjGYUGYpVK8Re2bFjQZ8U/kMo+1QdTRDJY10tzZAjdkjIeFMjm4OiG0ngcuiISOFaSUwjqCZsDUKr5EyzMBI0nh/ieE/qPYuhzGskJ3rrVXG67heqegOaLmN0MrcbAcN9b0PO4zjTUR9XJHQQbFmXmtnTws6PVsoTTSXCLxaSifwbrzr2NvNesW9/8ZizsMI5mgKvEsqxLuc1Q/1ooZPLI8ELJXG6gYUBpji2pOXaM9UUHnYpA+jnXoMNYiJJvjkJuCsROMxVZJmzweAxrBJB4tsXOkrevpaA7r+SzmnaAg1kNS3YP7IJbmOEaaIJMvSFssLdqFCcF2o1legzFA5WYFrZDa6VmM67RgH0grGeE6JdjkDLYoWcwhGd04Hoco5bUSyws1iP7MX5MzWeCh5pYsAVkV0hjTvLD6kPlJ+q0p9LOWA2JFFzFOE3g+XQ+zRYHTLJ5pPJ5TZOZfiz2qQ1aWSihftUqDr986GcN7xVY6P8jqzgnrcx5LbmLVOrmWg+KquHZc7RIdQJwQXoi3INrK+YLnkcZr7zS2I6kbckp0L7VKq4g9mBGOhCuSXsDzhdinNF7HsoJtIe2gkjy2/jfWUWLFpwXJFFsXZ0hW4lUcwfYuK+CMrLoe28uMwIPoYYgor9bqGiyZFE6nKdG/Wmvn1s6EyjV2IYPt9CL2KLJY+kiqKchDCB2GEuK9mNDmwTW2s0qYvUVrUfQGxNH8PqvTLa4GXMmaNobFNjhfQZuPQh6Rk6g1xDvhhVWkqN03W+FErbzxKockd1th5uQkvgiRN9GCjNAXsdjTgtxrMM/zwuoj+hXELzosyFnUY6JXs4K/Q3qYwX53CvMpakqKKq7ya+3Z/wVZFBBKYd4RblnB1qeFuToh+NrTeKzSNTOLvfEc1k1hjDeWLaS3rV7nQdpVEozSkghBOh9uuT2qGNWIpa9v3WrWWDcR+7W1eRwVZNfwLY6r6IMVZ01xJRJlWEOJ0RmKwsTrjERDZnH8xWN9OyJZYcmox/FYMsJKtVCQpdSWEBnGBInn8CzhC2MQ5/VqXbp1VKUrPOFSutKs1ukiEosYx6n3KEdxNVjA0SVBJiMZQRofUZ9FXI5CiQnJ2pG/iT0mlj+NORBXvA2rrDjxxo7h9PW87mm8RoirjDQ+E9eJ69mU1bVy2FYQWY0LfF9/zU3dQKLzBe5zWEuncetkFl0b+b5XDRDXtyS1Gd8dpfrgaheslmM4ZwDyOLCiY3BnJ1z1Qm4v5IShxDbhfhhLahdeh5JQbgde40gbY3DcAtd7sI3rozh8ja6GoPwWaAvV3Uztxn1shta24ZJjuO0RyB2G82ahHKrRAzk74Bql+7EVJP1tgVokhhgQ1kQy0u2QzxU4XD2qAdyjOLIRuBqD9pPC3W5oewC3h8aP+u/D6S2FcfYJI+3GGKGWUZs9MKJhfIVyd8D5Nii3DfffjXkmo92CeeiD+4SXzXgEqOeowCsph/DZKdxBMkLjGwYqctWNMUji0RTx64HzbTBy1H4/3N2OV4hRqNmLOd2G0dssYIa4HcZXRa6IpHowNwhVhEEvpEfgr7+A3Rg+krGMSVpbjd0ufL9YivDXLRx7MHKj+IpIowdfbceyQndrBFmOYT7W9roLa+JmXKobc7ytoCF9WHvJ6EXtJH2MSkZC+kOylY5F1GruJnOEtCLe3yFI+lpcEOrdGBM0rm2Fnm/UMszNv+TidfWt3Eh2Yn4mNzOZ53pm5mdn5lP57Mx0lOvmeW4se/hIPseNZXKZ+WOZdFSfzIzPZxa50dnM9PbjsxluOHV8ZiHP8TOHsxPcxMzs8XlUg0Mt1zVwIXRqqeHGUvzsES6Zmp6YmbgDcgdnjkxzyYV0DvWz/Ug2x/HSdiZn5rlN2XE+O5HiOaFHKDMDnXK5mYX5iQyHhruYms9wC9PpzDyXP5LhRga2c8PZicx0LtPO5TIZLjM1nkmnM2mOJ7lcOpObmM/OIvZwH+lMPpXlc9GeFJ8dn8+iPlLc1Aw0CP2kpnPQynx2kptMTWX549xiNn+Eyy2M5/kMNz8D/WanD8OgoGg+MwU1p9MAwPx0Zj4X5Qby3GQmlV+Yz+S4+Qxwkc1DHxO5Gi43lQJcJ1KzkEZVphb4fHYWmpxemMrMQ8lcJo8byHGz8zMgDTRaaJ3nZxa5IwAul52aTU3kuew0l0dYw8igCvA4DX3NTHLj2cO4YdJRPnNnHipn78hEOYHNcI6bSk0f5yYWQKRk3Ai+aQB5PgW8zGdzCNFMaopbmEXdQIuHISeXPQHF8zPA0DHEUooDAUyRvpDyTBxJzcPAMvPRsczhhf/TzpfHQ7X//8+ZfbEVSiIjCtnOWKJNJgZTtsaeirFPmNEYa9uYJEqlUrSivduCtKcQlcotablaaVEJkTZF+b7PGTS63Xu7f9zH5/d7PHofzLzf5/V+PV+v1/u1nDPvM6K4wgG/mtgPPRHxB0tvYCJkCcabmJkPMr1IyA0JjeYKIxE90CUd8MxwYPEYZDhYANTn80JjTZzjgvW5sQZgFemOQoFAFCESxcRONDUNEQTHmkT3zzQBE0xFSTGCcCE3JiLJlBsE/AwhBZRRccHc2DABHxgcUH0Di42LiYniAcdBzpnQ/QRxwGJJ9DjgQiLEWZFhxBDBYGlFoUb0EF5sDHBg6YLGCHngbDAgCQWvXLCMocJonkgE2AUloVr1uyMwFfAbgbD/TRiCYPRn3YEfhMQFi4wQd4wHc42QOf0AYH0SInjBETKSJQBQHj84Kg74/jfpBXzgKfo8A2lYyJADDn8nrTSKgK+DdY8VCXnBUofsB0D9sJ/XJNQC+jyAAmICSSVCJHJCBAn8KAE3ZLD1uFJTAc8C6oDlQ97EiWJAFggJRdREaCJCo2IGWxTkJeC7UnJkQXhonETwgngiJD/JewKRwwRItCAi95naiB7EjQWyCvgDmaJ/EfT7fCGUb5LAi+TFhIbwuCYCYbgp0jMFlAF9OcUALC/qFmgMIGx+nAR/lLzq+iicEYqbiJnnCYBOiGlALEWBxIaae3CaREw5KFHKy7sjixOLBg/QG5ggFMwCjg0sE2JEDxOCpIeECAjEcKAzYmNgK7CiYDpdEASSHR8xChdN1P1+9vNaIAJxY2MFwTwu4h8gzkDK4ou40nzKiwKW0Uc4DtKW7tGXqW8aoBKFoNlQug4/pEPzLDIs425Gfe6GSN9/OooH/FSKjfASSisVQECDCNHQCMnlvDDkNRQ1SEwcUCg2Ag1YwDooDgneWGSwz0uAhqZA8dhQJEULYnjSjPqXokoDHkBKg6bP0qgQCRGC6L/REQmDOCEfCBOKMggRgByKyjIvNFjU72Df/Bg4fwgPDbyJUhcHaSw+VKbg8gUiJGSkyZzXF8ZST+k7FRuB1IOg0EGRy5VRVIjAx4qAM/HAEg1Unr8zABJvTiy6h5uDpw+Tw6KzPejuHDdvtj3Lnq7H9AB9PSO6D9vTyc3Lkw4oOExXTz+6mwOd6epHn8F2tTeis3zdOSwPD7obh852cXdms8AY29XO2cue7epInwbmubqBus4GkQiYerrREcA+VmyWB8LMhcWxcwJd5jS2M9vTz4juwPZ0RXg6AKZMujuT48m283JmcujuXhx3Nw8WgLcHbF3Zrg4cgMJyYbl6gpLrCsboLG/QoXs4MZ2dUSimF5Ceg8pn5+bux2E7OnnSndyc7VlgcBoLSMac5sySQgGl7JyZbBcjuj3ThenIQme5AS4clKxPOh8nFjoE8Jjgx86T7eaKqGHn5urJAV0joCXHc2CqD9uDZURnctgeiEEcOG6APWJOMMMNZQLmubKkXBBT0wetCCBB+l4erG+y2LOYzoCXBzJZlthE/te2wK9tgX9h21/bAv/dtgAV/f21NfD/59aAdPV+bQ/82h74tT3wa3vg+2z+a4tg8BZBv3V+bRP82ib4tU3w/9w2AYhN6XcNMJheNUwa5kcN2/dEPgbSB68R6JP9f9fUcDlychCggbJ+ll5eHqXv+ll6RUWEHhv4s/RKSih99c/SDxmC0OPgn6VXVgb04BWDfEMBj9Ljwa8KRg38HQvMbI9RB2bXw8zFWEBKGCakjnGGRmH8oDmYEEiAmQ/FYRZD8ZgMaBEmG8rA5EGZmIPQZswJ6BimEjcdcw3ni7kPuD8G3Jq/w2n7AY4pwJkMcNgAxxPgBAGcaICTDHDSAc56gLMd4OwHOMcBTgXAuQZw7gKcF4A7wvP9YBzoiQyOAsDRADjmAIcJcNwAjj/AmQdw4gFOKsBZD3D2AJwjAOccwPkd4NwFOC8AzlucL4TF5UAUwHfoYBzsOxkcRYAzCuBYARwHgOMFcLgAZz7AWQRwVgKcLQDnMMA5DXAuApzbAOcxwGkHON0AhwZwhgKckYNx8IoyOEpoyvQBN6dzMTMAjj/AiQA4SQAnDeBsADh7AM4ZgFMNcG4DnCaA0wkdgyDcdEgB4GgBnLEAx3QwDsFGBkcT4JgAnBkAZzbAiQY4CwDOKoCzBeAcAjhlAOcOwHkGcDqhTAgHbYaGABxtgGMKcJgAxwngcJC4JBMhMrkjPRW09A4yHiITO8Ri8CMWk8kQmVpZuRu0TZvIBORMeno6cgolC8wS29KVsgKJeIhIiEEmxCBEJDI5EZClJxIJEJEUk94lFieSIYiMF2PEaJN2+hqRDBGpxy9ngIbSF1Ujc/umgoawJJIQXASYiIOI+EZ0IgmPIeFtO2xBg1FyhCQ3QoY5RgyBhhPjcBCZkJ+f/zeKUiAyrUJcId4BjmxwpIMD1eUvFSZKFaYQIApQuF9j5ERgVgdiCVmNKRBEGdD436qMWLeoHBUTjyHjbf+ssyx7GaUpiNIUEkShdKVKkJbahYoLFkTchYpFhShy5aAV2BbYrkOPTHBQiBCF3AWsJCVCpsSkIyqR02NIBIhERHri9BgqEaKS8Xi8KBPQZopIRIhETkxN7RGLF0ol6tNeTIUg6jf1xSQKRJIrwdSgVpYe6NyTVcjSpPbzAS2ROjBedRJdc4jUZwsxBY+hEPqMYQujk9A5mSIqhKUSBswhxkIQFqDj8RCVmAUalQxRqT2SFLRJeqgEiPrNJGIqDaLKlweWBwLb5a+lr6WvAEcqOFBtEatIzYJOQwwRqNRvF1KfXWhEiIbY5Z8NQ4Mgmoxh/nPL0CAsrd8yg01DQ01DI0M0alea1DaStC5Ukx6EuEcqrzxEUyxXK1fL18/Xz3LKckL8bxl5GVlCppEgmtTPpPZBpyamisW2MLBFaiISfCRre+SUvbUcCZKjYEGb6ID4pcNENDSt7RET2VtL3aXfRmJwGSAnayQxmQaRFU6VX0SXpf8gkyAy5WQV6ucStGNtj7y1t6Z9O4OaCg3lPlOhy0i0te1CbWVrjU6U8nCYKAdh5YgDqIPMJUdCzCVHheTkvmIqQeIol2kV4krxVwyq41ek/1U6LKcAySk1ajRqdEyuNaqPqo+qdq6pqcq8lFkpVyknR4bkqD0XKysrL/ZIqZHpk8PKyxsTNRSIxJpEJJDJyABoYZPlyZA8FQfapPBKpIVPopBBoE8Ou3gRwAVNlsdC8vjycgxmQKq+EZlGkYMoig8aX8AXBx0II+qD55XShvYmh6HvwybLyZx7/gDhgWSH+sY+jjQCcKTAwK5AabNGJ/cxCp8kj8XKE7/BA9EQFyCUlxOIkDy5Bmky10nIdSI2JIof3vfeJFb63ht5zxRyg4zoTGE034hulySMMqI7hgoi0b9C8FcYCt4ju5JGdGeuiP/vqFEZIFQO8KuZh9ZetGnmwBLN9UTKuDSntI/yEAmbL9FMBUOIYzBoMIVIMFTAYdUJGJhLpBoSITwkscJC+HwPeCZsJDOisWOUWAMzGT3c0PtnAfqJFvJ5iw1ywNoyzPAqO3GLDtz2POrdrVW2cVLh3uCZ3rqL8iVqXrAEXwlLcAfycVgIi1U2ByJeTBSPh+LUeUJU4Iuw/IC0EAHIlYCKifPCE5WxXh4MZXgI0iErU324sRE8frhIwGcowQrIIEmZxAkNiRbwQxijYA1khKqs+sNHgRjasBZyHqes9u28Jy861NhDxI2OobvbMeFRw+UZ4+EJsBXDytLa0nwW6FrLdOGUkv9EMnmYhpynKeNd3Nw5DD14jLQ7im/Hi0EeEbD3YNFZHq4THSzNrI3NraysjK2ZVuMZY2AdqUYaP9TIQ/qgBSyBRstaGCJgcBJIEQPGqVgJuJo/RNMZue9Kur7K+KeVEXOIqfpxzOVD923db4ENLDjkcJwqf3D3TXkH1svC7RpvY+f2CnqO5xpv+DBSJ/3DzJIXW3y8v7hc3WF5qol7NVwFO9y+K0PVMd+YugZTeHV5+fSQy9bnHmcavqpMMz9uWK5e9ElvMxGOsW4oVa4SX58emDv/6eNKwYmsiY5PlGgHhOmzF+vaKdz5ba+2Rfq9gwlZTY8VF64fnqazasTNS/Mv7v5Q5G6UN6tmVhF0KVtSBXWrYkNb+eeGY4yXE9aumLvKKpOSdy6skR99uzF/+v1H2duTF90dFlYOjTN10/s8q6nrjWaLAv5DJGuUyqLykI33a0/1OlybVxarhcWBONopgSjAIgRYE5hUUwE/DK9yq+yDWVE6Q/H5iOw3NmWMz/5YRQrqQ5o6eDV4mFhFx6LrLschhtpm2x3fXWJYVGlZogh7IgRaeBd4BszOd8xnpdn1PZsRLIz67oGemEgeMmra92hMrOnAMiKriC4i8EoTQAL7EskgMAkEEgThneHpsFN/H8amTe4DSEhI+BFAqPBvOItgZUTeMXg5mNrPEkf+LiBxiJfk+mMetO90WvnMfUJ4tm65YM0524YJe4xcMoz2+dmYUefV9Mwejs+F3ep65XYsezTmPH4i+aPrM6jkEd8u1LVxigkrxiCuzo3nNiyx5NoCm/YRB12KD8eZcXQJOVn1Tvde2ndncYf5zf292NBrQx5ndkU5rEd6fcdZL6mk8uN0S/kRLjsZFx7cVB+9So9iYWt1bbuTxoq4FXbb6g08j+6zilLZXp0YdWLEb8sTd1qFnIPWtT60XRIwRMkzmzDr3pIS/RlDt1tIVprqB1opvQlXvyWJvd9g1t1gvvOpraV2qZW/WYTgar3hS4gbvDYn/fmrjiJs4aePs3saUiotFh+d+XCkViun9TMsIUIgjTXLpLGq5oyu5BT35l40jVXJWo0G0tji/yRZ6MNjpUGvJXs+JJTuwQtHH4wBC4s8EclAs5kVbM1gmMHgsJBms29dWPSfyNd3HvcX5/8xG6WvOKlbSVqzWZyk2jM2sEeYbvT53c6c9I0OJ3ZeDcgwnWhuMmpt4ueF+7Uk0LHkq+qluCsOLRc2fezGa3Yuo/aO5hd0hk+5oKfWpK/1Hp/NDG59elo1s015s+Uj6xhPwaTWQywKzK44twbeJHc1/vLH2A3DEm6sPJN9ibyM3jZqn+Wb+ecbRZgZK+oerG25k/h11edDgelTzp7SOhyUU3YhtTjr8J1Cw5ue3Zb3fp+/7vmo3tb5kVeXkONFjUoznW69wVQ7Oe8kWTb5yX9ZuLX6+ayny97f2ayotXrPs9ThFXeu5GlCl7447VVeZ56j7WTWdV53B+bIOY8rS/kG/int1nzx2zOtyrSW/mwkBhZZKE03Y5B0M1CZncGNWX+k4mTS1dU7QanXAye86g0/P7uu+syBE5XKuTAHOT0ED3LRLkeY9X2lsYDNkC5B2dDMHIYZZobB1rBFkGUo19hiQpCFsYWZubWxtfl4M+MQa0tGGNfMzNIiLHhQCnTihzS5E25KfhtuZTX6WPS+K3HYDX+dAn+YoQQxsWgWBO4C/Bh4MXBgxH8DkD/GsJUxbI2mQK5MCvSCwdWKTApk/SNAfxb8GwgRLIcIrgxBvXgsjPkunHESLIQhDtO673PevVrHbcfMxD/aur78fvZ2+ZtPI73bPKp5joTbVVdbn/Rs8t8QMMRav5zAUm7cnJReGnbg/pkWrJfOiSk6iczow11vMLOyN63QqKFsqN2sYQ/v3z3s0mlH//eGFivz1vhaVbpqFI6+ovR7vURpv2XH4dHVa3T3pKxs0NN4FqaZYWPS64NzqeAvzTdrOVpi6u49h1ismlmtGXwiVu7pneSxiuM2svaaLbXZaOPDTtDJ+FqsdGlFE1l15gXDWQz/CfM27tuVHrlRX/Cm6vCrs6zhNUGuKcc81R1X5+6OLufrXezS06puo++nFb+5Rtuc/WTeNt7SgvF/RNO/LrvdW3kyZzzl6xSVilyV/eVpNe2SigNeunZqx5yWJabVfqrbNnXEXZWMF6vyInTTIybtvyR2HfuCrO0c/GXrelUX82PegW5/TD9lvbrX5GFxwC67yMuJ14vPRK5ZGrVc+Nur3d15D9XvTOgJuRxtQ25auLT4UOnO0wuub/Telex7dahjUJ12e8/kKgbto6lNyG4rQaD71BP2WW75tJXnFvt+uBS+nHt/e25VdeZVgePjcpPstuIPRXB06zz2vuaN8dVnyVVfJ70/HGtFPOJ9fcStM++zryzX6BTPg9yOj0yJLbnpP3rqRF+1hvTX4VXsvaYPxqycMre21cJ+rWbpWrl4iU17Vb1xAR672ulT+0PsddwOUARIoAi0S4sAlTsswgLN/RrfX8IGoOmUSlk3NmN9p1EINGIYDngjYwQ8fNAgZcBZgRsaSvOm7re8yREIQPIErssL4wVzRaF0ZpwoQiDkiZKQ5A5bwRawOcPM0hyeAJK7GQPtmsNI9393Df1P+T2vIKq44b7TunELI01GPD775OmFTTN13A9de6jmqqv4+sbeG86HRDB9SAvptucGVXb2yGnrDufOhsfew0S+XHC2NYOk+FEBn9uRUaN11Vx3+bbOd+EaRj0LXqRrvnrhurOgQsfjyqrPrOuU2rmFtUXT8Ds+7YlaH/6H/gMHj6K02iZ9BxO9g2luXhy5Zzij7nlZWTB/+Vs/eNvnxXdySl5q5yzuqlN+Sz7hEc05ysrKc8JMdwwbomcQti/n2U1iyvQdn1L3DnFUoUjyUtu8Er9CmzXdycswSrBD24lHOg5nqow98wpHJTIZCTVbGiYtXV/AxR7TlC/u+bjlCHRt9AzP3k+EyvN0Wn9+PwAsshdWHMg4BBgHXmTy+Q+vLpH0ramIxwP/S4OViJS+mqAKISMYOCVXmptTsuCUVWIVhYOSQFtvvZymMco94x5TPTb4PdtVELyL+5+7p0Qp6dCwgun5uw85x/q+IymbhMLu0qLAhkEdyrfLZ6ZN/fnr4oHTyBPySCpHC4KnTEFwgh1ge5mCYP1vrokRPeykXH/yehjYWilnReVsnP34h81HDyXcv5Y00wUqNhHN94+WUz5w7dyCNSdNbg3dkRkddNIHe9WVruy+6WGy7ROfM4W+mzUea0JpB88kdq6sbZ0EvX5ybg2VUL3K6UmHh+pDtwPrnr1YNe+2uOJ5difRdBmuee043dEx3R96niVuMpH/SHoSU6rmum11JFW44WTBhK3hxhdmKrwKmj11WO5K+tQnJHWzTzWM6fGMKYZCWvWrmCm9y6jKDeep3NUdf5wc3uK6cskFS8O5O8taShfRpi245SHUfg1fOZMYOtsfGk5VUai7p5L7fvKpMN8SY9MXn5al1cz0frktJjvq4ATnWx+Syn5TSw4yaN+xxcCCmKAedHnKqGgtSQftktGZ63YlTZ9aFx17umufyPKk64X5OkPHxtMmczLnz3KwUyktKSlyCa/Om9YrTtIWb1eFw15OGzpXvXr7aO1au2bD5jPvnGqMbtWbiZ3HjnPSDZj1yrt9z6NN265MFJxN0RMRh7yO1y7bIqnQ8zxePG9KRkE89yi/QHlP2W+OHUMFX1aYRR352jCzOlPnctjZbZrLh4ZgpxgX+q05+Uy76VjRleCjiZ6EW0wT94PZRbsTD5Tkb4xTv7tuuXLcaFOzfWR+vn/mmLL89tQr2ndaRrld3vya3fgRChVk0BZV86qf81/tzbnGMOhVuOA/u95lZEH9Z9PtU028hkVeVt75BZaQkmEJIai/FChk1aGlAPf9bUBK+n+Sis1gWBqQBj8TkN/uCBigbFibwZYTpEVjPNplwEj3f37HIsH+uXZgkdqBBbUDxNyBjs9CJQ2TQ/X83yRKLhanO4/7audNGzkusnmW+28nidbqePbpJZVyox5aRV4cWk/rsD6/iVhUPeE2pMKYdjNDPilk+eLsQN2owu3src0Rc+satngcoRpVFt7db3g4mVL4x0a/K4HqhOaw+JdmnLFDTV8cILtfL7E/Mae+ygQXdyDi7dXotxNnFwx753C60TrkID/EMnFPfrCi8U3b9V1PH5Hkb89O2s02eCF/Ll854Vz2lPbup4azlLRcvPV3JAsbh048wZ5b39Zmt3bp3QVHFqSNvGtTnDnnZYZbqnpnganfs6xJxofNfS+csPlqdrMEN6X4SOE668V128RG712912pbjqmcwA9Z4nF6q+KhETqpV9+dxqWt+hjQUcspy8xeXlquLRoToKZ/vEZP33pM7oTp468vLF53WENn7/6wVq7WvMf67G0B6U/GzLmpPcOGU3XMZ6ouruNGsr/pbZ2nMXMUZzoklHRhHpcexEoC7perlpwdectrxosJBYrNOuxStZP2C1nPKiqFyY3CF7oNZQ6bLrSf1/C5v3RVqwsb3ntgdUOrf15hz8OisCcVOSkL2u60zXjBNtirrL9n76Jw8fMVQYkBR0xT//DZOrssQV//TVt0pf4aozW2Vm4Vj5fZZ1RRnC/c2m1nKtrwkd+VSPc1Up4TuGGzjZt56r2i9OGPtru+21hU6pAflVvXeCc9c6B2toHa2fyD8veteP7wvmTEwAQVLF5uFBXjgT4YZIdhDq6rfyrKsnc8QuOJWEaW3SkVguvjV3svMW7oZFjAs6TFDfkI1S3fJX9GGvtffegD4hZELQjWgZuSANg8wMwMLXNzZcocB3aHXWXK3LSfK3N/w18Ep+QhwtPxKTlwSjacsnbASCY4OGUpPLUfDgsNM/+n2yzkW2tAM140V5gUHBNrEiGKhm0HGGBhi1FmdE2MMwb5R1nIM1gB6DNY0mf2kkAvtu9pwtCBZypN6Jo/uhEL70zbndvomaRucrNeFD56C23jkMfB6zZN27ioLkkuqyI0wMTIpqtSeCN66ddzU19Sr0wqc9y/8y3vfnDZaMvdOXNCU7MWrXRw96qXW7ewTn2GxtvJ01Zyaou+RD61IZkYbHk+ZeTuW8c0E7InPGkOuWw/JTFZ563yoj1ZoqWr3l0di3UYd36F0pld+wlyW9oiPkeYbMgfN3VcpC87WIvC48/K3fhs6bvyNW8dDB/1TKo9a9nOH3O4qVCvrfbhW4XCTfo5uS4KU2id5Iw7WpVmak86Lhhf899+lD2BepF6/uKhw01H7t5XTZ/J8rU2m6+nvqT4nV7XI6OJdF7uEb+MCL5g7wlRpS2BuAcap28jmarsEkYrL3F5/3jNEg2B6iLW3vgm23GhOyvncILSKjWDx+ekNdx729U5rGCz3uPfd+fUvp4TzHzqT9q63IaYQLxBLI7TUjnH5R7reHBxJP5cA/OSgv7rR6GmrTkfCmZvrMfcKXA46/c2ZzdlhpPSJrFWLcbgQvGW3VNZCaMsL9bt2JGXnDz6s9MGrQPdjjri99u7yiJPzMh50hKXqN76ympTktqM3jslOhFxzws/96xsoYlf8SYV9sBteOfVDQ1x0cFrp9zY5u3qVib2GV2QOMRMO7mdSS2e2r2vZtecioL0LT7zvV2dWOXTLm+J96eKnSK/JOVVnI2OnneZE6ssn+z+O0OCL4Il+INYCIJTNvyvC9ePPw78tjmSn1KFJJ8+J6bgGHKyOy9Aim89GkMBlj2rCut8m4hngNT2Jdt+7+rON3dShjYYnI3OSj3eov4IDpGZIsfwhj3zx4n1f/hVD88///etgrFi3b+MbM+Bb53Sv6vNeAmE8XBcvWfp8e2CWXrE+4y5HNMzJTNJUxkKmsmHExw9Z5dZWShaKd30CNP1It7jrFV9mbt5GE/ob3S45JmJgdIYBQdqN2/5Oseoi+tCZtw/vwLfENHOSPvj0dErh9a2rdozc4kgcT+EL/1SeuJUdXPblwvLMfdenNkWsrNu0qWoSwHdzd2nVWtzrKPaDImd7Y7LhyTWavb6TPr9ie8o75eX0slDz++J2rS1qbvcILRr8mTcQaejo5nJ2ntLn6vUZNl1+49sc4tXY/72Zb+T4opJXifnnS/dY/YwWOnceN/VBJOpGllzdqx68VI942V27u9JH2xaNCIlCvOgK6XeYyN2yWs1jPWsn2Hkr72iQILVB5cnut/WiMiQYFXB0BDUNVf/z27Ef7zTJuOTc2A1WZekfdsxhAD4wBkCQxH94Hg8w9KMgbRZf/JIu+bUSdvd9S+1jM1U5d8qj9Dccjzpu1smxFcYrspLsBk+OA2/6TmiFurS6Qbm6gaX5ry997Tz9cID2Vt0XpqFD22Re3Lv9irXMfPG7mzYLJ67ybhu/NxQlf13nxYuHhb9ijm8VvSwV9BOKZi2vXP6/CXjOLO2a73Glhizs+21b73+RCNxW7ySFpOTFufEKAfkh/rrE7TCLh2pDtt26zX3ETPe8cSXR/eavki+NgX7XT/99EiOPK+qbv6GN+/j7U81ViXd+Hpt10laHoPg0eR88swpLa85BW9Tm9c9WlVaREtpUd5mM35e5NaaOcwbzbtu399Z8vLefblFyr7104xu8c/8YTAptWWafPlS0szHE98e8HM+siIeai88b9AZt3sFY8KDVfaY/wMuL97LDQplbmRzdHJlYW0NCmVuZG9iag0KMjAgMCBvYmoNCjw8L1R5cGUvTWV0YWRhdGEvU3VidHlwZS9YTUwvTGVuZ3RoIDMwODc+Pg0Kc3RyZWFtDQo8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/Pjx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IjMuMS03MDEiPgo8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPgo8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiAgeG1sbnM6cGRmPSJodHRwOi8vbnMuYWRvYmUuY29tL3BkZi8xLjMvIj4KPHBkZjpQcm9kdWNlcj5NaWNyb3NvZnTCriBXb3JkIGZvciBPZmZpY2UgMzY1PC9wZGY6UHJvZHVjZXI+PC9yZGY6RGVzY3JpcHRpb24+CjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiICB4bWxuczpkYz0iaHR0cDovL3B1cmwub3JnL2RjL2VsZW1lbnRzLzEuMS8iPgo8ZGM6Y3JlYXRvcj48cmRmOlNlcT48cmRmOmxpPkF1ZHVuIFdhbmdlbnN0ZWVuPC9yZGY6bGk+PC9yZGY6U2VxPjwvZGM6Y3JlYXRvcj48L3JkZjpEZXNjcmlwdGlvbj4KPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgIHhtbG5zOnhtcD0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLyI+Cjx4bXA6Q3JlYXRvclRvb2w+TWljcm9zb2Z0wq4gV29yZCBmb3IgT2ZmaWNlIDM2NTwveG1wOkNyZWF0b3JUb29sPjx4bXA6Q3JlYXRlRGF0ZT4yMDIwLTAyLTExVDEwOjQzOjA5KzAxOjAwPC94bXA6Q3JlYXRlRGF0ZT48eG1wOk1vZGlmeURhdGU+MjAyMC0wMi0xMVQxMDo0MzowOSswMTowMDwveG1wOk1vZGlmeURhdGU+PC9yZGY6RGVzY3JpcHRpb24+CjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiICB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyI+Cjx4bXBNTTpEb2N1bWVudElEPnV1aWQ6MDhEOUY0MjUtMjVCOS00QTNELTk0RjItNDU1NTBCM0REMDU2PC94bXBNTTpEb2N1bWVudElEPjx4bXBNTTpJbnN0YW5jZUlEPnV1aWQ6MDhEOUY0MjUtMjVCOS00QTNELTk0RjItNDU1NTBCM0REMDU2PC94bXBNTTpJbnN0YW5jZUlEPjwvcmRmOkRlc2NyaXB0aW9uPgogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKPC9yZGY6UkRGPjwveDp4bXBtZXRhPjw/eHBhY2tldCBlbmQ9InciPz4NCmVuZHN0cmVhbQ0KZW5kb2JqDQoyMSAwIG9iag0KPDwvRGlzcGxheURvY1RpdGxlIHRydWU+Pg0KZW5kb2JqDQoyMiAwIG9iag0KPDwvVHlwZS9YUmVmL1NpemUgMjIvV1sgMSA0IDJdIC9Sb290IDEgMCBSL0luZm8gOSAwIFIvSURbPDI1RjREOTA4QjkyNTNENEE5NEYyNDU1NTBCM0REMDU2PjwyNUY0RDkwOEI5MjUzRDRBOTRGMjQ1NTUwQjNERDA1Nj5dIC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDg2Pj4NCnN0cmVhbQ0KeJwty7sVQFAQhOG5Tw6RUC3a0sBNdSGgAMU4RyLUxrVmbLBfMj9gV6uzPwAfu7iJe0joxEHiKk6SesAz9yKIKJJw4l9m6/LIvNlIu5D5ImUCXqb/CtoNCmVuZHN0cmVhbQ0KZW5kb2JqDQp4cmVmDQowIDIzDQowMDAwMDAwMDEwIDY1NTM1IGYNCjAwMDAwMDAwMTcgMDAwMDAgbg0KMDAwMDAwMDE2NiAwMDAwMCBuDQowMDAwMDAwMjIyIDAwMDAwIG4NCjAwMDAwMDA0ODYgMDAwMDAgbg0KMDAwMDAwMDc3OCAwMDAwMCBuDQowMDAwMDAwOTQ2IDAwMDAwIG4NCjAwMDAwMDExODUgMDAwMDAgbg0KMDAwMDAwMTIzOCAwMDAwMCBuDQowMDAwMDAxMjkxIDAwMDAwIG4NCjAwMDAwMDAwMTEgNjU1MzUgZg0KMDAwMDAwMDAxMiA2NTUzNSBmDQowMDAwMDAwMDEzIDY1NTM1IGYNCjAwMDAwMDAwMTQgNjU1MzUgZg0KMDAwMDAwMDAxNSA2NTUzNSBmDQowMDAwMDAwMDE2IDY1NTM1IGYNCjAwMDAwMDAwMTcgNjU1MzUgZg0KMDAwMDAwMDAwMCA2NTUzNSBmDQowMDAwMDAxOTU3IDAwMDAwIG4NCjAwMDAwMDIxODYgMDAwMDAgbg0KMDAwMDAyOTkxMyAwMDAwMCBuDQowMDAwMDMzMDgzIDAwMDAwIG4NCjAwMDAwMzMxMjggMDAwMDAgbg0KdHJhaWxlcg0KPDwvU2l6ZSAyMy9Sb290IDEgMCBSL0luZm8gOSAwIFIvSURbPDI1RjREOTA4QjkyNTNENEE5NEYyNDU1NTBCM0REMDU2PjwyNUY0RDkwOEI5MjUzRDRBOTRGMjQ1NTUwQjNERDA1Nj5dID4+DQpzdGFydHhyZWYNCjMzNDEzDQolJUVPRg0KeHJlZg0KMCAwDQp0cmFpbGVyDQo8PC9TaXplIDIzL1Jvb3QgMSAwIFIvSW5mbyA5IDAgUi9JRFs8MjVGNEQ5MDhCOTI1M0Q0QTk0RjI0NTU1MEIzREQwNTY+PDI1RjREOTA4QjkyNTNENEE5NEYyNDU1NTBCM0REMDU2Pl0gL1ByZXYgMzM0MTMvWFJlZlN0bSAzMzEyOD4+DQpzdGFydHhyZWYNCjM0MDI5DQolJUVPRg==",
    "mimeType" : "application/pdf"
  }
}'

5.4.4. View document session

POST /hosting/api/v1/session/view-document
Description

Creates a session to view a signed document.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CreateSessionViewDocumentRequest

Responses
HTTP Code Description Schema

200

OK

CreateSessionResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Hosting_ext

Example HTTP request
POST /hosting/api/v1/session/view-document HTTP/1.1
Content-Type: application/json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiaG9zdGluZ1NpZ24iXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.aIJR6RJ63Szm5zbSe-bdCNCkJo5mXMwfyl1IjSOxdZl9g3b-ZZxYUF1N5oWN3Bp_PBJdDUSgB7aqk4x3eMyzXcpv0soWBQpjLKyx-vqHZY4XOmZBlZBbFEHs9eMerOQ2WA6zjhrc5dhgNYWMBH6gyTt8tMZ0va_ljWJ2NnTcqev3vMlN8ZhdtLVsSU5IirQ--nmlirvgI8w5uIccdEOLKORIkrjrgWCNFtYX4e4rFKStGYOR8WT5LqWgGLFzNKWejmm5uEpDLdSK31GGdv9CBYB4-HDx071ChcEnynwZOrJK2IBb7dvxcbVyO8ZsRSJEbbo-5WaXYETQbRqZIlDt3g
Accept: application/json
Content-Length: 59
Host: api.aerahost.com

{
  "documentId" : "e2486781-0791-4b1e-81fb-d2c21399cf9e"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 385

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T06:31:01.623Z"
  },
  "sessionExpirationTime" : "2018-05-03T07:30Z",
  "sessionId" : "ac10efb9-c9fe-46f3-ad6d-5afe6d55c407",
  "url" : "https://foo.bar/hosting/identity-providers/documents/view/kontraktsnummer1001215646541321241123123123123132version20190201.txt?sid=ac10efb9-c9fe-46f3-ad6d-5afe6d55c407"
}
Example Curl request
$ curl 'https://api.aerahost.com/hosting/api/v1/session/view-document' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiaG9zdGluZ1NpZ24iXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.aIJR6RJ63Szm5zbSe-bdCNCkJo5mXMwfyl1IjSOxdZl9g3b-ZZxYUF1N5oWN3Bp_PBJdDUSgB7aqk4x3eMyzXcpv0soWBQpjLKyx-vqHZY4XOmZBlZBbFEHs9eMerOQ2WA6zjhrc5dhgNYWMBH6gyTt8tMZ0va_ljWJ2NnTcqev3vMlN8ZhdtLVsSU5IirQ--nmlirvgI8w5uIccdEOLKORIkrjrgWCNFtYX4e4rFKStGYOR8WT5LqWgGLFzNKWejmm5uEpDLdSK31GGdv9CBYB4-HDx071ChcEnynwZOrJK2IBb7dvxcbVyO8ZsRSJEbbo-5WaXYETQbRqZIlDt3g' \
    -H 'Accept: application/json' \
    -d '{
  "documentId" : "e2486781-0791-4b1e-81fb-d2c21399cf9e"
}'

5.4.5. Verify Authentication Session

GET /hosting/api/v1/verify/token/{authenticationToken}
Description

Verify an authentication based on an authenticationToken (only once per token)

Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

authenticationToken
required

The Authentication Token returned after successful Authentication.

string
Responses
HTTP Code Description Schema

200

OK

UserInfoResponse
Produces

  • application/json

Tags

  • Hosting_ext

Example HTTP request
GET /hosting/api/v1/verify/token/3YmTlstNKXMfLRiSkmim HTTP/1.1
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiNjc3YTBiYjYtNDVmZS00N2Y4LTgwODEtZmFlYTA0ODIxZjA0Iiwic2NvcGUiOlsiaG9zdGluZ0F1dGgiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.lpWLzD1w4Gns8uuVjqA5fInQKtirFeRFHCvx88tjAaR8Y82W7tnqAQCsl6jZV_U5rZSMoni69tJ5BkMVkLULGeuEOCeaeRisXOy9lTzjoBnmAlN44SoPeeGZO_U0Q6I5YWU12EFH1IAEMKf-hiJ7B0A6r9aNgWNBIlWqlgf3NfPnO3ZteMG3y3gMhJUgM0hwsNFUDzS9T0bgb4j87EQ16I1OHN4BtOsI30nBlUSZoZvWCTEIxGsu_joNY_8iAhqJfT2d9qxNJf3797YtneQ0YhcL9CdfgBLsSlCz0bFZkFki2gqS7KZGvTl2LuEmRFfVodSp0r9-InOPaorBsbgS8Q
Accept: application/json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 602

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T06:31:17.540Z"
  },
  "name" : "Test Aera",
  "birthdate" : "2020-01-17",
  "https://aera.id/claims/idp" : "nbid-oidc",
  "https://aera.id/claims/id_issuer_country" : "NO",
  "sub" : "219ec1d5-268e-4bbe-9b4c-26e7d6324588",
  "https://aera.id/claims/nin" : "17012099479",
  "https://aera.id/claims/nin_alias" : "fd3ef496-e25c-45c0-894a-7e3fdddb9a4c",
  "https://aera.id/claims/nin_type" : "NIN_NO_FNR",
  "https://aera.id/claims/identifier_value" : "9578-6000-4-1408007",
  "https://aera.id/claims/identifier_type" : "PID"
}
Example Curl request
$ curl 'https://api.aerahost.com/hosting/api/v1/verify/token/3YmTlstNKXMfLRiSkmim' -i -X GET \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiNjc3YTBiYjYtNDVmZS00N2Y4LTgwODEtZmFlYTA0ODIxZjA0Iiwic2NvcGUiOlsiaG9zdGluZ0F1dGgiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.lpWLzD1w4Gns8uuVjqA5fInQKtirFeRFHCvx88tjAaR8Y82W7tnqAQCsl6jZV_U5rZSMoni69tJ5BkMVkLULGeuEOCeaeRisXOy9lTzjoBnmAlN44SoPeeGZO_U0Q6I5YWU12EFH1IAEMKf-hiJ7B0A6r9aNgWNBIlWqlgf3NfPnO3ZteMG3y3gMhJUgM0hwsNFUDzS9T0bgb4j87EQ16I1OHN4BtOsI30nBlUSZoZvWCTEIxGsu_joNY_8iAhqJfT2d9qxNJf3797YtneQ0YhcL9CdfgBLsSlCz0bFZkFki2gqS7KZGvTl2LuEmRFfVodSp0r9-InOPaorBsbgS8Q' \
    -H 'Accept: application/json'

5.4.6. OIDC Public Keys Endpoint

GET /hosting/oidc/.well-known/jwks.json
Description

Returns the public keys used to validate the idToken ('use'='sig') or to perform JWE encryption ('use'='enc')

Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string
Responses
HTTP Code Description Schema

200

OK

< string, object > map
Produces

  • application/jwk-set+json

  • application/json

Tags

  • Hosting_ext

Example HTTP request
GET /hosting/oidc/.well-known/jwks.json HTTP/1.1
Origin: https://foobar.com
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: Access-Control-Allow-Origin
Content-Type: application/jwk-set+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1361

{
  "keys" : [ {
    "kty" : "RSA",
    "e" : "AQAB",
    "use" : "sig",
    "kid" : "7I9ECzKAti05VZbs8VoMYwYI3E_wHc7wtaW6zBvgPpA",
    "alg" : "RS256",
    "n" : "wZiGx_GKrQuhBJqR_4zTcyYid3tK2PA4tXkOnkZ4Onc2xqXflZYqyMnQdc9pDJvteTS8t0vOCcToh9WxYLbWbPKUQAv2WCRqZDMkQPw532Igcy8pVvC91MrxhAmSTz1XbNDwZGrfMmv4gvUVANQ9qPj58DgZIvxhTm3ZVfrsipTXmsj7v3Y-PJmDfHQgxYvUHZap8U8iGK5o6WGS3bvLAIorZsxcChejOwbIpM9L3E2LnWb5cgOe3x2AckiD9wLL4Qo5gw01J2MOdZT6EuZoTDAF8c31zZqVLBdcY3jxrq2ywCkvJB9iuiffc-P79IpXVwRAg93ujXpSCT0bQakL6Q"
  }, {
    "kty" : "RSA",
    "e" : "AQAB",
    "use" : "enc",
    "kid" : "uzq938ilHzrzidNGbMzFHD9Ig_qG44E689M429TJeg8",
    "alg" : "RSA-OAEP-256",
    "n" : "0qg64V_qG-Tu93r4v5H5NqmLh927oCWllQhAQGrqy5P0iVsSs5Q3q0DUR4bDpj6_Q_DGp-OX_-wJxDXY8u0Ya3pP2aNOXpYv9GeTsAzyhi5HYEd-HjOTX53ngxgAeDqcGq_9nTFpYRZjcJpH4NdgIDmySE-822ZtAVhZNuw2fbC4vjhptMR3_qB7f-4TsvH5zL7bgMGVKS5tPw1y4MM5XixijKeu9_iIoRJFPItJsZ-RwGX6K36qI_wXas4chBlLcWnTdSd3NmXP0gu8dDchia_FIK3G_ph1gcGqt8aE4JoVMPAt_g2Zab-7rIbBeY4Wg7XHtHXf-rcVTnZitt-HIBcCXKKQOhCOQoUg_retEbhTutcDeWxKAGAs-5lbkug4WYWefiYqLA0GhcpZB2vYnYutUwPQm-K8xzePAb-HP21bGv_pEfnR7rYvXX76Xes4fyGLDpD2aU-eHQMQvTxsUv5xE--xCUtwzOZG4DcfdQygO8g6v8Ni8IeSRBAdLLXHdmEW7cy7Hp39ia8pVfti9cTS1xE2F4K89EJIifxK1vYJ7RSnllisBT5kZzF2nqmASqtL046f_V7EOFvndS4iLYepvmno5oD_uRw4IF2_01tALq3dbnShY4yGBdxtu8PtjlYxpqG6iTv1eRGVa5jETZZgn6cWhZ6_PPQj4m5zfsM"
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/hosting/oidc/.well-known/jwks.json' -i -X GET \
    -H 'Origin: https://foobar.com'

5.4.7. OIDC Configuration Endpoint

GET /hosting/oidc/.well-known/openid-configuration
Description

Returns the supported OIDC configuration

Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string
Responses
HTTP Code Description Schema

200

OK

OpenidConfiguration
Produces

  • application/json

Tags

  • Hosting_ext

Example HTTP request
GET /hosting/oidc/.well-known/openid-configuration HTTP/1.1
Accept: application/json
Origin: https://foobar.com
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: Access-Control-Allow-Origin
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1327

{
  "issuer" : "https://api.aerahost.com/hosting/oidc",
  "authorization_endpoint" : "https://api.aerahost.com/hosting/oidc/authorize",
  "token_endpoint" : "https://api.aerahost.com/hosting/oidc/token",
  "userinfo_endpoint" : "https://api.aerahost.com/hosting/oidc/userinfo",
  "jwks_uri" : "https://api.aerahost.com/hosting/oidc/.well-known/jwks.json",
  "scopes_supported" : [ "profile", "https://aera.id/scopes/sign_sid", "https://aera.id/scopes/nin_alias", "https://aera.id/scopes/proof", "https://aera.id/scopes/nin", "https://aera.id/scopes/altsub", "openid" ],
  "response_types_supported" : [ "code" ],
  "response_modes_supported" : [ "query" ],
  "token_endpoint_auth_methods_supported" : [ "client_secret_basic", "client_secret_post" ],
  "grant_types_supported" : [ "authorization_code" ],
  "acr_values_supported" : [ "https://aera.id/identity-providers/itsme", "https://aera.id/identity-providers/nbid-substantial", "https://aera.id/identity-providers/nbid-oidc", "https://aera.id/identity-providers/freja-eid", "https://aera.id/identity-providers/aera-webauth", "https://aera.id/identity-providers/aera-basic" ],
  "subject_types_supported" : [ "pairwise" ],
  "code_challenge_methods_supported" : [ "S256" ],
  "id_token_signing_alg_values_supported" : [ "RS256" ],
  "ui_locales_supported" : [ "en", "no" ]
}
Example Curl request
$ curl 'https://api.aerahost.com/hosting/oidc/.well-known/openid-configuration' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Origin: https://foobar.com'

5.4.8. OIDC Authorization Endpoint

GET /hosting/oidc/authorize
Description

The Authorization Endpoint performs Authentication of the End-User. This is done by sending the User Agent to the Authorization Server’s Authorization Endpoint for Authentication and Authorization, using request parameters defined by OAuth 2.0 and additional parameters and parameter values defined by OpenID Connect.

Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Query

acr_values
optional

OPTIONAL. Requested Authentication Context Class Reference values.
Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request.

string

Query

client_id
required

OAuth 2.0 Client Identifier valid at the Authorization Server.

string (uuid)

Query

code_challenge
optional

Hashed (SHA256) opaque value used to mitigate CSRF and code injection attacks amongst other (PKCE is defined in RFC7636). Must match sha256('code_verifier') in token request.

string

Query

code_challenge_method
optional

Method used to derive the code_challenge for PKCE.

enum (S256)

Query

login_hint
optional

OPTIONAL. Hint about an identifier of the end-user (e.g. the National Identity Number).

string

Query

nonce
optional

OPTIONAL. String value used to associate a Client session with an ID Token, and to mitigate replay attacks. The client must compare the nonce in the ID Token to the one sent in the authorization request and only proceeds if they match.

string

Query

redirect_uri
required

Redirection URI to which the response will be sent. MUST be pre-registered.

string

Query

response_type
required

OAuth 2.0 Response Type value that determines the authorization processing flow to be used, including what parameters are returned from the endpoints used. When using the Authorization Code Flow, this value is 'code'.

enum (code)

Query

scope
required

OpenID Connect requests MUST contain the 'openid' scope value. Scopes MUST be space delimited if more than one.

string

Query

state
required

Opaque value used to maintain state between the request and the callback. Used to protect against CSRF.

string

Query

tbs
optional

OPTIONAL. To Be Signed (TBS) data.
Must be base64 encoded. Required with scope 'sign_sid'

string

Query

ui_locales
optional

OPTIONAL. Locale for UI. If not set, the device local will be used.

enum (en, no)
Responses
HTTP Code Description Schema

302

Found

RedirectView
Produces

  • application/json

Tags

  • Hosting_ext

Example HTTP request
GET /hosting/oidc/authorize?scope=openid+profile+https%3A%2F%2Faera.id%2Fscopes%2Faltsub+https%3A%2F%2Faera.id%2Fscopes%2Fnin+https%3A%2F%2Faera.id%2Fscopes%2Fnin_alias+https%3A%2F%2Faera.id%2Fscopes%2Fproof&response_type=code&client_id=b27bca3d-21da-4dcb-9421-0da9fb7e75e6&redirect_uri=https%3A%2F%2Fmerchant-domain.com%2Fcallback&code_challenge=E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM&code_challenge_method=S256&state=856ed956-9991-4d07-98d2-95129fd19f37&nonce=jNSgDSGH9PTfrPehz0S80hI2Lq9uY2epYBKUrvL869dqnfCwAC&acr_values=https%3A%2F%2Faera.id%2Fidentity-providers%2Fnbid-oidc+https%3A%2F%2Faera.id%2Fidentity-providers%2Faera-webauth+https%3A%2F%2Faera.id%2Fidentity-providers%2Faera-basic+https%3A%2F%2Faera.id%2Fidentity-providers%2Ffreja-eid&ui_locales=no&login_hint=17012099479 HTTP/1.1
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 302 Found
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Language: en
Location: https://foo.bar/hosting/init?sid=9bb4caf7-905e-4402-a6e9-0b7544922242&sk=e9a8eedc-04bc-4edc-ab47-7a11b1bb638e
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Example Curl request
$ curl 'https://api.aerahost.com/hosting/oidc/authorize?scope=openid+profile+https%3A%2F%2Faera.id%2Fscopes%2Faltsub+https%3A%2F%2Faera.id%2Fscopes%2Fnin+https%3A%2F%2Faera.id%2Fscopes%2Fnin_alias+https%3A%2F%2Faera.id%2Fscopes%2Fproof&response_type=code&client_id=b27bca3d-21da-4dcb-9421-0da9fb7e75e6&redirect_uri=https%3A%2F%2Fmerchant-domain.com%2Fcallback&code_challenge=E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM&code_challenge_method=S256&state=856ed956-9991-4d07-98d2-95129fd19f37&nonce=jNSgDSGH9PTfrPehz0S80hI2Lq9uY2epYBKUrvL869dqnfCwAC&acr_values=https%3A%2F%2Faera.id%2Fidentity-providers%2Fnbid-oidc+https%3A%2F%2Faera.id%2Fidentity-providers%2Faera-webauth+https%3A%2F%2Faera.id%2Fidentity-providers%2Faera-basic+https%3A%2F%2Faera.id%2Fidentity-providers%2Ffreja-eid&ui_locales=no&login_hint=17012099479' -i -X GET

5.4.9. OIDC Token Endpoint

POST /hosting/oidc/token
Description

To obtain an Access Token and an ID Token, the RP (Client) sends a Token Request to the Token Endpoint to obtain a Token Response, when using the Authorization Code Flow.

Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
optional

The Basic Authorization needed for client to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
optional

The x-api-key header needed to get access to the API services.

string

FormData

clientId
optional

OAuth 2.0 Client Identifier valid at the Authorization Server.

string

FormData

clientSecret
optional

OAuth 2.0 Client Secret matching the Client Identifier.

string

FormData

code
required

Authorization Code that was issued to the authenticated Client.

string

FormData

codeVerifier
optional

Original value of 'code_challenge' before it was hashed and encoded. See PKCE as defined in RFC7636.

string

FormData

grantType
required

Only supports grant_type 'authorization_code'.

object

FormData

redirectUri
required

Redirection URI used in authorization request.

string
Responses
HTTP Code Description Schema

200

OK

TokenResponse
Consumes

  • application/x-www-form-urlencoded

Produces

  • application/json

Tags

  • Hosting_ext

Example HTTP request
POST /hosting/oidc/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: application/json
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Basic YjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2OlZlcnlTZWNyZXRQYXNzd29yZA==
Host: api.aerahost.com
Content-Length: 171

grant_type=authorization_code&code=NfoVEc0JDHMthMaCXQoc&redirect_uri=https%3A%2F%2Fmerchant-domain.com%2Fcallback&code_verifier=dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 2631

{
  "access_token" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImF1dGhvcml6YXRpb25fY29kZSIsInNjb3BlIjpbImh0dHBzOi8vYWVyYS5pZC9zY29wZXMvbmluX2FsaWFzIiwib3BlbmlkIiwicHJvZmlsZSIsImh0dHBzOi8vYWVyYS5pZC9zY29wZXMvcHJvb2YiLCJodHRwczovL2FlcmEuaWQvc2NvcGVzL25pbiIsImh0dHBzOi8vYWVyYS5pZC9zY29wZXMvYWx0c3ViIl0sInN1YiI6IjIxOWVjMWQ1LTI2OGUtNGJiZS05YjRjLTI2ZTdkNjMyNDU4OCIsImlzcyI6Imh0dHBzOi8vYXBpLmFlcmFob3N0LmNvbS9ob3N0aW5nL29pZGMiLCJhdWQiOlsiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Il0sIm5iZiI6MTc1NTA2NjY4NCwiaWF0IjoxNzU1MDY2Njg0LCJleHAiOjE3NTUwNjc1ODQsImp0aSI6IjliYjRjYWY3LTkwNWUtNDQwMi1hNmU5LTBiNzU0NDkyMjI0MiJ9.guQ7SrksP36zaJm2X35hULa1382R3lA069hYtIPE2QmZp6dVun1AiT9qR6jIWB-y6Nlc26MFaHkvXUivyX4Za05fjsBd1maL1JhVM_WkDNlvCrqnV5tpuwLma6nRou4smH_6se9_2QbD-7MwgUf1sekx6go0tT_Q1TfeFAyfUayNNprMBrDWIBZbzQTA8vkpTkyycDluYlydJhl00N8wEOrQc_dkXgi_YsUw7tXoEjohrfT1EoVTIba-e1Rm2ytikJeytopKy-5O6Hf-67gic6Pklybkmoh_Y5iXXxTcAdNdt0-n3i8DE0J4Dlv8uyTsq9k8jLBMuHBgLEFUd9o1-A",
  "token_type" : "Bearer",
  "expires_in" : 900,
  "id_token" : "eyJraWQiOiI3STlFQ3pLQXRpMDVWWmJzOFZvTVl3WUkzRV93SGM3d3RhVzZ6QnZnUHBBIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIyMTllYzFkNS0yNjhlLTRiYmUtOWI0Yy0yNmU3ZDYzMjQ1ODgiLCJpc3MiOiJodHRwczovL2FwaS5hZXJhaG9zdC5jb20vaG9zdGluZy9vaWRjIiwiYXVkIjpbImIyN2JjYTNkLTIxZGEtNGRjYi05NDIxLTBkYTlmYjdlNzVlNiJdLCJuYmYiOjE3NTUwNjY2ODQsImlhdCI6MTc1NTA2NjY4NCwiZXhwIjoxNzU1MDY3NTg0LCJqdGkiOiJjZDY3ZTNjNy1lNjA2LTRmZjgtOWMwMy1kYzAxZTc1NGE4NzciLCJhY3IiOiJodHRwczovL2FlcmEuaWQvaWRlbnRpdHktcHJvdmlkZXJzL25iaWQtb2lkYyIsImFtciI6WyJuYmlkLW9pZGMiXSwiYXRfaGFzaCI6InRwc0lzSS1CUzdpaHpsVExBcnNxSHciLCJjX2hhc2giOiJrMGtFSnJlYkJtWDRaQ08xVmNlbEV3IiwiaHR0cHM6Ly9hZXJhLmlkL2NsYWltcy9pZHAiOiJuYmlkLW9pZGMiLCJodHRwczovL2FlcmEuaWQvY2xhaW1zL2lkX2lzc3Vlcl9jb3VudHJ5IjoiTk8iLCJub25jZSI6ImpOU2dEU0dIOVBUZnJQZWh6MFM4MGhJMkxxOXVZMmVwWUJLVXJ2TDg2OWRxbmZDd0FDIiwibmFtZSI6IlRlc3QgQWVyYSIsImJpcnRoZGF0ZSI6IjIwMjAtMDEtMTciLCJodHRwczovL2FlcmEuaWQvY2xhaW1zL2lkZW50aWZpZXJfdmFsdWUiOiI5NTc4LTYwMDAtNC0xNDA4MDA3IiwiaHR0cHM6Ly9hZXJhLmlkL2NsYWltcy9pZGVudGlmaWVyX3R5cGUiOiJQSUQiLCJodHRwczovL2FlcmEuaWQvY2xhaW1zL25pbiI6IjE3MDEyMDk5NDc5IiwiaHR0cHM6Ly9hZXJhLmlkL2NsYWltcy9uaW5fdHlwZSI6Ik5JTl9OT19GTlIiLCJodHRwczovL2FlcmEuaWQvY2xhaW1zL25pbl9hbGlhcyI6ImZkM2VmNDk2LWUyNWMtNDVjMC04OTRhLTdlM2ZkZGRiOWE0YyJ9.UezkYRUTk0JHYB4ynpqAoVA0M-E0eUr9YUUNqCiDStXeQuyZSxCRqGu0wq-gJ0_6sGTGi-fhAtWhv0_K79vbmDRw44aA5Xli8jca-VKVv3Um4dmZRe8ZTAXIO2cv0Vm0NARaoo5Yf-1x4aXhyFAqTiOb0ELB4hHHXrMiVCFsGDkRi-F1rhrpypa8UDViY0NTsGi-6uP3WV4IRhutwJe06vCMFfMrrocGdLjtqGdNonbCeoVCsPVDP0ZWmlXWHqffReM92HjOZOZvLJR6Wo_X11nVwtbmryG0gKX-xnya6ETZVzoFlD-qqRfExI6TTEmm_ljIYV16cglLPeC29ICkoA"
}
Example Curl request
$ curl 'https://api.aerahost.com/hosting/oidc/token' -i -u 'b27bca3d-21da-4dcb-9421-0da9fb7e75e6:VerySecretPassword' -X POST \
    -H 'Accept: application/json' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -d 'grant_type=authorization_code&code=NfoVEc0JDHMthMaCXQoc&redirect_uri=https%3A%2F%2Fmerchant-domain.com%2Fcallback&code_verifier=dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk'

5.4.10. OIDC User Info Endpoint

GET /hosting/oidc/userinfo
Description

The UserInfo Endpoint is an OAuth 2.0 Protected Resource that returns Claims about the authenticated End-User. To obtain the requested Claims about the End-User, the Client makes a request to the UserInfo Endpoint using an Access Token obtained through OpenID Connect Authentication.

Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string
Responses
HTTP Code Description Schema

200

OK

UserInfoResponse
Produces

  • application/json

Tags

  • Hosting_ext

Example HTTP request
GET /hosting/oidc/userinfo HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImF1dGhvcml6YXRpb25fY29kZSIsInNjb3BlIjpbIm9wZW5pZCJdLCJzdWIiOiIyMTllYzFkNS0yNjhlLTRiYmUtOWI0Yy0yNmU3ZDYzMjQ1ODgiLCJpc3MiOiJodHRwczovL2FwaS5hZXJhaG9zdC5jb20vaG9zdGluZy9vaWRjIiwiYXVkIjpbIjY3N2EwYmI2LTQ1ZmUtNDdmOC04MDgxLWZhZWEwNDgyMWYwNCJdLCJuYmYiOjE3NTUwNjY2ODYsImlhdCI6MTc1NTA2NjY4NiwiZXhwIjoxNzU1MDY3NTg2LCJqdGkiOiJlYzdhZmQxZS0wMDliLTRjNzMtYWIxNy1mODNkNTIyNDY2ZjYifQ.eRqpbC5papGAD5CVeqExYiwC6jjC9XLI6Av0EjZO6465LltMjPJ52MJV4BSFYzA4yehvTu1OexcXTiiAEvyDoRDk7C31F_JnFXvV0SPNkXMnj2dnUKks55o448MCJ2Uh__5fvhADoyNcwOnXe-B5OH8qnRlfc75be0u2HpvOA1AqJRHX1GAIv825Ga0Ynje-nR63Y9fFMyB-FhPSk9hXRvt1ZivajgQJCr5iVuntRpW0umyHaTr5ah2u7DIiL3tMOdMuWeuSgiyxKMynDfomRjnygan0T6RDNc6nzVVkZKEjUIQ-BI6oWjB48AgOK-_OgYGS-JBWLAcfcG0LmlD-nw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 151

{
  "https://aera.id/claims/idp" : "nbid-oidc",
  "https://aera.id/claims/id_issuer_country" : "NO",
  "sub" : "219ec1d5-268e-4bbe-9b4c-26e7d6324588"
}
Example Curl request
$ curl 'https://api.aerahost.com/hosting/oidc/userinfo' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImF1dGhvcml6YXRpb25fY29kZSIsInNjb3BlIjpbIm9wZW5pZCJdLCJzdWIiOiIyMTllYzFkNS0yNjhlLTRiYmUtOWI0Yy0yNmU3ZDYzMjQ1ODgiLCJpc3MiOiJodHRwczovL2FwaS5hZXJhaG9zdC5jb20vaG9zdGluZy9vaWRjIiwiYXVkIjpbIjY3N2EwYmI2LTQ1ZmUtNDdmOC04MDgxLWZhZWEwNDgyMWYwNCJdLCJuYmYiOjE3NTUwNjY2ODYsImlhdCI6MTc1NTA2NjY4NiwiZXhwIjoxNzU1MDY3NTg2LCJqdGkiOiJlYzdhZmQxZS0wMDliLTRjNzMtYWIxNy1mODNkNTIyNDY2ZjYifQ.eRqpbC5papGAD5CVeqExYiwC6jjC9XLI6Av0EjZO6465LltMjPJ52MJV4BSFYzA4yehvTu1OexcXTiiAEvyDoRDk7C31F_JnFXvV0SPNkXMnj2dnUKks55o448MCJ2Uh__5fvhADoyNcwOnXe-B5OH8qnRlfc75be0u2HpvOA1AqJRHX1GAIv825Ga0Ynje-nR63Y9fFMyB-FhPSk9hXRvt1ZivajgQJCr5iVuntRpW0umyHaTr5ah2u7DIiL3tMOdMuWeuSgiyxKMynDfomRjnygan0T6RDNc6nzVVkZKEjUIQ-BI6oWjB48AgOK-_OgYGS-JBWLAcfcG0LmlD-nw'

5.5. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

5.5.1. CreateSessionHostingRequest

Name Description Schema

identifiers
optional

Set of identifiers (identifierdescription and identifierType) to be used in the module.

< ModuleIdentifier > array

identityProviders
optional

Filter to reduce the list of identity providers (IDP) shown when starting authenticate/sign module.
If only 1, the chosen identity provider will start automatically.
If no value is set, all IDPs will be shown.

< enum (nbid-oidc, nbid-substantial, aera-basic, aera-webauth, freja-eid, itsme) > array

redirectUri
optional

Redirection URI to which the response will be sent. MUST be pre-registered.
Length : 8 - 100

string

scope
optional

What consumer profile data that is requested ('openid' is n/a here).
Example : [ "profile", "https://aera.id/scopes/nin_alias" ]

< enum (openid, profile, https://aera.id/scopes/altsub, https://aera.id/scopes/nin, https://aera.id/scopes/nin_alias, https://aera.id/scopes/proof, https://aera.id/scopes/sign_sid) > array

state
optional

Opaque value used to maintain state between the request and the callback. Used to protect against CSRF. Required when redirectUri is set
Length : 10 - 128

string

uiLocales
optional

Locale for displayed text.
If not set, the Consumer’s OS specific locale will be used.

enum (en, no)

5.5.2. CreateSessionResponse

Name Description Schema

responseInfo
optional

ResponseInfo

sessionExpirationTime
optional

Session expiration time.

string

sessionId
optional

The session id identifying the session.

string (uuid)

url
optional

The URL to the User Interface.

string

5.5.3. CreateSessionSignRequest

Name Description Schema

dataToSign
required

DataToSign

identifiers
optional

Set of identifiers (identifierdescription and identifierType) to be used in the module.

< ModuleIdentifier > array

identityProviders
optional

Filter to reduce the list of identity providers (IDP) shown when starting authenticate/sign module.
If only 1, the chosen identity provider will start automatically.
If no value is set, all IDPs will be shown.

< enum (nbid-oidc, nbid-substantial, aera-basic, aera-webauth, freja-eid, itsme) > array

redirectUri
optional

Redirection URI to which the response will be sent. MUST be pre-registered.
Length : 8 - 100

string

scope
optional

What consumer profile data that is requested ('openid' is n/a here).
Example : [ "profile", "https://aera.id/scopes/nin_alias" ]

< enum (openid, profile, https://aera.id/scopes/altsub, https://aera.id/scopes/nin, https://aera.id/scopes/nin_alias, https://aera.id/scopes/proof, https://aera.id/scopes/sign_sid) > array

state
optional

Opaque value used to maintain state between the request and the callback. Used to protect against CSRF. Required when redirectUri is set
Length : 10 - 128

string

uiLocales
optional

Locale for displayed text.
If not set, the Consumer’s OS specific locale will be used.

enum (en, no)

5.5.4. CreateSessionViewDocumentRequest

Name Description Schema

documentId
required

The ID of the earlier signed document.

string (uuid)

5.5.5. DataToSign

The document/text to be signed.
Mandatory if Module = 'sign'. Not relevant for other Modules.

Name Description Schema

contract
required

The contract to be signed. Must be Base64 encoded using UTF-8.
Minimum length : 1

string

description
required

A short description of the data to be signed (max 68 characters).
E.g. 'Document 1234567890, version 10.1'.
Will be concatenated with message digest of contract on BankID Mobil.
Length : 0 - 68

string

mimeType
required

The MimeType of the contract.

enum (text/plain, application/pdf, application/vnd.seid-sdo+json)

5.5.6. ModuleIdentifier

Set of identifiers (identifierdescription and identifierType) to be used in the module.

Name Description Schema

identifierType
required

The type of the Identifier.

enum (EMAIL, MOBILE_NUMBER, NIN)

identifierValue
required

The description of the Identifier.
Length : 1 - 255

string

5.5.7. OpenidConfiguration

Name Schema

acr_values_supported
optional

< string > array

authorization_endpoint
optional

string

code_challenge_methods_supported
optional

< string > array

grant_types_supported
optional

< enum (authorization_code) > array

id_token_signing_alg_values_supported
optional

< string > array

issuer
optional

string

jwks_uri
optional

string

response_modes_supported
optional

< string > array

response_types_supported
optional

< enum (code) > array

scopes_supported
optional

< enum (openid, profile, https://aera.id/scopes/altsub, https://aera.id/scopes/nin, https://aera.id/scopes/nin_alias, https://aera.id/scopes/proof, https://aera.id/scopes/sign_sid) > array

subject_types_supported
optional

< string > array

token_endpoint
optional

string

token_endpoint_auth_methods_supported
optional

< string > array

ui_locales_supported
optional

< enum (en, no) > array

userinfo_endpoint
optional

string

5.5.8. ResponseInfo

Info object that can provide specific messages

Name Description Schema

externalResponseCode
optional

Additional response code from external systems.

string

message
optional

Specific response message

string

responseCode
required

Minimum length : 1

string

timeStamp
required

Timestamp. Mandatory
Minimum length : 1
Example : "2021-12-21T10:23:19.279Z"

string

5.5.9. TokenResponse

Name Description Schema

access_token
optional

The access token.

string

expires_in
optional

Seconds until the Access token expires.

integer (int64)

id_token
optional

The ID Token.

string

token_type
optional

The token type.

enum (Bearer)

5.5.10. UserInfoResponse

Name Description Schema

birthdate
optional

The Date of Birth (DOB) of the Authenticated Identity.
The DOB is formatted as a ISO 8601 Date (yyyy-MM-dd).

string (date)

documentId
optional

The ID of the Document that just has been signed. Only SIGN.

string (uuid)

documentUrl
optional

The URL to the document that just has been signed. Only SIGN.

string

email
optional

E-mail.

string

https://aera.id/claims/id_issuer_country
required

The country of the issued digital identity.

enum (AF, AL, DZ, AA, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CK, CR, HR, CU, CW, CY, CZ, CI, KP, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FM, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IQ, IE, IR, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, KR, MD, RO, RU, RW, RE, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TH, CD, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, TZ, UM, US, XX, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, AX)

https://aera.id/claims/identifier_type
optional

The IdentifierType for the unique user id for the IdentityProviderType.

enum (PAY_CARD, PAY_ACCOUNT, EMAIL, MOBILE_NUMBER, ADDITIONAL_ID, WALLET_REF, ACCOUNT_NUMBER, LOYALTY, SSN, SSN_ALIAS, PID, FREJA_EID, ID_DOCUMENT_SN, HASH)

https://aera.id/claims/identifier_value
optional

The unique user id for the IdentityProviderType. Of type IdentifierType.

string

https://aera.id/claims/idp
required

The identity provider (IDP) used during the authentication/signing process.

enum (nbid-oidc, nbid-substantial, aera-basic, aera-webauth, freja-eid, itsme)

https://aera.id/claims/nin
optional

National Identity Number.

string

https://aera.id/claims/nin_alias
optional

An alias for the National Identity Number.

string (uuid)

https://aera.id/claims/nin_type
optional

Type of National Identity Number.

string

https://aera.id/claims/proof
optional

The proof data of the authentication/signing.

string

name
optional

Given name and family name. Should be 'givenName + space + familyName', but there is no guarantee.
Example : "Kari Nordmann"

string

responseInfo
optional

ResponseInfo

sub
required

Subject - unique pairwise identifier for the subject.

string (uuid)

6. Identity Modules

Service paths and model definition for the Identity Modules.

6.1. What is Identity Modules - Introduction

Identity Modules is an application that can be included into Clients, such as websites (Iframes) and mobile applications (WebViews), or redirected to. The Identity Modules API provides create session end-points which consume credentials, identifiers, etc, and returns an URL that the Client can access. The client opens a Single Page Application utilizing Aera’s other services including full payment wallet administration, authentication and signing.

6.1.1. Browser support

Identity-Modules support most browser, e.g. Chrome, Firefox, Safari, Opera and Edge.

Can I use on <Browser>?

Browser / Mobile OS Version Comments

Chrome

Latest

Edge

Version 16

Firefox

Latest

Opera

Latest

Safari

Latest

iOS

Latest

Safari is being used

Android

Latest

Recommended to use Chrome or Stock

There may be graceful degradation on some older versions. All functions will be there, but may have poorer user experience.

6.1.2. Sequence diagram with an example on how to create a session

Create Session
Figure 9. Creates a Session to utilize Identity Modules

6.1.3. WebView and iFrame postMessages

Identity Modules is used within browser iFrames or Android/IOS WebViews. Communication between parent client
and the iFrame/WebView is done through postMessages.

All postMessages are prefixed with "ID_OUT" and some of them has a colon following a certain value. The postMessages are always sent as a string. The following is a list of generic supported postMessages (see each module for specific messages).

  • ID_OUT_HEIGHT:<height>

    • The current height of the application

  • ID_OUT_ERROR:<Error Object>

    • If an error occurs, the error object will be stringified and sent out

6.1.4. Custom Styling

CSS styles in Identity Modules can be manipulated by merchant developers. To do so, simply upload your .css file to
a location with an URL, and reference it in the API call:
* "customStylingUrl": "https://my-domain.com/styling/my-custom-styling.css",

In the coming example, we use a custom .css file in the API request to change the primary color in Identity Modules.
This is done by overriding CSS root variables, which has been used extensively in the application. These can be easily
overridden to change all colors with one line.

Here’s an example of a custom-styling.css: https://static.aerahost.com/view/custom-styling.css

Table 1. Image Screenshots from the ewallet
Default Styling Custom Styling example
Wallet Overview Default Styling
Wallet Overview Custom Styling

6.2. id.Hosting (deprecated)

id.Hosting consists:
* id.Authenticate: use your favorite Identity Provider (IDP) to identify an end-user
* id.Sign: sign a text or PDF document (also support PAdES for certain IDPs)
* id.Archive: signed documents will be stored in id.Archive, and can be viewed using the view module

6.2.1. id.Authenticate

The Authenticate module provides a list of Identity Providers to choose between, and will guide the end user through an authentication process. The authentication can later be verified by calling the verify authentication by auhenticationToken service.

API: Create Session for Authentication

It is possible to start a specific IDP by setting for instance:

  "identityProviders" : ["nbid-oidc"]

Example for starting an authentication (without identifiers the authentication can be used on unknown subjects):

{
  "locale" : "en"
}

To verify an authentication based on SSN (instead of only PID=Personal ID), the following needs to added to the create session request:

  "moduleFlags" : ["verify-by-ssn"]

It is possible to pass both SSN (used as userID for BankID) and MOBILE_NUMBER (used for BankID on Mobile). Fields will be prefilled with the values, and BankID will go directly to OTP screen. Add the following to the create session request:

  "identifiers" : [{
		"identifierValue" : "+4794782976",
		"identifierType" : "MOBILE_NUMBER"
    },
    {
		"identifierValue" : "12017948332",
		"identifierType" : "SSN"
	}],
Sequence diagram for the authentication process
Sequence diagram for id.Authenticate
Figure 10. Sequence diagram for id.Authenticate
Specific iFrame postMessages

  • ID_OUT_AUTHENTICATE_SUCCESS:<authentication token>

    • Sent after a successful BankID authentication

  • ID_OUT_AUTHENTICATE_FAILURE

    • Sent after BankID authentication fails

  • ID_OUT_BANK_ID_CANCEL

    • If a BankID module is directly opened, the cancel button sends this

6.2.2. id.Sign

id.Sign provides a list of Identity Providers (IDP) to choose between when signing a document. The end user will be guided through a signing process. The signing can later be verified by calling the verify a signing by auhenticationToken service.

API: Create Session for Signing

It is possible to start a specific IDP by setting for instance:

  "identityProviders" : ["nbid-oidc"]

Example for starting a signing job (with preset NIN/SSN, NIN/SSN verification and norwegian locale):

{
  "identifiers" : [{
		"identifierValue" : "12017948332",
		"identifierType" : "SSN"
    }],
  "moduleFlags" : ["verify-by-ssn"],
  "identityProviders" : ["nbid-oidc"],
  "locale" : "no",
  "dataToSign": {
	"contract":"QmVrcmVmdGVsc2UgcMOlIHNhbXR5a2tlIGF2IGJlaGFuZGxpbmcgb2cgbGFncmluZyBhdiBkaW5lIHBlcnNvbmxpZ2UgZGF0YS4uLi4=",
	"mimeType":"text/plain",
	"description":"Kontraktsnummer 10012156, version 20190201"
  }
}
Sequence diagram for the signing process
Sequence diagram for id.Sign
Figure 11. Sequence diagram for id.Sign
Specific iFrame postMessages

  • ID_OUT_AUTHENTICATE_SUCCESS:<authentication token>

    • Sent after a successful BankID authentication

  • ID_OUT_AUTHENTICATE_FAILURE

    • Sent after BankID authentication fails

  • ID_OUT_BANK_ID_CANCEL

    • If a BankID module is directly opened, the cancel button sends this

6.3. Wallet

The Wallet module provides a list of your payment instrument and the means to administer them. There is a simple Payment Card Wallet for wallets only containing payment cards and an Extended Wallet supporting multiple payment optiona.

6.3.1. Common Wallet behaviour

  • Default payment instrument will always appear on top.

  • Expiring payment instruments appear last in the list, if it’s not the default payment instrument.

  • If a payment instrument is expired, you won’t be able to make it default.

  • To update the details of a payment card, add a new card with the same card number and updated date/CVC to overwrite the current card.

  • If a payment instrument is not expired, you can perform all actions on it.

  • Selecting a payment instrument opens it in another window, providing necessary information and an action menu.

Common API parameters

  • If "readOnlyMode": true is included in the API call, cards can’t be edited.

  • If "singleInstrumentWallet": true is included in the API call, the add card button will display if wallet is empty.

  • If "customStylingUrl": "https://your-domain.com/your-styling.css" overwrites Aera styles with your own.

6.3.2. Payment Card Wallet

The Payment Card Wallet provides a list of your payment cards and the means to administer them (including securely adding new payment cards).

API: Create Session for Wallet

Below are examples of screenshots of Payment Card Wallet.

Payment Card Wallet images
Table 2. Image Screenshots from the Payment Card Wallet
Description Example image

Card Wallet Overview - Empty Wallet
Card Wallet Overview Empty

Card Wallet Overview - With Payment Cards
Card Wallet Overview - Only Card

Card Wallet Selected Payment Instrument
Card Wallet selected card

Card Wallet Deleting Payment Instrument
Card Wallet deleting card

Card Wallet Selected Expiring Card
Card Wallet Selected expiring card

Card Wallet Add Card
Add Card

Card Wallet Make default card prompt
Card Wallet Make default card prompt
Specific iFrame postMessages

  • ID_OUT_FIRST_CARD_ADDED:<identifierId>

    • When an initial card is added in your wallet, this is sent

6.3.3. Extended Wallet

The Extended Wallet provides a list of your payment instruments and the means to administer them. This includes adding bank accounts for payment with integration to end-user bank (Aera Account Payments), BankAxept ePayment and adding payment cards using 3DSecure. To be able to use Aera Accounts Payments, the end-user needs to be onboarded to Aera Account.

API Wallet Onboarding: Create Session for Ext Wallet Onboarding
API Extended Wallet: Create Session for Ext Wallet

Below are examples of screenshots of Extended Wallet.

Extended Wallet images
Table 3. Image Screenshots from the Extended Wallet
Description Example image

Extended Wallet Overview - Empty Wallet
Extended Wallet Overview Empty

Extended Wallet Overview - Card & Account
Extended Wallet Overview - Card & Account

Extended Wallet Payment Option Selector
Extended Wallet Add selector

Extended Wallet Add Account selected
Extended Wallet Add Account selected

Extended Wallet Dark Mode example
Extended Wallet Dark Mode
Pre-requisites

  • Merchant needs to be onboarded to Extended Wallet

  • Merchant needs to be onboarded to Aera AppID (SDK), and use AppID for Extended Onboarding (and later on for payments)

  • Need to conform to the security requirements for using Aera AppID in conjunction with Aera Account/BankAxept to get these options (part of onboarding to Aera AppID)

Sequence diagram for the Wallet usage
Sequence diagram for Onboarding and Wallet Management

Relevant API End-points:
* /identitymodule/initialize-wallet
* /identitymodule/authentications/verify/{authenticationToken}
* /identitymodule/create-wallet-ext-session

Sequence diagram for Extended Wallet Onboarding and Wallet Management
Figure 12. Sequence diagram for Ext Wallet Onboarding and Wallet Management
Sequence diagram for Ext Wallet Wallet Payments standard roles

In most cases, the Wallet Service Provider hosts its own Mobile Payment Application (MPA). Then it will be natural that it is also the Mobile Payment Application’s backend. This is shown in the diagram below.

In other cases, where the Wallet Service Provider provides the service to other Mobile Payment Applications, it will be natural that the MPA has its own backend.

Relevant API End-points:
* /payments/walletSale
* /wspgw/wallet/callback

Sequence diagram for Extended Wallet Payments
Figure 13. Sequence diagram for Extended Wallet Payments
Sequence diagram for Extended Wallet Payments (WSP, MPA BE and POS BE same component)

In some cases, the POS may not have a centralized infrastructure component, and the various roles may be combined into one component to handle WalletPay transactions.
The diagram below shows a setup where WSP, MPA BE and POS BE are combined and called "WalletPay Backend"

Relevant API End-points:
* /payments/walletSale
* /wspgw/wallet/callback

Sequence diagram for Extended Wallet Payments
Figure 14. Sequence diagram for Extended Wallet Payments
Specific iFrame postMessages

  • ID_OUT_FIRST_CARD_ADDED:<identifierId>

    • When an initial payment instrument (card or account) is added in your wallet, this is sent

Extended Wallet - Add Account Only

The Wallet provides a list of your payment instruments. This function gives the possibility to add an account to the wallet.

API: Create Session for Extended Wallet - Add Account(s) Only

Specific iFrame postMessages

  • ID_OUT_BANKING_DONE

    • When one or more accounts are added to the wallet

  • ID_OUT_BANKING_CANCEL

    • When the adding account process is cancelled

Extended Wallet - Add Card Only (can also be used with Payment Card Wallet)

The Wallet provides a list of your payment instruments. This function gives the possibility to add a card to the wallet.

API: Create Session for Wallet - Add Card Only

Specific iFrame postMessages

  • ID_OUT_CARD_DONE

    • When a card is added to the wallet

  • ID_OUT_CARD_CANCEL

    • When the adding card process is cancelled

6.4. Paths

Descriptions of resources/paths in the service.

6.4.1. Revoke consumer consent

DELETE /identitymodule/api/accounts/consent/{ninAlias}/{mpaId}
Description

Revoke consent for a consumer (by ninAlias) for the defined payment application (by mpaId)

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

mpaId
required

string (uuid)

Path

ninAlias
required

string (uuid)
Responses
HTTP Code Description Schema

204

No Content - Deleted successfully

No Content

400

Bad Request

CommonResponse
Produces

  • application/vnd.identitymodule.v1+json

  • application/json

Tags

  • IdentityModules

Example HTTP request
DELETE /identitymodule/api/accounts/consent/fd3ef496-e25c-45c0-894a-7e3fdddb9a4c/6220cf97-3221-46e0-8351-728bb4c1fe58 HTTP/1.1
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic2NvcGUiOlsiZXh0ZXJuYWxCYW5raW5nIiwiYWxsSWRlbnRpdHlNb2R1bGUiXSwic3ViIjoiNjc3YTBiYjYtNDVmZS00N2Y4LTgwODEtZmFlYTA0ODIxZjA0IiwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.f7Qr4Sfm9Cyt0ORZSCNhFQmbgvY5u2j2lqAacX27uDuh5cpL_ENixzQzVjXEKE535G284cw465xkEppQSsY1SNTNBA9XstIWa60-vM-bgFlk7g_eL6M93-f2HFPnCP1fOh0gHrTuQWTSCGHaCWc8YbH30y2pZMvIQAlPz68WGiVcfqeP7JtDKqBNnZwQ3Gtd5I4vz0dEabunZfveAwB7zjgRPMqz_D8mFTpEjv1bI5VOz9vVGXzVjjdgw6Ts6KCmi8VGh0R9ZT9ACWz4ACp1Lg9eeaKd5BO45a8g0QRHhQO077MluRy6rGyIwBXiHZO5y_eo8TF2YEjhmcxSebxcKA
Accept: application/vnd.identitymodule.v1+json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/api/accounts/consent/fd3ef496-e25c-45c0-894a-7e3fdddb9a4c/6220cf97-3221-46e0-8351-728bb4c1fe58' -i -X DELETE \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic2NvcGUiOlsiZXh0ZXJuYWxCYW5raW5nIiwiYWxsSWRlbnRpdHlNb2R1bGUiXSwic3ViIjoiNjc3YTBiYjYtNDVmZS00N2Y4LTgwODEtZmFlYTA0ODIxZjA0IiwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.f7Qr4Sfm9Cyt0ORZSCNhFQmbgvY5u2j2lqAacX27uDuh5cpL_ENixzQzVjXEKE535G284cw465xkEppQSsY1SNTNBA9XstIWa60-vM-bgFlk7g_eL6M93-f2HFPnCP1fOh0gHrTuQWTSCGHaCWc8YbH30y2pZMvIQAlPz68WGiVcfqeP7JtDKqBNnZwQ3Gtd5I4vz0dEabunZfveAwB7zjgRPMqz_D8mFTpEjv1bI5VOz9vVGXzVjjdgw6Ts6KCmi8VGh0R9ZT9ACWz4ACp1Lg9eeaKd5BO45a8g0QRHhQO077MluRy6rGyIwBXiHZO5y_eo8TF2YEjhmcxSebxcKA' \
    -H 'Accept: application/vnd.identitymodule.v1+json'

6.4.2. Add account(s) to wallet

POST /identitymodule/api/wallets/accounts
Description

Add account numbers (as AERAACCOUNT or BANKAXEPT) via API to a wallet defined by customerVerificationData/sdkTicket.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : WalletAddAccountsRequest

Responses
HTTP Code Description Schema

200

OK

WalletAddAccountsResponse
Consumes

  • application/vnd.identitymodule.v1+json

  • application/json

Produces

  • application/vnd.identitymodule.v1+json

  • application/json

Tags

  • IdentityModules

Example HTTP request
POST /identitymodule/api/wallets/accounts HTTP/1.1
Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic2NvcGUiOlsiZXh0ZXJuYWxCYW5raW5nIiwiYWxsSWRlbnRpdHlNb2R1bGUiXSwic3ViIjoiNjc3YTBiYjYtNDVmZS00N2Y4LTgwODEtZmFlYTA0ODIxZjA0IiwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.f7Qr4Sfm9Cyt0ORZSCNhFQmbgvY5u2j2lqAacX27uDuh5cpL_ENixzQzVjXEKE535G284cw465xkEppQSsY1SNTNBA9XstIWa60-vM-bgFlk7g_eL6M93-f2HFPnCP1fOh0gHrTuQWTSCGHaCWc8YbH30y2pZMvIQAlPz68WGiVcfqeP7JtDKqBNnZwQ3Gtd5I4vz0dEabunZfveAwB7zjgRPMqz_D8mFTpEjv1bI5VOz9vVGXzVjjdgw6Ts6KCmi8VGh0R9ZT9ACWz4ACp1Lg9eeaKd5BO45a8g0QRHhQO077MluRy6rGyIwBXiHZO5y_eo8TF2YEjhmcxSebxcKA
Accept: application/vnd.identitymodule.v1+json
Content-Length: 983
Host: api.aerahost.com

{
  "customerVerificationData" : {
    "cryptogram" : "AQGhQbCm2st3LuY6Orl5phixe1ViB0mDhECULixZW85EEsX3/SKiLm883s9a5+Aln82Sa+Ouj+ShA+XBPUpVwk5XjIfrsO7+dMBP5dZ5YkHR8974HiYHYVgRqWjK1Y6k7g66fgSCPagdCO7f0cMtjk6Ji27Pfnbn5ZP5hznfAln3ViJhb2bm+liEWVIiF2vF9T+CbAO47yrKDNdh6MltLSMC44/CU6SNiqakiZ9OVXOjPLo72UcQ7Ce+PloRMTH83FXC7xFiG/ukew/iN6R8cizw+HeUYlBEBDWD6ca1cYwx8YtwzJVuYK7rUA8TBZHvXgR5ATjPVnsZRBH7wb90dcyeB/tWWXbgpcq0LDF56OsNwB0BQuqRhUzBZ6M7CIfJWDR2J/2IFi1aOFkVMasQNs6y2QbLTo0ThSlKcty7fhxo0P6KbTGBJS7ZxN0hnayD9Is5OKgquuIaCrlY/JdHb+EwsIQdOOWUAJGnL+ycHoFEPfSDDI6zjdb3/gjhX3SnMkXUEK0p8XApMSyeVettb/tTXinChe1+YjAxrPiLNCkI8OAPAgAMGtHQ/qKn8vfz0YDKAwAkMTA0MENDRUMtRjM5OC00NDU0LUJEODgtMTdGRTUxRkMxNjI5",
    "nonce" : "LKEJlkejwn098435lhjdlfjLKJfdlkfs",
    "signedData" : "eyJhY3Rpb24iOiJhZGQtdG8td2FsbGV0IiwidGltZXN0YW1wIjoiMjAxOC0wNS0wM1QwNjowMDo1MFoifQ=="
  },
  "identifiers" : [ {
    "identifierValue" : "01234567",
    "identifierType" : "LOYALTY"
  } ],
  "accounts" : [ "12345678903" ]
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.identitymodule.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: o9Ar2X8PW7glfiqOJuifH1tGvHEy+jUZ2f3GUiobhx5lKKBzlfobf1Cja9zwSQWYwFKx3I6+RrfiBHB7SNvGyKcm38FPPgxFEEdNMQIr31ggsuZqcMTG8gy/tC9/OC7zlkLo4/jvE255ODONsT/pOHbS9ka337DyFEnOrcDY3oPFg7Q5VinEAGGv9fMwSMWxapo6MfcZAbbrK9nKbUiY/0xEe/TmbVPt6rtt0jdj3XM7EbpIyLd1ppvBScgxh+wSRty3fMlHJUrtB2Uug7IS1dv/Le70PDY8ZWuods6fg4b9VM6SAzX0dV9v8slPiArlk1V62slQ/15LwOAOOPn+zg==
Content-Length: 230

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T04:51:08.266Z"
  },
  "accountsStatus" : {
    "12345678903" : {
      "responseCode" : "0",
      "timeStamp" : "2025-08-13T04:51:08.266Z"
    }
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/api/wallets/accounts' -i -X POST \
    -H 'Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic2NvcGUiOlsiZXh0ZXJuYWxCYW5raW5nIiwiYWxsSWRlbnRpdHlNb2R1bGUiXSwic3ViIjoiNjc3YTBiYjYtNDVmZS00N2Y4LTgwODEtZmFlYTA0ODIxZjA0IiwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.f7Qr4Sfm9Cyt0ORZSCNhFQmbgvY5u2j2lqAacX27uDuh5cpL_ENixzQzVjXEKE535G284cw465xkEppQSsY1SNTNBA9XstIWa60-vM-bgFlk7g_eL6M93-f2HFPnCP1fOh0gHrTuQWTSCGHaCWc8YbH30y2pZMvIQAlPz68WGiVcfqeP7JtDKqBNnZwQ3Gtd5I4vz0dEabunZfveAwB7zjgRPMqz_D8mFTpEjv1bI5VOz9vVGXzVjjdgw6Ts6KCmi8VGh0R9ZT9ACWz4ACp1Lg9eeaKd5BO45a8g0QRHhQO077MluRy6rGyIwBXiHZO5y_eo8TF2YEjhmcxSebxcKA' \
    -H 'Accept: application/vnd.identitymodule.v1+json' \
    -d '{
  "customerVerificationData" : {
    "cryptogram" : "AQGhQbCm2st3LuY6Orl5phixe1ViB0mDhECULixZW85EEsX3/SKiLm883s9a5+Aln82Sa+Ouj+ShA+XBPUpVwk5XjIfrsO7+dMBP5dZ5YkHR8974HiYHYVgRqWjK1Y6k7g66fgSCPagdCO7f0cMtjk6Ji27Pfnbn5ZP5hznfAln3ViJhb2bm+liEWVIiF2vF9T+CbAO47yrKDNdh6MltLSMC44/CU6SNiqakiZ9OVXOjPLo72UcQ7Ce+PloRMTH83FXC7xFiG/ukew/iN6R8cizw+HeUYlBEBDWD6ca1cYwx8YtwzJVuYK7rUA8TBZHvXgR5ATjPVnsZRBH7wb90dcyeB/tWWXbgpcq0LDF56OsNwB0BQuqRhUzBZ6M7CIfJWDR2J/2IFi1aOFkVMasQNs6y2QbLTo0ThSlKcty7fhxo0P6KbTGBJS7ZxN0hnayD9Is5OKgquuIaCrlY/JdHb+EwsIQdOOWUAJGnL+ycHoFEPfSDDI6zjdb3/gjhX3SnMkXUEK0p8XApMSyeVettb/tTXinChe1+YjAxrPiLNCkI8OAPAgAMGtHQ/qKn8vfz0YDKAwAkMTA0MENDRUMtRjM5OC00NDU0LUJEODgtMTdGRTUxRkMxNjI5",
    "nonce" : "LKEJlkejwn098435lhjdlfjLKJfdlkfs",
    "signedData" : "eyJhY3Rpb24iOiJhZGQtdG8td2FsbGV0IiwidGltZXN0YW1wIjoiMjAxOC0wNS0wM1QwNjowMDo1MFoifQ=="
  },
  "identifiers" : [ {
    "identifierValue" : "01234567",
    "identifierType" : "LOYALTY"
  } ],
  "accounts" : [ "12345678903" ]
}'

6.4.3. Wallet payment instruments

POST /identitymodule/api/wallets/find-payment-instruments
Description

Finds payment instruments in a wallet based on an Identifier. Optionally include icon SVG per instrument.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : FindPaymentInstrumentsRequest

Responses
HTTP Code Description Schema

200

OK

PaymentInstrumentsResponse
Consumes

  • application/vnd.identitymodule.v1+json

  • application/json

Produces

  • application/vnd.identitymodule.v1+json

  • application/json

Tags

  • IdentityModules

Example HTTP request
POST /identitymodule/api/wallets/find-payment-instruments HTTP/1.1
Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiZmU1NmJhOWEtYTExMS00ZDU4LTgyMDItMTJjMmZkMTgzMTA4Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.SqPZqgy2f5L2o1Q2x939XksnxgcEDCo_dAMjim2hq3i3s57HU5wPZwECtCyk_L4B_Ibi6KqTUyZQLifBW6rDqyFQwA9VZwoG8SMPsWXUTq8j1NLymIVUUqvacAjlkKQMq3j2ObwPzo2TVC8BXics27isD7N8HfMeLr2gs49-MShaK5NFKqDi4YDsbxxQ5RcI6IS5DmvqirMbwhIboMRdxSUuNPY7KruoOr-bdP_dmvZ3_Dkg9j6vMxfNAdStmizzzd1HQ10AQrhNneqexuyiMmVKBGe_sj4JQHFkt9ONPwvuII8OyrEHEas6nYiPDJZVSWGI8UcppcouVPEuxH-v0g
Accept: application/vnd.identitymodule.v1+json
Content-Length: 68
Host: api.aerahost.com

{
  "identifierType" : "LOYALTY",
  "identifierValue" : "12345678"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.identitymodule.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: BjhR0JWFRI1f1jUGMLJV+hTJPfw5IXvAMdMoU2cqoiNZMYtXlrWM16881aympUbDn3qO5Tll3kikPoHltbf9xvEEwA9PHHgbGcOsfp2hyIileguHbWkGpfLaFY3qG9HR78l8lacn2KN7BwJ45WXTQNZB27OR08ZHIcmR8Ah249lEL99OSsqphuC0AiyLXzhgTeTXOoQKSuuf1aLgA/HDrUsf7mlWGdSZ0R6PYSKcmdP4uaCkpvdxgqFV9B0ps7neO5fNJoK0O4q9cGGcdyK9k5rRwh4ssnmzH7veOBgY5hGAiMNCU5Di6vcSjZKBblOVxTz8PDUNm2FsPntQjY3Euw==
Content-Length: 3887

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T04:51:01.056Z"
  },
  "consumerId" : "01088f64-31df-44f3-8d00-884ce9a75221",
  "paymentInstruments" : [ {
    "identifierId" : "f7cc8cda9bef7ce8e09d3c69a9e06f7920948d6d",
    "identifierType" : "PAY_CARD",
    "identifierValue" : "*******3324",
    "instrumentId" : "dd5ed006-3529-4609-83b4-554e6ffd702c",
    "priority" : 2,
    "cardScheme" : "BANKAXEPT",
    "paymentInstrumentType" : "01",
    "cardType" : "D",
    "defaultPaymentInstrument" : false,
    "assuranceMethod" : "DELEGATED_SCA",
    "iconUrl" : "https://static.api-dev.aerahost.com/view/dev/assets/wallet/card-bankaxept.svg",
    "status" : "ACTIVE"
  }, {
    "identifierId" : "f7cc8cda9bef7ce8e09d3c69a9e06f7920948d5d",
    "identifierType" : "PAY_CARD",
    "identifierValue" : "*******3324",
    "instrumentId" : "6f8ec470-1729-451b-8ec2-44474859fcdb",
    "priority" : 2,
    "cardScheme" : "BANKAXEPT",
    "paymentInstrumentType" : "01",
    "cardType" : "D",
    "defaultPaymentInstrument" : false,
    "assuranceMethod" : "DELEGATED_SCA",
    "iconUrl" : "https://static.api-dev.aerahost.com/view/dev/assets/wallet/card-bankaxept.svg",
    "status" : "SUSPENDED"
  }, {
    "identifierId" : "f7cc8cda9bef7ce8e09d3c69a9e06f7920948d7d",
    "identifierType" : "PAY_CARD",
    "identifierValue" : "************6543",
    "instrumentId" : "MZJFZ5MVH8TC1",
    "priority" : 2,
    "expirationdate" : "2028-12-31",
    "cardScheme" : "VISA",
    "defaultPaymentInstrument" : false,
    "assuranceMethod" : "THREE_D_SECURE",
    "iconUrl" : "https://static.api-dev.aerahost.com/view/dev/assets/wallet/card-visa.svg",
    "status" : "ACTIVE"
  }, {
    "identifierId" : "42e112bda4f155704ba1b56bf35df348d220f228",
    "identifierType" : "PAY_ACCOUNT",
    "identifierValue" : "********911",
    "priority" : 1,
    "defaultPaymentInstrument" : true,
    "provider" : "SB1",
    "assuranceMethod" : "DELEGATED_SCA",
    "iconUrl" : "https://static.api-dev.aerahost.com/view/dev/assets/wallet/aera-account-sb1.svg",
    "status" : "ACTIVE"
  }, {
    "identifierId" : "42e112bda4f155704ba1b56bf35df348d220f228",
    "identifierType" : "PAY_ACCOUNT",
    "identifierValue" : "********911",
    "priority" : 1,
    "defaultPaymentInstrument" : false,
    "provider" : "LocoBank",
    "assuranceMethod" : "DELEGATED_SCA",
    "iconUrl" : "https://static.api-dev.aerahost.com/view/dev/assets/wallet/aera-account-bank.svg",
    "status" : "ACTIVE"
  }, {
    "identifierId" : "42e112bda4f155704ba1b56bf35df348d220f228",
    "identifierType" : "PAY_ACCOUNT",
    "identifierValue" : "********911",
    "priority" : 1,
    "defaultPaymentInstrument" : false,
    "provider" : "DNB",
    "assuranceMethod" : "THIRD_PARTY",
    "iconUrl" : "https://static.api-dev.aerahost.com/view/dev/assets/wallet/aera-account-dnb.svg",
    "status" : "ACTIVE"
  }, {
    "identifierId" : "f7cc8cda9bef7ce8e09d3c69a9e06f7920948d8d",
    "identifierType" : "PAY_CARD",
    "identifierValue" : "************6543",
    "instrumentId" : "MZJFZ5MVH8TC1",
    "priority" : 2,
    "expirationdate" : "2028-12-31",
    "cardScheme" : "UNKNOWN",
    "defaultPaymentInstrument" : false,
    "assuranceMethod" : "THREE_D_SECURE",
    "iconUrl" : "https://static.api-dev.aerahost.com/view/dev/assets/wallet/card-default.svg",
    "status" : "ACTIVE"
  }, {
    "identifierId" : "f7cc8cda9bef7ce8e09d3c69a9e06f7920948d3d",
    "identifierType" : "PAY_CARD",
    "identifierValue" : "*******3324",
    "instrumentId" : "84a6861a-32ab-4965-9ec0-9156957454d5",
    "priority" : 2,
    "cardScheme" : "BANKAXEPT",
    "paymentInstrumentType" : "01",
    "cardType" : "D",
    "defaultPaymentInstrument" : false,
    "assuranceMethod" : "DELEGATED_SCA",
    "iconUrl" : "https://static.api-dev.aerahost.com/view/dev/assets/wallet/card-bankaxept.svg",
    "status" : "ACTIVE"
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/api/wallets/find-payment-instruments' -i -X POST \
    -H 'Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiZmU1NmJhOWEtYTExMS00ZDU4LTgyMDItMTJjMmZkMTgzMTA4Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.SqPZqgy2f5L2o1Q2x939XksnxgcEDCo_dAMjim2hq3i3s57HU5wPZwECtCyk_L4B_Ibi6KqTUyZQLifBW6rDqyFQwA9VZwoG8SMPsWXUTq8j1NLymIVUUqvacAjlkKQMq3j2ObwPzo2TVC8BXics27isD7N8HfMeLr2gs49-MShaK5NFKqDi4YDsbxxQ5RcI6IS5DmvqirMbwhIboMRdxSUuNPY7KruoOr-bdP_dmvZ3_Dkg9j6vMxfNAdStmizzzd1HQ10AQrhNneqexuyiMmVKBGe_sj4JQHFkt9ONPwvuII8OyrEHEas6nYiPDJZVSWGI8UcppcouVPEuxH-v0g' \
    -H 'Accept: application/vnd.identitymodule.v1+json' \
    -d '{
  "identifierType" : "LOYALTY",
  "identifierValue" : "12345678"
}'

6.4.4. Bank register numbers supported

POST /identitymodule/api/wallets/reg-numbers
Description

Check if bank register (clearing) numbers are supported by WSP’s configured payment instrument types.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : WalletBankRegisterNumbers

Responses
HTTP Code Description Schema

200

OK

WalletSupportedBankRegisterNumbers
Consumes

  • application/vnd.identitymodule.v1+json

  • application/json

Produces

  • application/vnd.identitymodule.v1+json

  • application/json

Tags

  • IdentityModules

Example HTTP request
POST /identitymodule/api/wallets/reg-numbers HTTP/1.1
Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic2NvcGUiOlsiZXh0ZXJuYWxCYW5raW5nIiwiYWxsSWRlbnRpdHlNb2R1bGUiXSwic3ViIjoiNjc3YTBiYjYtNDVmZS00N2Y4LTgwODEtZmFlYTA0ODIxZjA0IiwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.f7Qr4Sfm9Cyt0ORZSCNhFQmbgvY5u2j2lqAacX27uDuh5cpL_ENixzQzVjXEKE535G284cw465xkEppQSsY1SNTNBA9XstIWa60-vM-bgFlk7g_eL6M93-f2HFPnCP1fOh0gHrTuQWTSCGHaCWc8YbH30y2pZMvIQAlPz68WGiVcfqeP7JtDKqBNnZwQ3Gtd5I4vz0dEabunZfveAwB7zjgRPMqz_D8mFTpEjv1bI5VOz9vVGXzVjjdgw6Ts6KCmi8VGh0R9ZT9ACWz4ACp1Lg9eeaKd5BO45a8g0QRHhQO077MluRy6rGyIwBXiHZO5y_eo8TF2YEjhmcxSebxcKA
Accept: application/vnd.identitymodule.v1+json
Content-Length: 39
Host: api.aerahost.com

{
  "regNumbers" : [ "9998", "9999" ]
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.identitymodule.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: eX9FPH21V2M7cWpI/kgeNcb/1G9LNhxNqdePf8hmhmjvezRvwAhAhFTuGV/erABWiuCKrVgN6DImNkUcahMo5IlzT4LuTPbDPrjLFTpd6z/9P3u4lVoE09cSteDMt7Y1mR6lNcygwfYbylbDYoZMQZf4DB0Yc1RTk7vfoN7DxaHF4/6P9oNw1NoIPPU4ezJEx1QRl3zMltnDf78NkZLC7xlWhdI94aRl7ytKUC8TfwiikLv8Pa6selj/HuPNU4W/E9RxXKOUUHcHuS9QnauJi+fDKf5MjsuocwsoOKjS4aLcHjUTAnnZ7eY5yaCzCjPhk4FEEKCLmeZDc67KQ+2lng==
Content-Length: 313

{
  "responseInfo" : {
    "message" : "At least one reg number is not supported",
    "responseCode" : "10110",
    "timeStamp" : "2025-08-13T04:51:09.778Z"
  },
  "supportedRegNumbers" : [ {
    "regNumber" : "9998",
    "displayName" : "LocoBank BIC",
    "supportedBy" : [ "AERAACCOUNT", "BANKAXEPT" ]
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/api/wallets/reg-numbers' -i -X POST \
    -H 'Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic2NvcGUiOlsiZXh0ZXJuYWxCYW5raW5nIiwiYWxsSWRlbnRpdHlNb2R1bGUiXSwic3ViIjoiNjc3YTBiYjYtNDVmZS00N2Y4LTgwODEtZmFlYTA0ODIxZjA0IiwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.f7Qr4Sfm9Cyt0ORZSCNhFQmbgvY5u2j2lqAacX27uDuh5cpL_ENixzQzVjXEKE535G284cw465xkEppQSsY1SNTNBA9XstIWa60-vM-bgFlk7g_eL6M93-f2HFPnCP1fOh0gHrTuQWTSCGHaCWc8YbH30y2pZMvIQAlPz68WGiVcfqeP7JtDKqBNnZwQ3Gtd5I4vz0dEabunZfveAwB7zjgRPMqz_D8mFTpEjv1bI5VOz9vVGXzVjjdgw6Ts6KCmi8VGh0R9ZT9ACWz4ACp1Lg9eeaKd5BO45a8g0QRHhQO077MluRy6rGyIwBXiHZO5y_eo8TF2YEjhmcxSebxcKA' \
    -H 'Accept: application/vnd.identitymodule.v1+json' \
    -d '{
  "regNumbers" : [ "9998", "9999" ]
}'

6.4.5. Wallet payer SCA Token

GET /identitymodule/api/wallets/sca-token/{scaToken}
Description

Returns an updated customerVerificationData (CVD) by a SCA token to be used in a payment/sale/transfer where 3rd party SCA is required. Optionally include icon SVG per instrument.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

scaToken
required

The Authentication Token returned after successful 3rd party SCA.

string (uuid)
Responses
HTTP Code Description Schema

200

OK

WalletPayerScaTokenResponse
Produces

  • application/vnd.identitymodule.v1+json

  • application/json

Tags

  • IdentityModules

Example HTTP request
GET /identitymodule/api/wallets/sca-token/27d6a2f9-dff2-497d-a93d-2626480e15c0 HTTP/1.1
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiZmU1NmJhOWEtYTExMS00ZDU4LTgyMDItMTJjMmZkMTgzMTA4Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.SqPZqgy2f5L2o1Q2x939XksnxgcEDCo_dAMjim2hq3i3s57HU5wPZwECtCyk_L4B_Ibi6KqTUyZQLifBW6rDqyFQwA9VZwoG8SMPsWXUTq8j1NLymIVUUqvacAjlkKQMq3j2ObwPzo2TVC8BXics27isD7N8HfMeLr2gs49-MShaK5NFKqDi4YDsbxxQ5RcI6IS5DmvqirMbwhIboMRdxSUuNPY7KruoOr-bdP_dmvZ3_Dkg9j6vMxfNAdStmizzzd1HQ10AQrhNneqexuyiMmVKBGe_sj4JQHFkt9ONPwvuII8OyrEHEas6nYiPDJZVSWGI8UcppcouVPEuxH-v0g
Accept: application/vnd.identitymodule.v1+json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.identitymodule.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: RlYixTN11mRPbh7bhLc2ARg4dndywlOiwaYBhIOBbBE2ifmJ8iU03OfJatnS8VHz6NtWFG+Zre5xKLGt4o2wCEUzvKiEiMNWjt2AiPUVMCAJFj6FUNcgrMWqEO7VKFg40oDv/ietbSEFpsMEfQ4O5auoXBZYmVxGYnOY3UH/Q63DFNIcwVS1kHNai7s+tDMrNR4pnatpvfxEH1s5uQ5U6qt7agHpOmrMS7MV5udvk7IZZWOAJ6lp1jyC9URfbrImV0z9xCf4T4bBN69JnNggKznQAkPSJyGpBn+h8QV3VpqW5Y/OQTgcSKZxZoeu+/JyXYeb4OXkssK7xJJJlaiNXg==
Content-Length: 1128

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T04:51:10.043Z"
  },
  "customerVerificationData" : {
    "cryptogram" : "AQGhQbCm2st3LuY6Orl5phixe1ViB0mDhECULixZW85EEsX3/SKiLm883s9a5+Aln82Sa+Ouj+ShA+XBPUpVwk5XjIfrsO7+dMBP5dZ5YkHR8974HiYHYVgRqWjK1Y6k7g66fgSCPagdCO7f0cMtjk6Ji27Pfnbn5ZP5hznfAln3ViJhb2bm+liEWVIiF2vF9T+CbAO47yrKDNdh6MltLSMC44/CU6SNiqakiZ9OVXOjPLo72UcQ7Ce+PloRMTH83FXC7xFiG/ukew/iN6R8cizw+HeUYlBEBDWD6ca1cYwx8YtwzJVuYK7rUA8TBZHvXgR5ATjPVnsZRBH7wb90dcyeB/tWWXbgpcq0LDF56OsNwB0BQuqRhUzBZ6M7CIfJWDR2J/2IFi1aOFkVMasQNs6y2QbLTo0ThSlKcty7fhxo0P6KbTGBJS7ZxN0hnayD9Is5OKgquuIaCrlY/JdHb+EwsIQdOOWUAJGnL+ycHoFEPfSDDI6zjdb3/gjhX3SnMkXUEK0p8XApMSyeVettb/tTXinChe1+YjAxrPiLNCkI8OAPAgAMGtHQ/qKn8vfz0YDKAwAkMTA0MENDRUMtRjM5OC00NDU0LUJEODgtMTdGRTUxRkMxNjI5",
    "nonce" : "LKEJlkejwn098435lhjdlfjLKJfdlkfs",
    "signedData" : "eyJnbG9iYWxMb2NhdGlvbk51bWJlciI6IjMwNjI0Njk2NjY0NjAiLCJtZXJjaGFudE5hbWUiOiJBZXJhIENhbmR5IiwiY3VycmVuY3kiOiJOT0siLCJncm9zc0Ftb3VudCI6IjEuMDAiLCJ0aW1lc3RhbXAiOiIyMDE4LTA1LTAzVDA2OjAwOjUwWiIsInRyYW5zYWN0aW9uSWQiOiIwNmI2ZGVlMS05YzE3LTQxODQtODQwNy0yZmNmZjg0OWQ1MTIifQ=="
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/api/wallets/sca-token/27d6a2f9-dff2-497d-a93d-2626480e15c0' -i -X GET \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiZmU1NmJhOWEtYTExMS00ZDU4LTgyMDItMTJjMmZkMTgzMTA4Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.SqPZqgy2f5L2o1Q2x939XksnxgcEDCo_dAMjim2hq3i3s57HU5wPZwECtCyk_L4B_Ibi6KqTUyZQLifBW6rDqyFQwA9VZwoG8SMPsWXUTq8j1NLymIVUUqvacAjlkKQMq3j2ObwPzo2TVC8BXics27isD7N8HfMeLr2gs49-MShaK5NFKqDi4YDsbxxQ5RcI6IS5DmvqirMbwhIboMRdxSUuNPY7KruoOr-bdP_dmvZ3_Dkg9j6vMxfNAdStmizzzd1HQ10AQrhNneqexuyiMmVKBGe_sj4JQHFkt9ONPwvuII8OyrEHEas6nYiPDJZVSWGI8UcppcouVPEuxH-v0g' \
    -H 'Accept: application/vnd.identitymodule.v1+json'

6.4.6. Verify Authentication Session

GET /identitymodule/authentications/verify/{authenticationToken}
Description

Verify an authentication based on an authenticationToken (only once per token)

Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

authenticationToken
required

The Authentication Token returned after successful Authentication.

string
Responses
HTTP Code Description Schema

200

OK

VerifyResponse
Produces

  • application/json

  • application/vnd.identitymodule.v1+json

Tags

  • IdentityModules

Example HTTP request
GET /identitymodule/authentications/verify/8Bi6opuGVTMh0fut2i8u HTTP/1.1
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg
Accept: application/vnd.identitymodule.v1+json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/vnd.identitymodule.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Security-Policy: default-src 'self' http://localhost:3000 https://localhost:3000; script-src 'self' http://localhost:3000 https://localhost:3000; frame-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; style-src 'self' http://localhost:3000 https://localhost:3000; font-src 'self' http://localhost:3000 https://localhost:3000; child-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; img-src blob: data: 'self' http://localhost:3000 https://localhost:3000;
signature: B6aT0wn0PcLqCrsYjUVhEQL6ox1L0SfN6pWWXwObrTiYgt+aagQ9KkK2ZnRqbEBUBpxxj+xHM9qqozyiYwMAq1uFXEjbVwod8+MPCYLiSRFeMuZ4RAnaOLaKS1AJAdlVLd+CkYwiiXQyJCImqYN2MFS9r1u/GI9U6NEenvSYD5SnjHglCTnfueEiRgUZaKfxuT58JBsFwojYA08fLZtXn0Hwcl/HHj9HpSZh49pT6zHI3m60GwWDAXTeAK564aaz4OYLR1OGSEltJ2PVCy9WgvJc+BPwkRgXan8WXsHiOoR/mtZ1G37CAdoJA4MxGmn3nju6nXzxYSAL6OQW0MuTuA==
Content-Length: 403

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T04:51:09.594Z"
  },
  "identityProvider" : "nbid-oidc",
  "subject" : "9946399b-c797-42ff-88c0-62595af9ed06",
  "identifierValue" : "9578-6000-4-319272",
  "identifierType" : "PID",
  "dateOfBirth" : "17012020",
  "pid" : "9578-6000-4-319272",
  "ssn" : "17012099479",
  "ssnAlias" : "fd3ef496-e25c-45c0-894a-7e3fdddb9a4c"
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/authentications/verify/8Bi6opuGVTMh0fut2i8u' -i -X GET \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg' \
    -H 'Accept: application/vnd.identitymodule.v1+json'

6.4.7. Aera Account onboarding session

POST /identitymodule/create-akb-onboarding-session
Description

Creates an Aera Account Payment (AAP/AKB) Onboarding Session. Needed to open Aera Account wallet.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CreateSessionAKBOnboardingRequest

Responses
HTTP Code Description Schema

200

OK

CreateSessionResponse
Consumes

  • application/vnd.identitymodule.v1+json

  • application/json

Produces

  • application/vnd.identitymodule.v1+json

  • application/json

Tags

  • IdentityModules

Example HTTP request
POST /identitymodule/create-akb-onboarding-session HTTP/1.1
Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg
x-amzn-trace-id: Root=1-6447581f-2cac0ac66d6fc6e50392a908;Parent=4759cdc47989ab1f;Sampled=1
x-amzn-requestid: b603ac3a-8806-4c3d-b9c7-cb966e966b24
Accept: application/vnd.identitymodule.v1+json
Content-Length: 520
Host: api.aerahost.com

{
  "locale" : "no",
  "identifiers" : [ {
    "identifierValue" : "+4794782976",
    "identifierType" : "MOBILE_NUMBER"
  }, {
    "identifierValue" : "17012099479",
    "identifierType" : "SSN"
  }, {
    "identifierValue" : "238923876293498",
    "identifierType" : "ADDITIONAL_ID"
  }, {
    "identifierValue" : "kari.nordmann@foobar.com",
    "identifierType" : "EMAIL"
  } ],
  "moduleFlags" : [ "skip-user-details", "verify-by-ssn", "verify-with-sdk-ticket" ],
  "mpaId" : "6220cf97-3221-46e0-8351-728bb4c1fe58"
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/vnd.identitymodule.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Security-Policy: default-src 'self' http://localhost:3000 https://localhost:3000; script-src 'self' http://localhost:3000 https://localhost:3000; frame-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; style-src 'self' http://localhost:3000 https://localhost:3000; font-src 'self' http://localhost:3000 https://localhost:3000; child-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; img-src blob: data: 'self' http://localhost:3000 https://localhost:3000;
signature: I+xlpsqr9cY2l2LEg2QXJOVuKoyVpSOPkAdU+P3NQeWgnqTKZgIGJYzWKnm/S5EPYmoOaYqfbujzCy+856D+Vi/5rsUueti/NEo8YdzSXYT2M/Vx265CGJ4wUUWC5i2WSiB3lKzP5py8uoWVjpIr3IUbbtRlacP56jNNi83fPLsbgIuKHdMs00t7Aw22fpO9gk4yn2VS+/zxKtdYTB/T37o0MsydFnmHtk1R+Mvu0tOHFNoyCsMo7wID04++EQfN0pQGJzSJIEd7KaMb6is0RrOOg5bzYdxLvfIuZAY7eYwfOLDTVr7438COUL31lYUEsZ3mu+0Yg3hj55+bPn+pfA==
Content-Length: 451

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T04:51:07.957Z"
  },
  "sessionExpirationTime" : "2018-05-03T07:30Z",
  "sessionKey" : "de7dc2ab-eb75-40be-ac61-313f3158f47b",
  "sessionId" : "d864f480-1e16-4eb4-8281-3d7d58826a3e",
  "identityModuleUrl" : "https://static.api-dev.aerahost.com/view/index.html?m=authenticate&lang=no&l=aera&sid=d864f480-1e16-4eb4-8281-3d7d58826a3e&sk=de7dc2ab-eb75-40be-ac61-313f3158f47b"
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/create-akb-onboarding-session' -i -X POST \
    -H 'Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg' \
    -H 'x-amzn-trace-id: Root=1-6447581f-2cac0ac66d6fc6e50392a908;Parent=4759cdc47989ab1f;Sampled=1' \
    -H 'x-amzn-requestid: b603ac3a-8806-4c3d-b9c7-cb966e966b24' \
    -H 'Accept: application/vnd.identitymodule.v1+json' \
    -d '{
  "locale" : "no",
  "identifiers" : [ {
    "identifierValue" : "+4794782976",
    "identifierType" : "MOBILE_NUMBER"
  }, {
    "identifierValue" : "17012099479",
    "identifierType" : "SSN"
  }, {
    "identifierValue" : "238923876293498",
    "identifierType" : "ADDITIONAL_ID"
  }, {
    "identifierValue" : "kari.nordmann@foobar.com",
    "identifierType" : "EMAIL"
  } ],
  "moduleFlags" : [ "skip-user-details", "verify-by-ssn", "verify-with-sdk-ticket" ],
  "mpaId" : "6220cf97-3221-46e0-8351-728bb4c1fe58"
}'

6.4.8. Authentication session

POST /identitymodule/create-authentication-session
Description

Creates an Authentication Session.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
optional

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CreateSessionAuthenticateRequest

Responses
HTTP Code Description Schema

200

OK

CreateSessionResponse
Consumes

  • application/vnd.identitymodule.v1+json

  • application/json

Produces

  • application/vnd.identitymodule.v1+json

  • application/json

Tags

  • IdentityModules

Example HTTP request
POST /identitymodule/create-authentication-session HTTP/1.1
Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg
Accept: application/vnd.identitymodule.v1+json
Content-Length: 278
Host: api.aerahost.com

{
  "locale" : "no",
  "identifiers" : [ {
    "identifierValue" : "238923876293498",
    "identifierType" : "ADDITIONAL_ID"
  }, {
    "identifierValue" : "+4794782976",
    "identifierType" : "MOBILE_NUMBER"
  } ],
  "moduleFlags" : [ "verify-by-ssn", "sdk-initialization" ]
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/vnd.identitymodule.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Security-Policy: default-src 'self' http://localhost:3000 https://localhost:3000; script-src 'self' http://localhost:3000 https://localhost:3000; frame-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; style-src 'self' http://localhost:3000 https://localhost:3000; font-src 'self' http://localhost:3000 https://localhost:3000; child-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; img-src blob: data: 'self' http://localhost:3000 https://localhost:3000;
signature: CpCkbfi9JPck4N5WNsem82kstD6mkHDceWLJkNkms3BwlQBDd0kFNMg83STwDF/IJ0/UNbNxU6x/OXA0WHOGaUNCguqOsZN9wfAZ6K/FowGbxRQH8EgLnS7QR09M7TjyWMKZmR+fGSIXRp3EX0D6ELG7NNaUxm467V3HwXpeR0tBP8Ra+tXScMrJ3YrmgDLUMrN9pblYS2xpUmGlLFHclnZV6oMp032IbLcmO9iUHNok5ngyJI7WD9NXL4noizOxwL4/10XCu6rVM+7UC/6isR7vJHWu8j56TuFgOjmq5InDP3fG0JWsInl6H3w9gFhopaoc1ExKTWZ9N4o1/poE9Q==
Content-Length: 444

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T04:51:09.016Z"
  },
  "sessionExpirationTime" : "2018-05-03T07:30Z",
  "sessionKey" : "de7dc2ab-eb75-40be-ac61-313f3158f47b",
  "sessionId" : "dc49971c-4af8-4b02-bf9a-f90b92313404",
  "identityModuleUrl" : "https://static.api-dev.aerahost.com/view/index.html?m=authenticate&lang=no&sid=dc49971c-4af8-4b02-bf9a-f90b92313404&sk=de7dc2ab-eb75-40be-ac61-313f3158f47b"
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/create-authentication-session' -i -X POST \
    -H 'Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg' \
    -H 'Accept: application/vnd.identitymodule.v1+json' \
    -d '{
  "locale" : "no",
  "identifiers" : [ {
    "identifierValue" : "238923876293498",
    "identifierType" : "ADDITIONAL_ID"
  }, {
    "identifierValue" : "+4794782976",
    "identifierType" : "MOBILE_NUMBER"
  } ],
  "moduleFlags" : [ "verify-by-ssn", "sdk-initialization" ]
}'

6.4.9. Sign document session

POST /identitymodule/create-signing-session
Description

Creates a Session for signing documents (text, PDF, PAdES).

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
optional

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CreateSessionSignRequest

Responses
HTTP Code Description Schema

200

OK

CreateSessionResponse
Consumes

  • application/vnd.identitymodule.v1+json

  • application/json

Produces

  • application/vnd.identitymodule.v1+json

  • application/json

Tags

  • IdentityModules

Example HTTP request
POST /identitymodule/create-signing-session HTTP/1.1
Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg
Accept: application/vnd.identitymodule.v1+json
Content-Length: 514
Host: api.aerahost.com

{
  "locale" : "no",
  "identifiers" : [ {
    "identifierValue" : "238923876293498",
    "identifierType" : "ADDITIONAL_ID"
  }, {
    "identifierValue" : "+4794782976",
    "identifierType" : "MOBILE_NUMBER"
  } ],
  "dataToSign" : {
    "description" : "Kontraktsnummer 1001, version 20190201",
    "contract" : "QmVrcmVmdGVsc2UgcMOlIHNhbXR5a2tlIGF2IGJlaGFuZGxpbmcgb2cgbGFncmluZyBhdiBkaW5lIHBlcnNvbmxpZ2UgZGF0YSBvdmVyIHRpbCBBZXJhLiBEYXRhIHZpbCBiZWhhbmRsZXMgaWh0IHRpbCBicmE=",
    "mimeType" : "text/plain"
  }
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/vnd.identitymodule.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Security-Policy: default-src 'self' http://localhost:3000 https://localhost:3000; script-src 'self' http://localhost:3000 https://localhost:3000; frame-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; style-src 'self' http://localhost:3000 https://localhost:3000; font-src 'self' http://localhost:3000 https://localhost:3000; child-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; img-src blob: data: 'self' http://localhost:3000 https://localhost:3000;
signature: GvsVz/4F9IC55+dVGBCu4JwbN6LdLrr7GCA5wcrU0+pAmBVkEvaLJKyuT9aHEe535CSP7sKQOgxL1mFxac+J9jIcw6iDfL4unXCeT4wnMpIJHKggsDMvan3tlwpmzCu/IBU8lHt4z4MkR3OhrETPGxS+tPq/lfFuALgL1SK+1l6eAq2fNECD1oi7qNOxEoZ1xby8O8r2quHO7EMP56rVw1DuJ6G/H+r85GKLR4IIiBvBUwGq80gYlmT5TclE4hWxX9PhITs9Xpf+1IOO7iAciJMKYtTKPRWrG3j01yt1S+tgzTCT6Q3kTt7Ty0nVukU51lloaia+kjHU7kO9uWe0+w==
Content-Length: 436

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T04:51:08.832Z"
  },
  "sessionExpirationTime" : "2018-05-03T07:30Z",
  "sessionKey" : "de7dc2ab-eb75-40be-ac61-313f3158f47b",
  "sessionId" : "13d6691c-d8d6-475f-a968-d3044216ef1f",
  "identityModuleUrl" : "https://static.api-dev.aerahost.com/view/index.html?m=sign&lang=no&sid=13d6691c-d8d6-475f-a968-d3044216ef1f&sk=de7dc2ab-eb75-40be-ac61-313f3158f47b"
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/create-signing-session' -i -X POST \
    -H 'Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg' \
    -H 'Accept: application/vnd.identitymodule.v1+json' \
    -d '{
  "locale" : "no",
  "identifiers" : [ {
    "identifierValue" : "238923876293498",
    "identifierType" : "ADDITIONAL_ID"
  }, {
    "identifierValue" : "+4794782976",
    "identifierType" : "MOBILE_NUMBER"
  } ],
  "dataToSign" : {
    "description" : "Kontraktsnummer 1001, version 20190201",
    "contract" : "QmVrcmVmdGVsc2UgcMOlIHNhbXR5a2tlIGF2IGJlaGFuZGxpbmcgb2cgbGFncmluZyBhdiBkaW5lIHBlcnNvbmxpZ2UgZGF0YSBvdmVyIHRpbCBBZXJhLiBEYXRhIHZpbCBiZWhhbmRsZXMgaWh0IHRpbCBicmE=",
    "mimeType" : "text/plain"
  }
}'

6.4.10. View document session

POST /identitymodule/create-view-document-session
Description

Creates a session to view a signed document.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
optional

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CreateSessionViewDocumentRequest

Responses
HTTP Code Description Schema

200

OK

CreateSessionResponse
Consumes

  • application/vnd.identitymodule.v1+json

  • application/json

Produces

  • application/vnd.identitymodule.v1+json

  • application/json

Tags

  • IdentityModules

Example HTTP request
POST /identitymodule/create-view-document-session HTTP/1.1
Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg
Accept: application/vnd.identitymodule.v1+json
Content-Length: 59
Host: api.aerahost.com

{
  "documentId" : "3126d5fb-278f-4718-bb01-082498e9437b"
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/vnd.identitymodule.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Security-Policy: default-src 'self' http://localhost:3000 https://localhost:3000; script-src 'self' http://localhost:3000 https://localhost:3000; frame-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; style-src 'self' http://localhost:3000 https://localhost:3000; font-src 'self' http://localhost:3000 https://localhost:3000; child-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; img-src blob: data: 'self' http://localhost:3000 https://localhost:3000;
signature: C7+C1WrVXbN1xnh9lRXt/lH5GRKc5bEFc9HU2Q9YYJHDsB7sEYsQ3xlr8Eg/FVFB7P9LrO4pNEVXXWqSCFN3j/vXPzNfIvVoXRTQwQTMVu8ohVwzveWfjcab7tKQ3wepUT8KWTolYPjVqsp/8cDrsIjDDnEsFjOpVGAn38rF8gpmhywcfGoUD4mrTn/C0YtJNTEdGY1zNxeDTcypCOvkU/wGXMf8lfbvLhWDVfja+nnSeaG8eHN7hNMEMfhsU958T/2WOIXZvkzZlV1inHQrbQphWOaKy3rS4AZ286QGMEJZgH5XGyIZyBqBGWZv14LKU4wiLe4e0L4mBEsCdvgBvg==
Content-Length: 407

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T04:51:07.330Z"
  },
  "sessionExpirationTime" : "2018-05-03T07:30Z",
  "sessionKey" : "de7dc2ab-eb75-40be-ac61-313f3158f47b",
  "sessionId" : "33d81784-7077-4d07-91a7-6b56810157b9",
  "identityModuleUrl" : "https://foo.bar/identitymodule/documents/view/aerakontraktversjon20200205.pdf?sid=33d81784-7077-4d07-91a7-6b56810157b9"
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/create-view-document-session' -i -X POST \
    -H 'Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg' \
    -H 'Accept: application/vnd.identitymodule.v1+json' \
    -d '{
  "documentId" : "3126d5fb-278f-4718-bb01-082498e9437b"
}'

6.4.11. White Label Wallet session

POST /identitymodule/create-wallet-ext-session
Description

Creates a Wallet Session with support for multiple payment methods.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CreateSessionExtWalletRequest

Responses
HTTP Code Description Schema

200

OK

CreateSessionResponse
Consumes

  • application/vnd.identitymodule.v1+json

  • application/json

Produces

  • application/vnd.identitymodule.v1+json

  • application/json

Tags

  • IdentityModules

Example HTTP request
POST /identitymodule/create-wallet-ext-session HTTP/1.1
Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg
Accept: application/vnd.identitymodule.v1+json
Content-Length: 1144
Host: api.aerahost.com

{
  "locale" : "no",
  "customStylingUrl" : "https://your.domain.com/a/path/custom-styling.css",
  "customerVerificationData" : {
    "cryptogram" : "AQGhQbCm2st3LuY6Orl5phixe1ViB0mDhECULixZW85EEsX3/SKiLm883s9a5+Aln82Sa+Ouj+ShA+XBPUpVwk5XjIfrsO7+dMBP5dZ5YkHR8974HiYHYVgRqWjK1Y6k7g66fgSCPagdCO7f0cMtjk6Ji27Pfnbn5ZP5hznfAln3ViJhb2bm+liEWVIiF2vF9T+CbAO47yrKDNdh6MltLSMC44/CU6SNiqakiZ9OVXOjPLo72UcQ7Ce+PloRMTH83FXC7xFiG/ukew/iN6R8cizw+HeUYlBEBDWD6ca1cYwx8YtwzJVuYK7rUA8TBZHvXgR5ATjPVnsZRBH7wb90dcyeB/tWWXbgpcq0LDF56OsNwB0BQuqRhUzBZ6M7CIfJWDR2J/2IFi1aOFkVMasQNs6y2QbLTo0ThSlKcty7fhxo0P6KbTGBJS7ZxN0hnayD9Is5OKgquuIaCrlY/JdHb+EwsIQdOOWUAJGnL+ycHoFEPfSDDI6zjdb3/gjhX3SnMkXUEK0p8XApMSyeVettb/tTXinChe1+YjAxrPiLNCkI8OAPAgAMGtHQ/qKn8vfz0YDKAwAkMTA0MENDRUMtRjM5OC00NDU0LUJEODgtMTdGRTUxRkMxNjI5",
    "nonce" : "LKEJlkejwn098435lhjdlfjLKJfdlkfs",
    "signedData" : "eyJhY3Rpb24iOiJvcGVuLXdhbGxldCIsInRpbWVzdGFtcCI6IjIwMTgtMDUtMDNUMDY6MDA6NTBaIn0="
  },
  "identifiers" : [ {
    "identifierValue" : "238923876293498",
    "identifierType" : "ADDITIONAL_ID"
  } ],
  "secure3dLevel" : "force",
  "singleInstrumentWallet" : false,
  "readOnlyMode" : false
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/vnd.identitymodule.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Security-Policy: default-src 'self' http://localhost:3000 https://localhost:3000; script-src 'self' http://localhost:3000 https://localhost:3000; frame-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; style-src 'self' http://localhost:3000 https://localhost:3000; font-src 'self' http://localhost:3000 https://localhost:3000; child-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; img-src blob: data: 'self' http://localhost:3000 https://localhost:3000;
signature: bxMhLq5/pyftSzXz0G0koUWQzRtNAGQtBEUM5EUIxJ3wItydrarj4VG1k8yLQzifcXPRKQJX5TiSesXM2mn+y5QBuAb4/dSLuG9f8xnsR9FjMqElKKhWgPYTjyLlcURGecDMeKsQIy8YiQD2P9HBDOiXv968kNrlNMVUoir8b6eAuF7Tt2/b5YlnHWcC60qf2D8PG/DLjUjRSwtxFy8lkGdEbm5dGCxEa/zIM82LnSTqoUwZ2DjOCdeQOemIHx5zFQvxUGllNgUAUP6/DnANMGXi1ZcbBqlkGEjXiuqlUfn7GPropamuqFqYwcgv1ZaXtHvi5kQSV+XIEBnKnJ2oPQ==
Content-Length: 514

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T04:51:00.541Z"
  },
  "sessionExpirationTime" : "2018-05-03T07:30Z",
  "sessionKey" : "de7dc2ab-eb75-40be-ac61-313f3158f47b",
  "sessionId" : "e0c75b53-e228-48b5-aa84-41ed9ec0b650",
  "identityModuleUrl" : "https://static.api-dev.aerahost.com/view/index.html?m=payment-overview&lang=no&css=https%3A%2F%2Fyour.domain.com%2Fa%2Fpath%2Fcustom-styling.css&sid=e0c75b53-e228-48b5-aa84-41ed9ec0b650&sk=de7dc2ab-eb75-40be-ac61-313f3158f47b"
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/create-wallet-ext-session' -i -X POST \
    -H 'Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg' \
    -H 'Accept: application/vnd.identitymodule.v1+json' \
    -d '{
  "locale" : "no",
  "customStylingUrl" : "https://your.domain.com/a/path/custom-styling.css",
  "customerVerificationData" : {
    "cryptogram" : "AQGhQbCm2st3LuY6Orl5phixe1ViB0mDhECULixZW85EEsX3/SKiLm883s9a5+Aln82Sa+Ouj+ShA+XBPUpVwk5XjIfrsO7+dMBP5dZ5YkHR8974HiYHYVgRqWjK1Y6k7g66fgSCPagdCO7f0cMtjk6Ji27Pfnbn5ZP5hznfAln3ViJhb2bm+liEWVIiF2vF9T+CbAO47yrKDNdh6MltLSMC44/CU6SNiqakiZ9OVXOjPLo72UcQ7Ce+PloRMTH83FXC7xFiG/ukew/iN6R8cizw+HeUYlBEBDWD6ca1cYwx8YtwzJVuYK7rUA8TBZHvXgR5ATjPVnsZRBH7wb90dcyeB/tWWXbgpcq0LDF56OsNwB0BQuqRhUzBZ6M7CIfJWDR2J/2IFi1aOFkVMasQNs6y2QbLTo0ThSlKcty7fhxo0P6KbTGBJS7ZxN0hnayD9Is5OKgquuIaCrlY/JdHb+EwsIQdOOWUAJGnL+ycHoFEPfSDDI6zjdb3/gjhX3SnMkXUEK0p8XApMSyeVettb/tTXinChe1+YjAxrPiLNCkI8OAPAgAMGtHQ/qKn8vfz0YDKAwAkMTA0MENDRUMtRjM5OC00NDU0LUJEODgtMTdGRTUxRkMxNjI5",
    "nonce" : "LKEJlkejwn098435lhjdlfjLKJfdlkfs",
    "signedData" : "eyJhY3Rpb24iOiJvcGVuLXdhbGxldCIsInRpbWVzdGFtcCI6IjIwMTgtMDUtMDNUMDY6MDA6NTBaIn0="
  },
  "identifiers" : [ {
    "identifierValue" : "238923876293498",
    "identifierType" : "ADDITIONAL_ID"
  } ],
  "secure3dLevel" : "force",
  "singleInstrumentWallet" : false,
  "readOnlyMode" : false
}'

6.4.12. Add account to wallet session

POST /identitymodule/create-wallet-ext-session/add-account
Description

Creates a Session where a payment account can be added to a wallet.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CreateSessionExtWalletAddAccountRequest

Responses
HTTP Code Description Schema

200

OK

CreateSessionResponse
Consumes

  • application/vnd.identitymodule.v1+json

  • application/json

Produces

  • application/vnd.identitymodule.v1+json

  • application/json

Tags

  • IdentityModules

Example HTTP request
POST /identitymodule/create-wallet-ext-session/add-account HTTP/1.1
Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg
Accept: application/vnd.identitymodule.v1+json
Content-Length: 972
Host: api.aerahost.com

{
  "locale" : "no",
  "customStylingUrl" : "https://your.domain.com/a/path/custom-styling.css",
  "customerVerificationData" : {
    "cryptogram" : "AQGhQbCm2st3LuY6Orl5phixe1ViB0mDhECULixZW85EEsX3/SKiLm883s9a5+Aln82Sa+Ouj+ShA+XBPUpVwk5XjIfrsO7+dMBP5dZ5YkHR8974HiYHYVgRqWjK1Y6k7g66fgSCPagdCO7f0cMtjk6Ji27Pfnbn5ZP5hznfAln3ViJhb2bm+liEWVIiF2vF9T+CbAO47yrKDNdh6MltLSMC44/CU6SNiqakiZ9OVXOjPLo72UcQ7Ce+PloRMTH83FXC7xFiG/ukew/iN6R8cizw+HeUYlBEBDWD6ca1cYwx8YtwzJVuYK7rUA8TBZHvXgR5ATjPVnsZRBH7wb90dcyeB/tWWXbgpcq0LDF56OsNwB0BQuqRhUzBZ6M7CIfJWDR2J/2IFi1aOFkVMasQNs6y2QbLTo0ThSlKcty7fhxo0P6KbTGBJS7ZxN0hnayD9Is5OKgquuIaCrlY/JdHb+EwsIQdOOWUAJGnL+ycHoFEPfSDDI6zjdb3/gjhX3SnMkXUEK0p8XApMSyeVettb/tTXinChe1+YjAxrPiLNCkI8OAPAgAMGtHQ/qKn8vfz0YDKAwAkMTA0MENDRUMtRjM5OC00NDU0LUJEODgtMTdGRTUxRkMxNjI5",
    "nonce" : "LKEJlkejwn098435lhjdlfjLKJfdlkfs",
    "signedData" : "eyJhY3Rpb24iOiJhZGQtdG8td2FsbGV0IiwidGltZXN0YW1wIjoiMjAxOC0wNS0wM1QwNjowMDo1MFoifQ=="
  },
  "psuIp" : "64.12.3.45"
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/vnd.identitymodule.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Security-Policy: default-src 'self' http://localhost:3000 https://localhost:3000; script-src 'self' http://localhost:3000 https://localhost:3000; frame-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; style-src 'self' http://localhost:3000 https://localhost:3000; font-src 'self' http://localhost:3000 https://localhost:3000; child-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; img-src blob: data: 'self' http://localhost:3000 https://localhost:3000;
signature: YyRcPmcXKJd4mTP2+lmjIEoacCGURcvrC3Bc1gALs58tedzUlGDkHwxtDGA8aLomu2lXP4u/VnfJIiMg4k2T6xflba2JY4lM/02hsFxUrCvE4R33yW9wprGCwv82jt+JmjoX+LFeW1d0Iu2f1QrwdKNRNGd4QYRx1/imX0ervEKbD/IjKYfityHE9CY0blkLzS5oiiHyyn0rD+gvglT+M2VchvZyfZ33ivBU1Vt+KD3lcf5foBwJEwNOijM/IdK38N1VtPiZ6cs/LjfjBEIuTFaaYhpPkME1aJBCnakUEBNE2GuaNhl6k05LMDwOaI4bDOhyU8C6qD/EBuC1KlK6MQ==
Content-Length: 529

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T04:51:07.532Z"
  },
  "sessionExpirationTime" : "2018-05-03T07:30Z",
  "sessionKey" : "de7dc2ab-eb75-40be-ac61-313f3158f47b",
  "sessionId" : "f6f25779-170d-48c8-9865-e0bead0949b8",
  "identityModuleUrl" : "https://static.api-dev.aerahost.com/view/index.html?m=payment-overview&lang=no&css=https%3A%2F%2Fyour.domain.com%2Fa%2Fpath%2Fcustom-styling.css&sm=add-account&sid=f6f25779-170d-48c8-9865-e0bead0949b8&sk=de7dc2ab-eb75-40be-ac61-313f3158f47b"
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/create-wallet-ext-session/add-account' -i -X POST \
    -H 'Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg' \
    -H 'Accept: application/vnd.identitymodule.v1+json' \
    -d '{
  "locale" : "no",
  "customStylingUrl" : "https://your.domain.com/a/path/custom-styling.css",
  "customerVerificationData" : {
    "cryptogram" : "AQGhQbCm2st3LuY6Orl5phixe1ViB0mDhECULixZW85EEsX3/SKiLm883s9a5+Aln82Sa+Ouj+ShA+XBPUpVwk5XjIfrsO7+dMBP5dZ5YkHR8974HiYHYVgRqWjK1Y6k7g66fgSCPagdCO7f0cMtjk6Ji27Pfnbn5ZP5hznfAln3ViJhb2bm+liEWVIiF2vF9T+CbAO47yrKDNdh6MltLSMC44/CU6SNiqakiZ9OVXOjPLo72UcQ7Ce+PloRMTH83FXC7xFiG/ukew/iN6R8cizw+HeUYlBEBDWD6ca1cYwx8YtwzJVuYK7rUA8TBZHvXgR5ATjPVnsZRBH7wb90dcyeB/tWWXbgpcq0LDF56OsNwB0BQuqRhUzBZ6M7CIfJWDR2J/2IFi1aOFkVMasQNs6y2QbLTo0ThSlKcty7fhxo0P6KbTGBJS7ZxN0hnayD9Is5OKgquuIaCrlY/JdHb+EwsIQdOOWUAJGnL+ycHoFEPfSDDI6zjdb3/gjhX3SnMkXUEK0p8XApMSyeVettb/tTXinChe1+YjAxrPiLNCkI8OAPAgAMGtHQ/qKn8vfz0YDKAwAkMTA0MENDRUMtRjM5OC00NDU0LUJEODgtMTdGRTUxRkMxNjI5",
    "nonce" : "LKEJlkejwn098435lhjdlfjLKJfdlkfs",
    "signedData" : "eyJhY3Rpb24iOiJhZGQtdG8td2FsbGV0IiwidGltZXN0YW1wIjoiMjAxOC0wNS0wM1QwNjowMDo1MFoifQ=="
  },
  "psuIp" : "64.12.3.45"
}'

6.4.13. Payer SCA session

POST /identitymodule/create-wallet-payer-sca-session
Description

Creates a Session to perform a strong customer authentication (SCA) on a payment instrument’s assurance method to get authentication data to be used to finalize a wallet payment.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CreateSessionWalletPayerSCARequest

Responses
HTTP Code Description Schema

200

OK

CreateSessionResponse
Consumes

  • application/vnd.identitymodule.v1+json

  • application/json

Produces

  • application/vnd.identitymodule.v1+json

  • application/json

Tags

  • IdentityModules

Example HTTP request
POST /identitymodule/create-wallet-payer-sca-session HTTP/1.1
Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg
Accept: application/vnd.identitymodule.v1+json
Content-Length: 1139
Host: api.aerahost.com

{
  "orderNumber" : "ORD0012345",
  "customerVerificationData" : {
    "cryptogram" : "AQGhQbCm2st3LuY6Orl5phixe1ViB0mDhECULixZW85EEsX3/SKiLm883s9a5+Aln82Sa+Ouj+ShA+XBPUpVwk5XjIfrsO7+dMBP5dZ5YkHR8974HiYHYVgRqWjK1Y6k7g66fgSCPagdCO7f0cMtjk6Ji27Pfnbn5ZP5hznfAln3ViJhb2bm+liEWVIiF2vF9T+CbAO47yrKDNdh6MltLSMC44/CU6SNiqakiZ9OVXOjPLo72UcQ7Ce+PloRMTH83FXC7xFiG/ukew/iN6R8cizw+HeUYlBEBDWD6ca1cYwx8YtwzJVuYK7rUA8TBZHvXgR5ATjPVnsZRBH7wb90dcyeB/tWWXbgpcq0LDF56OsNwB0BQuqRhUzBZ6M7CIfJWDR2J/2IFi1aOFkVMasQNs6y2QbLTo0ThSlKcty7fhxo0P6KbTGBJS7ZxN0hnayD9Is5OKgquuIaCrlY/JdHb+EwsIQdOOWUAJGnL+ycHoFEPfSDDI6zjdb3/gjhX3SnMkXUEK0p8XApMSyeVettb/tTXinChe1+YjAxrPiLNCkI8OAPAgAMGtHQ/qKn8vfz0YDKAwAkMTA0MENDRUMtRjM5OC00NDU0LUJEODgtMTdGRTUxRkMxNjI5",
    "nonce" : "QnV0aWtrZW4gcMOlIGhqw7hybmV0",
    "signedData" : "eyJnbG9iYWxMb2NhdGlvbk51bWJlciI6IjMwNjI0Njk2NjY0NjAiLCJtZXJjaGFudE5hbWUiOiJBZXJhIENhbmR5IiwiY3VycmVuY3kiOiJOT0siLCJncm9zc0Ftb3VudCI6IjEuMDAiLCJ0aW1lc3RhbXAiOiIyMDE4LTA1LTAzVDA2OjAwOjUwWiIsInRyYW5zYWN0aW9uSWQiOiIwNmI2ZGVlMS05YzE3LTQxODQtODQwNy0yZmNmZjg0OWQ1MTIifQ=="
  },
  "paymentInstrumentIdentifierId" : "1383405313c62eee814618634ed6ecb6e41ac712"
}
Example HTTP response
HTTP/1.1 403 Forbidden
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/vnd.identitymodule.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Security-Policy: default-src 'self' http://localhost:3000 https://localhost:3000; script-src 'self' http://localhost:3000 https://localhost:3000; frame-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; style-src 'self' http://localhost:3000 https://localhost:3000; font-src 'self' http://localhost:3000 https://localhost:3000; child-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; img-src blob: data: 'self' http://localhost:3000 https://localhost:3000;
Content-Length: 169

{
  "responseInfo" : {
    "message" : "Consumer has no active Aera Account capability",
    "responseCode" : "40007",
    "timeStamp" : "2025-08-13T04:51:10.640Z"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/create-wallet-payer-sca-session' -i -X POST \
    -H 'Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg' \
    -H 'Accept: application/vnd.identitymodule.v1+json' \
    -d '{
  "orderNumber" : "ORD0012345",
  "customerVerificationData" : {
    "cryptogram" : "AQGhQbCm2st3LuY6Orl5phixe1ViB0mDhECULixZW85EEsX3/SKiLm883s9a5+Aln82Sa+Ouj+ShA+XBPUpVwk5XjIfrsO7+dMBP5dZ5YkHR8974HiYHYVgRqWjK1Y6k7g66fgSCPagdCO7f0cMtjk6Ji27Pfnbn5ZP5hznfAln3ViJhb2bm+liEWVIiF2vF9T+CbAO47yrKDNdh6MltLSMC44/CU6SNiqakiZ9OVXOjPLo72UcQ7Ce+PloRMTH83FXC7xFiG/ukew/iN6R8cizw+HeUYlBEBDWD6ca1cYwx8YtwzJVuYK7rUA8TBZHvXgR5ATjPVnsZRBH7wb90dcyeB/tWWXbgpcq0LDF56OsNwB0BQuqRhUzBZ6M7CIfJWDR2J/2IFi1aOFkVMasQNs6y2QbLTo0ThSlKcty7fhxo0P6KbTGBJS7ZxN0hnayD9Is5OKgquuIaCrlY/JdHb+EwsIQdOOWUAJGnL+ycHoFEPfSDDI6zjdb3/gjhX3SnMkXUEK0p8XApMSyeVettb/tTXinChe1+YjAxrPiLNCkI8OAPAgAMGtHQ/qKn8vfz0YDKAwAkMTA0MENDRUMtRjM5OC00NDU0LUJEODgtMTdGRTUxRkMxNjI5",
    "nonce" : "QnV0aWtrZW4gcMOlIGhqw7hybmV0",
    "signedData" : "eyJnbG9iYWxMb2NhdGlvbk51bWJlciI6IjMwNjI0Njk2NjY0NjAiLCJtZXJjaGFudE5hbWUiOiJBZXJhIENhbmR5IiwiY3VycmVuY3kiOiJOT0siLCJncm9zc0Ftb3VudCI6IjEuMDAiLCJ0aW1lc3RhbXAiOiIyMDE4LTA1LTAzVDA2OjAwOjUwWiIsInRyYW5zYWN0aW9uSWQiOiIwNmI2ZGVlMS05YzE3LTQxODQtODQwNy0yZmNmZjg0OWQ1MTIifQ=="
  },
  "paymentInstrumentIdentifierId" : "1383405313c62eee814618634ed6ecb6e41ac712"
}'

6.4.14. Card wallet session

POST /identitymodule/create-wallet-session
Description

Creates a Wallet Session for managing payment cards.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
optional

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CreateSessionWalletRequest

Responses
HTTP Code Description Schema

200

OK

CreateSessionResponse
Consumes

  • application/vnd.identitymodule.v1+json

  • application/json

Produces

  • application/vnd.identitymodule.v1+json

  • application/json

Tags

  • IdentityModules

Example HTTP request
POST /identitymodule/create-wallet-session HTTP/1.1
Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg
Accept: application/vnd.identitymodule.v1+json
Content-Length: 384
Host: api.aerahost.com

{
  "locale" : "no",
  "customStylingUrl" : "https://your.domain.com/a/path/custom-styling.css",
  "identifiers" : [ {
    "identifierValue" : "+4794782976",
    "identifierType" : "MOBILE_NUMBER"
  }, {
    "identifierValue" : "238923876293498",
    "identifierType" : "ADDITIONAL_ID"
  } ],
  "secure3dLevel" : "force",
  "singleInstrumentWallet" : false,
  "readOnlyMode" : false
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/vnd.identitymodule.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Security-Policy: default-src 'self' http://localhost:3000 https://localhost:3000; script-src 'self' http://localhost:3000 https://localhost:3000; frame-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; style-src 'self' http://localhost:3000 https://localhost:3000; font-src 'self' http://localhost:3000 https://localhost:3000; child-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; img-src blob: data: 'self' http://localhost:3000 https://localhost:3000;
signature: Afwe7wYzrZjmToFjkdyPvHK5kk6MDwt3lS8veoRVmr/9wq8Jx9711yHfBVrTYWQa0K277fTSk8KAtGJSYJ/nZoCPs3W267NdwMpkqaHw+XrKqJOp5IOIX+4CZCNXSv+vNonR1sYy40cvgh0sVJQei+j19usNfInzCmsxeJJ4OiBer6Hx5zRVFWbOxzHZ7xdsG9LQN5LDSL1yOgOBsrTq2rnqhZNlY6MNI8BMy8ddvf5M/MVRw/qF83YheiPbVO/1HrjmNwFD95RS9g9p3xuZPH3OdY6spjt7ffifPcJyRgfMKcYsgsT+ZWK1+g7M4Jztazum6TzWLARBGGFIh/9PFg==
Content-Length: 514

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T04:51:10.070Z"
  },
  "sessionExpirationTime" : "2018-05-03T07:30Z",
  "sessionKey" : "de7dc2ab-eb75-40be-ac61-313f3158f47b",
  "sessionId" : "bad1c206-c12a-4636-8fbf-378f5cbc549b",
  "identityModuleUrl" : "https://static.api-dev.aerahost.com/view/index.html?m=payment-overview&lang=no&css=https%3A%2F%2Fyour.domain.com%2Fa%2Fpath%2Fcustom-styling.css&sid=bad1c206-c12a-4636-8fbf-378f5cbc549b&sk=de7dc2ab-eb75-40be-ac61-313f3158f47b"
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/create-wallet-session' -i -X POST \
    -H 'Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg' \
    -H 'Accept: application/vnd.identitymodule.v1+json' \
    -d '{
  "locale" : "no",
  "customStylingUrl" : "https://your.domain.com/a/path/custom-styling.css",
  "identifiers" : [ {
    "identifierValue" : "+4794782976",
    "identifierType" : "MOBILE_NUMBER"
  }, {
    "identifierValue" : "238923876293498",
    "identifierType" : "ADDITIONAL_ID"
  } ],
  "secure3dLevel" : "force",
  "singleInstrumentWallet" : false,
  "readOnlyMode" : false
}'

6.4.15. Add card to wallet session

POST /identitymodule/create-wallet-session/add-card
Description

Creates a Session where a payment card can be added to a wallet.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CreateSessionWalletAddCardRequest

Responses
HTTP Code Description Schema

200

OK

CreateSessionResponse
Consumes

  • application/vnd.identitymodule.v1+json

  • application/json

Produces

  • application/vnd.identitymodule.v1+json

  • application/json

Tags

  • IdentityModules

Example HTTP request
POST /identitymodule/create-wallet-session/add-card HTTP/1.1
Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg
Accept: application/vnd.identitymodule.v1+json
Content-Length: 971
Host: api.aerahost.com

{
  "locale" : "no",
  "customStylingUrl" : "https://your.domain.com/a/path/custom-styling.css",
  "customerVerificationData" : {
    "cryptogram" : "AQGhQbCm2st3LuY6Orl5phixe1ViB0mDhECULixZW85EEsX3/SKiLm883s9a5+Aln82Sa+Ouj+ShA+XBPUpVwk5XjIfrsO7+dMBP5dZ5YkHR8974HiYHYVgRqWjK1Y6k7g66fgSCPagdCO7f0cMtjk6Ji27Pfnbn5ZP5hznfAln3ViJhb2bm+liEWVIiF2vF9T+CbAO47yrKDNdh6MltLSMC44/CU6SNiqakiZ9OVXOjPLo72UcQ7Ce+PloRMTH83FXC7xFiG/ukew/iN6R8cizw+HeUYlBEBDWD6ca1cYwx8YtwzJVuYK7rUA8TBZHvXgR5ATjPVnsZRBH7wb90dcyeB/tWWXbgpcq0LDF56OsNwB0BQuqRhUzBZ6M7CIfJWDR2J/2IFi1aOFkVMasQNs6y2QbLTo0ThSlKcty7fhxo0P6KbTGBJS7ZxN0hnayD9Is5OKgquuIaCrlY/JdHb+EwsIQdOOWUAJGnL+ycHoFEPfSDDI6zjdb3/gjhX3SnMkXUEK0p8XApMSyeVettb/tTXinChe1+YjAxrPiLNCkI8OAPAgAMGtHQ/qKn8vfz0YDKAwAkMTA0MENDRUMtRjM5OC00NDU0LUJEODgtMTdGRTUxRkMxNjI5",
    "nonce" : "QnV0aWtrZW4gcMOlIGhqw7hybmV0",
    "signedData" : "eyJhY3Rpb24iOiJhZGQtdG8td2FsbGV0IiwidGltZXN0YW1wIjoiMjAxOC0wNS0wM1QwNjowMDo1MFoifQ=="
  },
  "secure3dLevel" : "force"
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/vnd.identitymodule.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Security-Policy: default-src 'self' http://localhost:3000 https://localhost:3000; script-src 'self' http://localhost:3000 https://localhost:3000; frame-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; style-src 'self' http://localhost:3000 https://localhost:3000; font-src 'self' http://localhost:3000 https://localhost:3000; child-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; img-src blob: data: 'self' http://localhost:3000 https://localhost:3000;
signature: RrRyb2yaP821w5XFTw6OzEHzpa0s080GPukLbMH8wGt2q2227TidUYgaXyWXyRhukoTXU+zOFCXZ3AbF5rlwcTfGXdjp78bolfWIuuiVv+0DsGL8/7qssr5gjS+ZbGhN4YZw0D0D61l8ui3mKIL0/XL9tsmL9MvOsg+Z2cnP6PywgBaOK4Aky0qWR5m/rETmly0f9ss2sk292wI4tEtYPSddmn0EAamB8kYxHoU4A58hDhinYndHk+aCseQotnaUzHnto5HAC9nf0a1fdXhfnFkYtULHRWCLuXZStyYvdZBFha2wPtzoM1Mww9zHRINULIZnwbw70Kzi4m9aIWHw4g==
Content-Length: 526

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T04:51:07.079Z"
  },
  "sessionExpirationTime" : "2018-05-03T07:30Z",
  "sessionKey" : "de7dc2ab-eb75-40be-ac61-313f3158f47b",
  "sessionId" : "1e2bcd94-119a-4404-9078-4c52233cc2c2",
  "identityModuleUrl" : "https://static.api-dev.aerahost.com/view/index.html?m=payment-overview&lang=no&css=https%3A%2F%2Fyour.domain.com%2Fa%2Fpath%2Fcustom-styling.css&sm=add-card&sid=1e2bcd94-119a-4404-9078-4c52233cc2c2&sk=de7dc2ab-eb75-40be-ac61-313f3158f47b"
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/create-wallet-session/add-card' -i -X POST \
    -H 'Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg' \
    -H 'Accept: application/vnd.identitymodule.v1+json' \
    -d '{
  "locale" : "no",
  "customStylingUrl" : "https://your.domain.com/a/path/custom-styling.css",
  "customerVerificationData" : {
    "cryptogram" : "AQGhQbCm2st3LuY6Orl5phixe1ViB0mDhECULixZW85EEsX3/SKiLm883s9a5+Aln82Sa+Ouj+ShA+XBPUpVwk5XjIfrsO7+dMBP5dZ5YkHR8974HiYHYVgRqWjK1Y6k7g66fgSCPagdCO7f0cMtjk6Ji27Pfnbn5ZP5hznfAln3ViJhb2bm+liEWVIiF2vF9T+CbAO47yrKDNdh6MltLSMC44/CU6SNiqakiZ9OVXOjPLo72UcQ7Ce+PloRMTH83FXC7xFiG/ukew/iN6R8cizw+HeUYlBEBDWD6ca1cYwx8YtwzJVuYK7rUA8TBZHvXgR5ATjPVnsZRBH7wb90dcyeB/tWWXbgpcq0LDF56OsNwB0BQuqRhUzBZ6M7CIfJWDR2J/2IFi1aOFkVMasQNs6y2QbLTo0ThSlKcty7fhxo0P6KbTGBJS7ZxN0hnayD9Is5OKgquuIaCrlY/JdHb+EwsIQdOOWUAJGnL+ycHoFEPfSDDI6zjdb3/gjhX3SnMkXUEK0p8XApMSyeVettb/tTXinChe1+YjAxrPiLNCkI8OAPAgAMGtHQ/qKn8vfz0YDKAwAkMTA0MENDRUMtRjM5OC00NDU0LUJEODgtMTdGRTUxRkMxNjI5",
    "nonce" : "QnV0aWtrZW4gcMOlIGhqw7hybmV0",
    "signedData" : "eyJhY3Rpb24iOiJhZGQtdG8td2FsbGV0IiwidGltZXN0YW1wIjoiMjAxOC0wNS0wM1QwNjowMDo1MFoifQ=="
  },
  "secure3dLevel" : "force"
}'

6.4.16. Onboarding/Initialize Wallet

POST /identitymodule/initialize-wallet
Description

Creates a session for onboarding/initializing to a Wallet. Performs SCA and creates an empty wallet.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CreateSessionWalletOnboardingRequest

Responses
HTTP Code Description Schema

200

OK

CreateSessionResponse
Consumes

  • application/vnd.identitymodule.v1+json

  • application/json

Produces

  • application/vnd.identitymodule.v1+json

  • application/json

Tags

  • IdentityModules

Example HTTP request
POST /identitymodule/initialize-wallet HTTP/1.1
Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg
x-amzn-trace-id: Root=1-6447581f-2cac0ac66d6fc6e50392a908;Parent=4759cdc47989ab1f;Sampled=1
x-amzn-requestid: b603ac3a-8806-4c3d-b9c7-cb966e966b24
Accept: application/vnd.identitymodule.v1+json
Content-Length: 551
Host: api.aerahost.com

{
  "locale" : "no",
  "identifiers" : [ {
    "identifierValue" : "kari.nordmann@foobar.com",
    "identifierType" : "EMAIL"
  }, {
    "identifierValue" : "238923876293498",
    "identifierType" : "ADDITIONAL_ID"
  }, {
    "identifierValue" : "17012099479",
    "identifierType" : "SSN"
  }, {
    "identifierValue" : "+4794782976",
    "identifierType" : "MOBILE_NUMBER"
  } ],
  "moduleFlags" : [ "skip-user-details", "verify-by-ssn", "verify-with-sdk-ticket" ],
  "mpaId" : "6220cf97-3221-46e0-8351-728bb4c1fe58",
  "onboardTo" : "AERAACCOUNT"
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/vnd.identitymodule.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Security-Policy: default-src 'self' http://localhost:3000 https://localhost:3000; script-src 'self' http://localhost:3000 https://localhost:3000; frame-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; style-src 'self' http://localhost:3000 https://localhost:3000; font-src 'self' http://localhost:3000 https://localhost:3000; child-src https://foo.bar 'self' http://localhost:3000 https://localhost:3000; img-src blob: data: 'self' http://localhost:3000 https://localhost:3000;
signature: VCqWRilMZ3Lke8vv45pvwdU03r4nO2k3EDO/qUX0K+mLqohIsXJd5nAvoyyEA7bNx997a8HL8oUARE3nSml6oHf5ofI89reVoz8ejBu5VO3s5uiQmMFKSa/dVWEkWzHpmutjMFsykPxVvpd3SNLzjbXK9RvNR8b6581elqGK8tzQ+DqXiLg5v5k4G53m8sfz+bGiRhnisVwFXbQKq4iVcT2bzU6Ux1p0xBer18zvlIx1sD4BT/vxNPZ1OBwVRpAUv8UGApT/yvBSIdXVakBXGs8UpEehnhpNVt2Pf5eVKXGM47UASojmi9WA3LOOcthg+uJfUiE8WTFSrD1ItGyeVA==
Content-Length: 451

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T04:51:07.799Z"
  },
  "sessionExpirationTime" : "2018-05-03T07:30Z",
  "sessionKey" : "de7dc2ab-eb75-40be-ac61-313f3158f47b",
  "sessionId" : "0efd93a1-352f-4b7c-807e-d543ba74856e",
  "identityModuleUrl" : "https://static.api-dev.aerahost.com/view/index.html?m=authenticate&lang=no&l=aera&sid=0efd93a1-352f-4b7c-807e-d543ba74856e&sk=de7dc2ab-eb75-40be-ac61-313f3158f47b"
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/initialize-wallet' -i -X POST \
    -H 'Content-Type: application/vnd.identitymodule.v1+json;charset=UTF-8' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2Iiwic2NvcGUiOlsiYWxsSWRlbnRpdHlNb2R1bGUiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.ETHpEjhVhuInEsVMIjA20G1_CAWtwTiKZUjc0s06AfjNtbEoyRfilAVugqyLcJQKGhkZx6AbNf4sjLwV_LmZAgTjZeRwh_WXKDSL3mTWZFeK0DQgkfKsUHQ8wBxoU9bdAIUy6nPmbavtWb7eJ0Mx-w-FdQocjaSw8EoL1M618vhj3jaMMz89hh3JncIf8pw3bsk9g3QRu5f6rwvV7WtJnZCwEAP3vnFF8qVcNM1R609N6arJl4hZYqrO2dzIoqbX2TpbKXFznlXY_S2aMSkeKILw7760HjkHxWH7KDpS0azjaV_FyziYVFjshbDSszsL8MnWgHT0t5T89AKBffbZSg' \
    -H 'x-amzn-trace-id: Root=1-6447581f-2cac0ac66d6fc6e50392a908;Parent=4759cdc47989ab1f;Sampled=1' \
    -H 'x-amzn-requestid: b603ac3a-8806-4c3d-b9c7-cb966e966b24' \
    -H 'Accept: application/vnd.identitymodule.v1+json' \
    -d '{
  "locale" : "no",
  "identifiers" : [ {
    "identifierValue" : "kari.nordmann@foobar.com",
    "identifierType" : "EMAIL"
  }, {
    "identifierValue" : "238923876293498",
    "identifierType" : "ADDITIONAL_ID"
  }, {
    "identifierValue" : "17012099479",
    "identifierType" : "SSN"
  }, {
    "identifierValue" : "+4794782976",
    "identifierType" : "MOBILE_NUMBER"
  } ],
  "moduleFlags" : [ "skip-user-details", "verify-by-ssn", "verify-with-sdk-ticket" ],
  "mpaId" : "6220cf97-3221-46e0-8351-728bb4c1fe58",
  "onboardTo" : "AERAACCOUNT"
}'

6.4.17. OIDC Public Keys Endpoint

GET /identitymodule/oidc/.well-known/jwks.json
Description

Returns the public keys used to validate the idToken

Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string
Responses
HTTP Code Description Schema

200

OK

< string, object > map
Produces

  • application/jwk-set+json

  • application/json

Tags

  • IdentityModules

Example HTTP request
GET /identitymodule/oidc/.well-known/jwks.json HTTP/1.1
Origin: https://foobar.com
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: Access-Control-Allow-Origin
Content-Type: application/jwk-set+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: MI03tTLcZwKZaq0i2M+5m2fNMwQDU5by4s6BpP9Gf4k9WyfY+Vz9P5de2TJkEpK45dxqQT9NSNUEmkrKDYt5BoQcLYmUTbXSuhBW/hsNVmqueEgaTPuSo670FXnf+NDH88+voin+sLG5zDeBTlIMjKRxP7D9uparSO7yVvncxyCkAJ6BY5pVVdi8kOdFavr3qTYeENuJcH9907ReOYqxuqjwUAr+cScS0YDBatASYEvuZN1cPNzvrmd1xuhz5k3cGEouYHk54tlSxHRBGpw7wUyxj4Ymw61pkt5VPw1/8BdknsP3yC3DPKYdb642auuTBoM5vLlDQh/ihjR93DZj4w==
Content-Length: 515

{
  "keys" : [ {
    "kty" : "RSA",
    "e" : "AQAB",
    "use" : "sig",
    "kid" : "7I9ECzKAti05VZbs8VoMYwYI3E_wHc7wtaW6zBvgPpA",
    "alg" : "RS256",
    "n" : "wZiGx_GKrQuhBJqR_4zTcyYid3tK2PA4tXkOnkZ4Onc2xqXflZYqyMnQdc9pDJvteTS8t0vOCcToh9WxYLbWbPKUQAv2WCRqZDMkQPw532Igcy8pVvC91MrxhAmSTz1XbNDwZGrfMmv4gvUVANQ9qPj58DgZIvxhTm3ZVfrsipTXmsj7v3Y-PJmDfHQgxYvUHZap8U8iGK5o6WGS3bvLAIorZsxcChejOwbIpM9L3E2LnWb5cgOe3x2AckiD9wLL4Qo5gw01J2MOdZT6EuZoTDAF8c31zZqVLBdcY3jxrq2ywCkvJB9iuiffc-P79IpXVwRAg93ujXpSCT0bQakL6Q"
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/oidc/.well-known/jwks.json' -i -X GET \
    -H 'Origin: https://foobar.com'

6.4.18. OIDC Configuration Endpoint

GET /identitymodule/oidc/.well-known/openid-configuration
Description

Returns the supported OIDC configuration

Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string
Responses
HTTP Code Description Schema

200

OK

OpenidConfiguration
Produces

  • application/json

Tags

  • IdentityModules

Example HTTP request
GET /identitymodule/oidc/.well-known/openid-configuration HTTP/1.1
Accept: application/json
Origin: https://foobar.com
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: Access-Control-Allow-Origin
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: qshNX5zo5TC17y61PLuykoC7cUpSpBKFIKKvevVt0Fhktwz0J0wR9kOHPjG/E5jXjIHNbrhknwhX7Q2ZXa3/WMMb07MmkREieVOH2nqHNTVwnKlwBiEeeZuDotvuOfmAda1Y64IbEo1iUUtPXWv4M8MsEIX4FgYKxJ8Y9A3QR/f8onmMSHssaobY6rNZluQKru4x3evXx2ltBk7Gp+3WwmN1ZYy+GZo3EmGeImDPPRon3B9odHC9Pd7YLeQsMhEyIawpjUfHVQQrpnldkSTlrbW2CMsBqZzuwv0AfMiHSagwnPbhbw634zA+vIh4PHd7CdymisIb/cLXLI3V56lHhw==
Content-Length: 1138

{
  "issuer" : "https://api.aerahost.com/identitymodule/oidc",
  "authorization_endpoint" : "https://api.aerahost.com/identitymodule/oidc/authorize",
  "token_endpoint" : "https://api.aerahost.com/identitymodule/oidc/token",
  "userinfo_endpoint" : "https://api.aerahost.com/identitymodule/oidc/userinfo",
  "jwks_uri" : "https://api.aerahost.com/identitymodule/oidc/.well-known/jwks.json",
  "scopes_supported" : [ "profile", "openid", "https://aera.id/scopes/nin_alias", "https://aera.id/scopes/nin", "https://aera.id/scopes/altsub", "https://aera.id/scopes/sign_sid" ],
  "response_types_supported" : [ "code" ],
  "response_modes_supported" : [ "query" ],
  "token_endpoint_auth_methods_supported" : [ "client_secret_basic", "client_secret_post" ],
  "grant_types_supported" : [ "authorization_code" ],
  "acr_values_supported" : [ "https://aera.id/identity-providers/nbid-substantial", "https://aera.id/identity-providers/nbid-oidc" ],
  "subject_types_supported" : [ "pairwise" ],
  "code_challenge_methods_supported" : [ "S256" ],
  "id_token_signing_alg_values_supported" : [ "RS256" ],
  "ui_locales_supported" : [ "en", "no" ]
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/oidc/.well-known/openid-configuration' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Origin: https://foobar.com'

6.4.19. OIDC Authorization Endpoint

GET /identitymodule/oidc/authorize
Description

The Authorization Endpoint performs Authentication of the End-User. This is done by sending the User Agent to the Authorization Server’s Authorization Endpoint for Authentication and Authorization, using request parameters defined by OAuth 2.0 and additional parameters and parameter values defined by OpenID Connect.

Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Query

acr_values
optional

OPTIONAL. Requested Authentication Context Class Reference values.
Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request.

string

Query

client_id
required

OAuth 2.0 Client Identifier valid at the Authorization Server.

string (uuid)

Query

code_challenge
optional

Hashed (SHA256) opaque value used to mitigate CSRF and code injection attacks amongst other (PKCE is defined in RFC7636). Must match sha256('code_verifier') in token request.

string

Query

code_challenge_method
optional

Method used to derive the code_challenge for PKCE.

enum (S256)

Query

login_hint
optional

OPTIONAL. Hint about an identifier of the end-user (e.g. the National Identity Number).

string

Query

nonce
optional

OPTIONAL. String value used to associate a Client session with an ID Token, and to mitigate replay attacks. The client must compare the nonce in the ID Token to the one sent in the authorization request and only proceeds if they match.

string

Query

redirect_uri
required

Redirection URI to which the response will be sent. MUST be pre-registered.

string

Query

response_type
required

OAuth 2.0 Response Type value that determines the authorization processing flow to be used, including what parameters are returned from the endpoints used. When using the Authorization Code Flow, this value is 'code'.

enum (code)

Query

scope
required

OpenID Connect requests MUST contain the 'openid' scope value. Scopes MUST be space delimited if more than one.

string

Query

state
required

Opaque value used to maintain state between the request and the callback. Used to protect against CSRF.

string

Query

tbs
optional

OPTIONAL. To Be Signed (TBS) data.
Must be base64 encoded. Required with scope 'sign_sid'

string

Query

ui_locales
optional

OPTIONAL. Locale for UI. If not set, the device local will be used.

enum (en, no)
Responses
HTTP Code Description Schema

302

Found

RedirectView
Produces

  • application/json

Tags

  • IdentityModules

Example HTTP request
GET /identitymodule/oidc/authorize?scope=openid+profile+https%3A%2F%2Faera.id%2Fscopes%2Faltsub+https%3A%2F%2Faera.id%2Fscopes%2Fnin+https%3A%2F%2Faera.id%2Fscopes%2Fnin_alias&response_type=code&client_id=b27bca3d-21da-4dcb-9421-0da9fb7e75e6&redirect_uri=https%3A%2F%2Fmerchant-domain.com%2Fcallback&code_challenge=E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM&code_challenge_method=S256&state=856ed956-9991-4d07-98d2-95129fd19f37&nonce=213890kljsdflk34&acr_values=https%3A%2F%2Faera.id%2Fidentity-providers%2Fnbid-oidc+https%3A%2F%2Faera.id%2Fidentity-providers%2Faera-basic+https%3A%2F%2Faera.id%2Fidentity-providers%2Ffreja-eid&ui_locales=no&login_hint=17012099479 HTTP/1.1
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 302 Found
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Language: en
Location: https://static.api-dev.aerahost.com/view/index.html?m=authenticate&lang=no&sm=oidc&curl=https%3A%2F%2Fmerchant-domain.com%2Fcallback%3Fstate%3D856ed956-9991-4d07-98d2-95129fd19f37&sid=e94e2b39-034a-484d-8887-1a5e1904fd29&sk=de7dc2ab-eb75-40be-ac61-313f3158f47b
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/oidc/authorize?scope=openid+profile+https%3A%2F%2Faera.id%2Fscopes%2Faltsub+https%3A%2F%2Faera.id%2Fscopes%2Fnin+https%3A%2F%2Faera.id%2Fscopes%2Fnin_alias&response_type=code&client_id=b27bca3d-21da-4dcb-9421-0da9fb7e75e6&redirect_uri=https%3A%2F%2Fmerchant-domain.com%2Fcallback&code_challenge=E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM&code_challenge_method=S256&state=856ed956-9991-4d07-98d2-95129fd19f37&nonce=213890kljsdflk34&acr_values=https%3A%2F%2Faera.id%2Fidentity-providers%2Fnbid-oidc+https%3A%2F%2Faera.id%2Fidentity-providers%2Faera-basic+https%3A%2F%2Faera.id%2Fidentity-providers%2Ffreja-eid&ui_locales=no&login_hint=17012099479' -i -X GET

6.4.20. OIDC Token Endpoint

POST /identitymodule/oidc/token
Description

To obtain an Access Token and an ID Token, the RP (Client) sends a Token Request to the Token Endpoint to obtain a Token Response, when using the Authorization Code Flow.

Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
optional

The Basic Authorization needed for client to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
optional

The x-api-key header needed to get access to the API services.

string

FormData

clientId
optional

OAuth 2.0 Client Identifier valid at the Authorization Server.

string

FormData

clientSecret
optional

OAuth 2.0 Client Secret matching the Client Identifier.

string

FormData

code
required

Authorization Code that was issued to the authenticated Client.

string

FormData

codeVerifier
optional

Original value of 'code_challenge' before it was hashed and encoded. See PKCE as defined in RFC7636.

string

FormData

grantType
required

Only supports grant_type 'authorization_code'.

object

FormData

redirectUri
required

Redirection URI used in authorization request.

string
Responses
HTTP Code Description Schema

200

OK

TokenResponse
Consumes

  • application/x-www-form-urlencoded

Produces

  • application/json

Tags

  • IdentityModules

Example HTTP request
POST /identitymodule/oidc/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: application/json
x-api-key: gbDFHJkljsdf982734sdf23
Authorization: Basic YjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2OlZlcnlTZWNyZXRQYXNzd29yZA==
Host: api.aerahost.com
Content-Length: 171

grant_type=authorization_code&code=8Bi6opuGVTMh0fut2i8u&redirect_uri=https%3A%2F%2Fmerchant-domain.com%2Fcallback&code_verifier=dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: Tu/j6UN/TSDtcLshVLz3/w/81AlLPn+QkBwGRx+TbRzHRBXwzfO7KVfGHxPJT9UZDjOKw9O8q08WJiojehyP2WwTidJG1oB3v1kEA3VIH0gnq7Bu/pRJLEQyPma385TerGnaphGHNTktaBmLwdq6+s0ZXhZ3ioaI8YRX3V2/Bfcr3t3QNULibzMPPqaWekJXCIvoHXqeiew76D4WtDedfA9sF8zi5xdXTQ//pl8sxYFGa+Dxr0j6uTy1A47OWCCuxOeJiaogLfVjxlGHd6tWFLZbEAkllc8ieTYlfd4AG76CeYzApe7jVgL0Zc2WzDgV8jg4nof/e8G4YXKVx7Whww==
Content-Length: 2544

{
  "access_token" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImF1dGhvcml6YXRpb25fY29kZSIsInNjb3BlIjpbImh0dHBzOi8vYWVyYS5pZC9zY29wZXMvbmluX2FsaWFzIiwiaHR0cHM6Ly9hZXJhLmlkL3Njb3Blcy9zaWduX3NpZCIsIm9wZW5pZCIsInByb2ZpbGUiLCJodHRwczovL2FlcmEuaWQvc2NvcGVzL25pbiIsImh0dHBzOi8vYWVyYS5pZC9zY29wZXMvYWx0c3ViIl0sInN1YiI6Ijk5NDYzOTliLWM3OTctNDJmZi04OGMwLTYyNTk1YWY5ZWQwNiIsImlzcyI6Imh0dHBzOi8vYXBpLmFlcmFob3N0LmNvbS9pZGVudGl0eW1vZHVsZS9vaWRjIiwiYXVkIjpbImIyN2JjYTNkLTIxZGEtNGRjYi05NDIxLTBkYTlmYjdlNzVlNiJdLCJuYmYiOjE3NTUwNjA2NjksImlhdCI6MTc1NTA2MDY2OSwiZXhwIjoxNzU1MDYxNTY5LCJqdGkiOiIzMTI2ZDVmYi0yNzhmLTQ3MTgtYmIwMS0wODI0OThlOTQzN2EifQ.U1Zvya52f8_VmTLAcIRQD37f1ONt0zcuwyZLzHcATS7AwtihlEJBRJMAueUxT7HNO5Swv7L6POfmdRRzHrHPIzBveLEPnz2_1Gw6UmzuU5h6dJe73wpIcFbzv8n5JgvA09XjcqTat3XkmZ3kZniIF1b2R_L1fEXUzFWk_RKFqgjPTATxcjBLBnC0LTVLO9_XyMHmg30wqUkZ6-GVnluukuIIPOOcQlqyohtVCMBTG2qrXoqhLdH_jMM5-CBV8S1RIoMA5ye6g99sF2cqx22xcVhSffmb6IJ_9PJT2Zc36MYQ8p3apJ8uXInpEKBALILx9HXM6NpXG7CDeEZN9TPowQ",
  "token_type" : "Bearer",
  "expires_in" : 900,
  "id_token" : "eyJraWQiOiI3STlFQ3pLQXRpMDVWWmJzOFZvTVl3WUkzRV93SGM3d3RhVzZ6QnZnUHBBIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiI5OTQ2Mzk5Yi1jNzk3LTQyZmYtODhjMC02MjU5NWFmOWVkMDYiLCJpc3MiOiJodHRwczovL2FwaS5hZXJhaG9zdC5jb20vaWRlbnRpdHltb2R1bGUvb2lkYyIsImF1ZCI6WyJiMjdiY2EzZC0yMWRhLTRkY2ItOTQyMS0wZGE5ZmI3ZTc1ZTYiXSwibmJmIjoxNzU1MDYwNjY5LCJpYXQiOjE3NTUwNjA2NjksImV4cCI6MTc1NTA2MTU2OSwianRpIjoiNjk0YTM0OTYtN2ZkNC00YjgzLWI0N2ItZGU2Y2VmZTIwMzhhIiwiYWNyIjoiaHR0cHM6Ly9hZXJhLmlkL2lkZW50aXR5LXByb3ZpZGVycy9uYmlkLW9pZGMiLCJhbXIiOlsibmJpZC1vaWRjIl0sImF0X2hhc2giOiJlaWU0VWhRVnRuSWFteHptcUhZOWpnIiwiY19oYXNoIjoiTE1aR3pCdmRQZFlpVjV6cWxtX0FlUSIsImh0dHBzOi8vYWVyYS5pZC9jbGFpbXMvaWRwIjoibmJpZC1vaWRjIiwibm9uY2UiOiIyMTM4OTBrbGpzZGZsazM0IiwibmFtZSI6IkthcmkgTm9yZG1hbm4iLCJiaXJ0aGRhdGUiOiIyMDIwLTAxLTE3IiwiaHR0cHM6Ly9hZXJhLmlkL2NsYWltcy9pZGVudGlmaWVyX3ZhbHVlIjoiOTU3OC02MDAwLTQtMzE5MjcyIiwiaHR0cHM6Ly9hZXJhLmlkL2NsYWltcy9pZGVudGlmaWVyX3R5cGUiOiJQSUQiLCJodHRwczovL2FlcmEuaWQvY2xhaW1zL25pbiI6IjE3MDEyMDk5NDc5IiwiaHR0cHM6Ly9hZXJhLmlkL2NsYWltcy9uaW5fdHlwZSI6Ik5JTl9OTyIsImh0dHBzOi8vYWVyYS5pZC9jbGFpbXMvbmluX2FsaWFzIjoiZmQzZWY0OTYtZTI1Yy00NWMwLTg5NGEtN2UzZmRkZGI5YTRjIn0.hmHb75QQpVkfl8wDHNrMmS4H9NTVuOzTf23ikdb1VFkM5yX3gNwJDKVeWJ9_ScosZ-Vz9QFW1dcQFxgMs1Qzunzx1dQqcny0rRnRE6LX7_eJ5KH3KJ9GzShj7j5CG235F9qMbQ-ay2gj-e7XN3GdX4qyDHvTS39A3LYuz-BXb_8xtcBck8UZZ0MDeZNdd33V2PMN7SjIeHIzZ3YRnWV_LDyQcyTaCSVrXoAwAh8V9adSdKcFO8PAs3B4x3pGu_nZ_Tch_I8jyunZhb3K7H7FVVK7b5zdauPgM-rGF4ruMjWeB4qbGf_8c_RnP4Bv-kVQx1YwcqLPu1lmPiyNhaOiFQ"
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/oidc/token' -i -u 'b27bca3d-21da-4dcb-9421-0da9fb7e75e6:VerySecretPassword' -X POST \
    -H 'Accept: application/json' \
    -H 'x-api-key: gbDFHJkljsdf982734sdf23' \
    -d 'grant_type=authorization_code&code=8Bi6opuGVTMh0fut2i8u&redirect_uri=https%3A%2F%2Fmerchant-domain.com%2Fcallback&code_verifier=dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk'

6.4.21. OIDC User Info Endpoint

GET /identitymodule/oidc/userinfo
Description

The UserInfo Endpoint is an OAuth 2.0 Protected Resource that returns Claims about the authenticated End-User. To obtain the requested Claims about the End-User, the Client makes a request to the UserInfo Endpoint using an Access Token obtained through OpenID Connect Authentication.

Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string
Responses
HTTP Code Description Schema

200

OK

UserInfoResponse
Produces

  • application/json

Tags

  • IdentityModules

Example HTTP request
GET /identitymodule/oidc/userinfo HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImF1dGhvcml6YXRpb25fY29kZSIsInNjb3BlIjpbIm9wZW5pZCIsInByb2ZpbGUiLCJodHRwczovL2FlcmEuaWQvc2NvcGVzL2FsdHN1YiIsImh0dHBzOi8vYWVyYS5pZC9zY29wZXMvbmluX2FsaWFzIl0sInN1YiI6IjAxMDg4ZjY0LTMxZGYtNDRmMy04ZDAwLTg4NGNlOWE3NTIyMSIsImlzcyI6Imh0dHBzOi8vYXBpLmFlcmFob3N0LmNvbS9pZGVudGl0eW1vZHVsZS9vaWRjIiwiYXVkIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2IiwibmJmIjoxNjEzNTg3ODc3LCJpYXQiOjE2MTM1ODc4NzcsImV4cCI6OTkxMzU4ODE3NywianRpIjoiMzEyNmQ1ZmItMjc4Zi00NzE4LWJiMDEtMDgyNDk4ZTk0MzdhIn0.paYWfk6L_C4e9sX-qE8Y2cBXJ_ZyFW_hKSvsNPI-ciGvJjvZK9vNxKTQ-RFh0AtS7V9Z7RyytCGX156Kw7tld9CuKiJP_Q73uEpN1kpMgWQgy5J7MxWi0cOCZFjhTyXM6Acj9Yet4Jf99jH3vra4EM7LI8L3qXduMPC8q8KO0KEUYait6YKC851wn6qryABT3fZFQrP5KhZ8GlQ1gN5JK3O92E50b5sDldLeV8WquTGwA2iV6DQwQy0DRSzL_AiN1uw-ns2vKpp6B5j1GPQ0_hjwUsgcEq0oPDwDP2EKypWHIU7NpnyJ_ek0IVUZq4qgk3zT7dexguzi0FBtrOW1Wg
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: N5d+vUf5jguNYy6tX6culmvNgBinZQzfgu/5mA8PNTZzhjxD5fNQMi5heb0qYqqIrd0LMtIoPdmaSwe4hJ3frPMHlIGvbrpiX+Go5eRRlif2yQYNixnuMNJFFclzVlOxb/EJ2dGKZgUhA727ZdvKTzo2EAMDxul9Svm0oCwjSJ8Ma/vOLmDKpqsPyA0RUQQ8j2Ws+JJJ56qV/Nj5WKhLIwFpPJS2opxaR/biY8LDS1wQgUl2uUZQ9EKfGg3/3NBpsx9MeifHVtY4ZRX/eMoed6zjfpsnD83wcBJTMt22khsWw6iuUuQGsmP3vJBknwpubqVBMzIOI/Ph1IZPtFPm1Q==
Content-Length: 357

{
  "name" : "Kari Nordmann",
  "birthdate" : "2020-01-17",
  "sub" : "01088f64-31df-44f3-8d00-884ce9a75221",
  "https://aera.id/claims/nin_alias" : "fd3ef496-e25c-45c0-894a-7e3fdddb9a4c",
  "https://aera.id/claims/nin_type" : "NIN_NO",
  "https://aera.id/claims/identifier_value" : "9578-6000-4-319272",
  "https://aera.id/claims/identifier_type" : "PID"
}
Example Curl request
$ curl 'https://api.aerahost.com/identitymodule/oidc/userinfo' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImF1dGhvcml6YXRpb25fY29kZSIsInNjb3BlIjpbIm9wZW5pZCIsInByb2ZpbGUiLCJodHRwczovL2FlcmEuaWQvc2NvcGVzL2FsdHN1YiIsImh0dHBzOi8vYWVyYS5pZC9zY29wZXMvbmluX2FsaWFzIl0sInN1YiI6IjAxMDg4ZjY0LTMxZGYtNDRmMy04ZDAwLTg4NGNlOWE3NTIyMSIsImlzcyI6Imh0dHBzOi8vYXBpLmFlcmFob3N0LmNvbS9pZGVudGl0eW1vZHVsZS9vaWRjIiwiYXVkIjoiYjI3YmNhM2QtMjFkYS00ZGNiLTk0MjEtMGRhOWZiN2U3NWU2IiwibmJmIjoxNjEzNTg3ODc3LCJpYXQiOjE2MTM1ODc4NzcsImV4cCI6OTkxMzU4ODE3NywianRpIjoiMzEyNmQ1ZmItMjc4Zi00NzE4LWJiMDEtMDgyNDk4ZTk0MzdhIn0.paYWfk6L_C4e9sX-qE8Y2cBXJ_ZyFW_hKSvsNPI-ciGvJjvZK9vNxKTQ-RFh0AtS7V9Z7RyytCGX156Kw7tld9CuKiJP_Q73uEpN1kpMgWQgy5J7MxWi0cOCZFjhTyXM6Acj9Yet4Jf99jH3vra4EM7LI8L3qXduMPC8q8KO0KEUYait6YKC851wn6qryABT3fZFQrP5KhZ8GlQ1gN5JK3O92E50b5sDldLeV8WquTGwA2iV6DQwQy0DRSzL_AiN1uw-ns2vKpp6B5j1GPQ0_hjwUsgcEq0oPDwDP2EKypWHIU7NpnyJ_ek0IVUZq4qgk3zT7dexguzi0FBtrOW1Wg'

6.5. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

6.5.1. CreateSessionAKBOnboardingRequest

Name Description Schema

customStylingUrl
optional

Custom css file sent in from a web URL which styles Identity Module after merchant preference
Length : 0 - 255
Pattern : "^?<Protocol>https?):\\/\\/(?<Domain>[\\w.:-]+)(?<Path>\\/?[\\w\\/-]*\\/)(?<Filename>[\\w\\/-]+.css?$"

string

customerVerificationData
optional

CustomerVerificationData

identifiers
optional

Set of identifiers (identifierdescription and identifierType) to be used in the module.

< ModuleIdentifier > array

locale
optional

Locale for displayed text.
If not set, the Consumer’s OS specific locale will be used.

enum (en, no)

moduleFlags
optional

Flags for adding/setting special behavior for the module.

< enum (verify-with-sdk-ticket, skip-user-details, verify-by-ssn) > array

mpaId
required

A pre-defined identificator identifying the (Mobile) Payment Application.

string (uuid)

sdkTicket
optional

The SDK Ticket. Used to start a wallet session based on SDK Initialization session.

string (uuid)

6.5.2. CreateSessionAuthenticateRequest

Name Description Schema

birthDate
optional

Date of birth with format ddMMyy. Used for BankID on Mobile.
Length : 6
Pattern : "^0)[1-9]|[1-2][0-9]|(3)[0-1])(((0)[1-9])|((1)[0-2]\\d{2}$"

string

customStylingUrl
optional

Custom css file sent in from a web URL which styles Identity Module after merchant preference
Length : 0 - 255
Pattern : "^?<Protocol>https?):\\/\\/(?<Domain>[\\w.:-]+)(?<Path>\\/?[\\w\\/-]*\\/)(?<Filename>[\\w\\/-]+.css?$"

string

identifiers
optional

Set of identifiers (identifierdescription and identifierType) to be used in the module.

< ModuleIdentifier > array

identityProviders
optional

Filter to reduce the list of identity providers (IDP) shown when starting authenticate/sign module.
If only 1, the chosen identity provider will start automatically.
If no value is set, all IDPs will be shown.

< enum (nbid-oidc, nbid-substantial, aera-basic, aera-webauth, freja-eid) > array

locale
optional

Locale for displayed text.
If not set, the Consumer’s OS specific locale will be used.

enum (en, no)

moduleFlags
optional

Flags for adding/setting special behavior for the module.

< enum (verify-with-sdk-ticket, skip-user-details, verify-by-ssn, sdk-initialization) > array

password
optional

The password to be used for authentication. DEPRECATED: use Authorization Header
Length : 0 - 255

string

username
optional

The username to be used for authentication. DEPRECATED: use Authorization Header
Length : 0 - 255

string

6.5.3. CreateSessionExtWalletAddAccountRequest

Name Description Schema

bank
optional

OPTIONAL. Only show account(s) for specific bank(s).
Length : 4 - 20
Pattern : "^[A-Za-z0-9-_]*$"

string

customStylingUrl
optional

Custom css file sent in from a web URL which styles Identity Module after merchant preference
Length : 0 - 255
Pattern : "^?<Protocol>https?):\\/\\/(?<Domain>[\\w.:-]+)(?<Path>\\/?[\\w\\/-]*\\/)(?<Filename>[\\w\\/-]+.css?$"

string

customerVerificationData
optional

CustomerVerificationData

identifiers
optional

Set of identifiers (identifierdescription and identifierType) to be used in the module.

< ModuleIdentifier > array

locale
optional

Locale for displayed text.
If not set, the Consumer’s OS specific locale will be used.

enum (en, no)

psuIp
required

The IP address of the PSU=Payment Service User, i.e. end-user device IP address.
Pattern : "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$"

string

sdkTicket
optional

The SDK Ticket. Used to start a wallet session based on SDK Initialization session.

string (uuid)

6.5.4. CreateSessionExtWalletRequest

Name Description Schema

cardBrandType
optional

Value to only allow a certain Card Brand Type. Default (if not set) is to allow all Card Brand Types.
'C' = Credit
'D' = Debit
'P' = Prepaid

enum (C, D, P)

customStylingUrl
optional

Custom css file sent in from a web URL which styles Identity Module after merchant preference
Length : 0 - 255
Pattern : "^?<Protocol>https?):\\/\\/(?<Domain>[\\w.:-]+)(?<Path>\\/?[\\w\\/-]*\\/)(?<Filename>[\\w\\/-]+.css?$"

string

customerVerificationData
optional

CustomerVerificationData

identifiers
optional

Set of identifiers (identifierdescription and identifierType) to be used in the module.

< ModuleIdentifier > array

locale
optional

Locale for displayed text.
If not set, the Consumer’s OS specific locale will be used.

enum (en, no)

readOnlyMode
optional

Value to set module in readOnly mode. Default is "false".

boolean

sdkTicket
optional

The SDK Ticket. Used to start a wallet session based on SDK Initialization session.

string (uuid)

secure3dLevel
optional

Type of enforcing of 3DSecure authentication when adding payment instrument to wallet. Default is "force".

enum (true, force)

singleInstrumentWallet
optional

Value to only show and be able to add one payment instrument into wallet. Default is "false".

boolean

6.5.5. CreateSessionResponse

Name Description Schema

identityModuleUrl
required

The URL to the Identity Module UI.
Minimum length : 1

string

responseInfo
optional

ResponseInfo

sessionExpirationTime
required

Session expiration time. Mandatory
Minimum length : 1

string

sessionId
required

The session id identifying the session.

string (uuid)

sessionKey
required

The next session key to be used for the established session.

string (uuid)

6.5.6. CreateSessionSignRequest

Name Description Schema

birthDate
optional

Date of birth with format ddMMyy. Used for BankID on Mobile.
Length : 6
Pattern : "^0)[1-9]|[1-2][0-9]|(3)[0-1])(((0)[1-9])|((1)[0-2]\\d{2}$"

string

customStylingUrl
optional

Custom css file sent in from a web URL which styles Identity Module after merchant preference
Length : 0 - 255
Pattern : "^?<Protocol>https?):\\/\\/(?<Domain>[\\w.:-]+)(?<Path>\\/?[\\w\\/-]*\\/)(?<Filename>[\\w\\/-]+.css?$"

string

dataToSign
required

DataToSign

identifiers
optional

Set of identifiers (identifierdescription and identifierType) to be used in the module.

< ModuleIdentifier > array

identityProviders
optional

Filter to reduce the list of identity providers (IDP) shown when starting authenticate/sign module.
If only 1, the chosen identity provider will start automatically.
If no value is set, all IDPs will be shown.

< enum (nbid-oidc, nbid-substantial, aera-basic, aera-webauth, freja-eid) > array

locale
optional

Locale for displayed text.
If not set, the Consumer’s OS specific locale will be used.

enum (en, no)

moduleFlags
optional

Flags for adding/setting special behavior for the module.

< enum (skip-user-details, verify-by-ssn, sign-pades) > array

password
optional

The password to be used for authentication. DEPRECATED: use Authorization Header
Length : 0 - 255

string

username
optional

The username to be used for authentication. DEPRECATED: use Authorization Header
Length : 0 - 255

string

6.5.7. CreateSessionViewDocumentRequest

Name Description Schema

customStylingUrl
optional

Custom css file sent in from a web URL which styles Identity Module after merchant preference
Length : 0 - 255
Pattern : "^?<Protocol>https?):\\/\\/(?<Domain>[\\w.:-]+)(?<Path>\\/?[\\w\\/-]*\\/)(?<Filename>[\\w\\/-]+.css?$"

string

documentId
required

The ID of the earlier signed document.

string (uuid)

locale
optional

Locale for displayed text.
If not set, the Consumer’s OS specific locale will be used.

enum (en, no)

password
optional

The password to be used for authentication. DEPRECATED: use Authorization Header
Length : 0 - 255

string

username
optional

The username to be used for authentication. DEPRECATED: use Authorization Header
Length : 0 - 255

string

6.5.8. CreateSessionWalletAddCardRequest

Name Description Schema

cardBrandType
optional

Value to only allow a certain Card Brand Type. Default (if not set) is to allow all Card Brand Types.
'C' = Credit
'D' = Debit
'P' = Prepaid

enum (C, D, P)

customStylingUrl
optional

Custom css file sent in from a web URL which styles Identity Module after merchant preference
Length : 0 - 255
Pattern : "^?<Protocol>https?):\\/\\/(?<Domain>[\\w.:-]+)(?<Path>\\/?[\\w\\/-]*\\/)(?<Filename>[\\w\\/-]+.css?$"

string

customerVerificationData
optional

CustomerVerificationData

identifiers
optional

Set of identifiers (identifierdescription and identifierType) to be used in the module.

< ModuleIdentifier > array

locale
optional

Locale for displayed text.
If not set, the Consumer’s OS specific locale will be used.

enum (en, no)

sdkTicket
optional

The SDK Ticket. Used to start a wallet session based on SDK Initialization session.

string (uuid)

secure3dLevel
optional

Type of enforcing of 3DSecure authentication when adding payment instrument to wallet. Default is "force".

enum (true, force)

6.5.9. CreateSessionWalletOnboardingRequest

Name Description Schema

customStylingUrl
optional

Custom css file sent in from a web URL which styles Identity Module after merchant preference
Length : 0 - 255
Pattern : "^?<Protocol>https?):\\/\\/(?<Domain>[\\w.:-]+)(?<Path>\\/?[\\w\\/-]*\\/)(?<Filename>[\\w\\/-]+.css?$"

string

customerVerificationData
optional

CustomerVerificationData

identifiers
optional

Set of identifiers (identifierdescription and identifierType) to be used in the module.

< ModuleIdentifier > array

locale
optional

Locale for displayed text.
If not set, the Consumer’s OS specific locale will be used.

enum (en, no)

moduleFlags
optional

Flags for adding/setting special behavior for the module.

< enum (verify-with-sdk-ticket, skip-user-details, verify-by-ssn) > array

mpaId
required

A pre-defined identificator identifying the (Mobile) Payment Application.

string (uuid)

onboardTo
required

Indicate first likely payment participating system to be added to wallet. Will onboard accordingly.

enum (AERAACCOUNT, BANKAXEPT, CARD)

sdkTicket
optional

The SDK Ticket. Used to start a wallet session based on SDK Initialization session.

string (uuid)

6.5.10. CreateSessionWalletPayerSCARequest

Name Description Schema

customStylingUrl
optional

Custom css file sent in from a web URL which styles Identity Module after merchant preference
Length : 0 - 255
Pattern : "^?<Protocol>https?):\\/\\/(?<Domain>[\\w.:-]+)(?<Path>\\/?[\\w\\/-]*\\/)(?<Filename>[\\w\\/-]+.css?$"

string

customerVerificationData
required

CustomerVerificationData

locale
optional

Locale for displayed text.
If not set, the Consumer’s OS specific locale will be used.

enum (en, no)

orderNumber
required

The order number (1-20 characters).
Together with transactionId (part of signedData) a unique reference set by the merchant.
Length : 3 - 20

string

paymentInstrumentIdentifierId
required

The IdentifierId of the payment instrument to use.
Length : 40
Pattern : "^[a-zA-Z0-9]+$"

string

6.5.11. CreateSessionWalletRequest

Name Description Schema

cardBrandType
optional

Value to only allow a certain Card Brand Type. Default (if not set) is to allow all Card Brand Types.
'C' = Credit
'D' = Debit
'P' = Prepaid

enum (C, D, P)

customStylingUrl
optional

Custom css file sent in from a web URL which styles Identity Module after merchant preference
Length : 0 - 255
Pattern : "^?<Protocol>https?):\\/\\/(?<Domain>[\\w.:-]+)(?<Path>\\/?[\\w\\/-]*\\/)(?<Filename>[\\w\\/-]+.css?$"

string

customerVerificationData
optional

CustomerVerificationData

identifiers
optional

Set of identifiers (identifierdescription and identifierType) to be used in the module.

< ModuleIdentifier > array

locale
optional

Locale for displayed text.
If not set, the Consumer’s OS specific locale will be used.

enum (en, no)

password
optional

The password to be used for authentication. DEPRECATED: use Authorization Header
Length : 0 - 255

string

readOnlyMode
optional

Value to set module in readOnly mode. Default is "false".

boolean

sdkTicket
optional

The SDK Ticket. Used to start a wallet session based on SDK Initialization session.

string (uuid)

secure3dLevel
optional

Type of enforcing of 3DSecure authentication when adding payment instrument to wallet. Default is "force".

enum (true, force)

singleInstrumentWallet
optional

Value to only show and be able to add one payment instrument into wallet. Default is "false".

boolean

username
optional

The username to be used for authentication. DEPRECATED: use Authorization Header
Length : 0 - 255

string

6.5.12. CustomerVerificationData

The customer verification data (CVD). Required to enable wallet management of accounts (enabled for payments).

Name Description Schema

cryptogram
required

The cryptogram.
Must be base64 encoded.
Length : 1 - 3000
Pattern : "^[-A-Za-z0-9+/]*={0,2}$"

string

nonce
required

The nonce.
Must be base64 encoded.
Length : 1 - 128
Pattern : "^[-A-Za-z0-9+/]*={0,2}$"

string

signedData
required

The signed data.
Must be base64 encoded.
Length : 1 - 2000
Pattern : "^[-A-Za-z0-9+/]*={0,2}$"

string

6.5.13. DataToSign

The document/text to be signed.
Mandatory if Module = 'sign'. Not relevant for other Modules.

Name Description Schema

contract
required

The contract to be signed. Must be Base64 encoded using UTF-8.
Minimum length : 1

string

description
required

A short description of the data to be signed (max 68 characters).
E.g. 'Document 1234567890, version 10.1'.
Will be concatenated with message digest of contract on BankID Mobil.
Length : 0 - 68

string

mimeType
required

The MimeType of the contract.

enum (text/plain, application/pdf, application/vnd.seid-sdo+json)

6.5.14. FindPaymentInstrumentsRequest

Name Description Schema

identifierType
required

IdentifierType defining the identifierValue used when identifying the wallet with payment instruments.
Example : "LOYALTY"

enum (PAY_CARD, PAY_ACCOUNT, EMAIL, MOBILE_NUMBER, ADDITIONAL_ID, WALLET_REF, ACCOUNT_NUMBER, LOYALTY, SSN, SSN_ALIAS, PID, FREJA_EID, ID_DOCUMENT_SN, HASH)

identifierValue
required

The value for the IdentifierType used when identifying the wallet with payment instruments.
Length : 0 - 255
Example : "LOY_123"

string

6.5.15. ModuleIdentifier

Set of identifiers (identifierdescription and identifierType) to be used in the module.

Name Description Schema

identifierType
required

The type of the Identifier.

enum (ADDITIONAL_ID, EMAIL, LOYALTY, MOBILE_NUMBER, SSN)

identifierValue
required

The description of the Identifier.
Length : 1 - 255

string

6.5.16. OpenidConfiguration

Name Schema

acr_values_supported
optional

< string > array

authorization_endpoint
optional

string

code_challenge_methods_supported
optional

< string > array

grant_types_supported
optional

< enum (authorization_code) > array

id_token_signing_alg_values_supported
optional

< string > array

issuer
optional

string

jwks_uri
optional

string

response_modes_supported
optional

< string > array

response_types_supported
optional

< enum (code) > array

scopes_supported
optional

< enum (openid, profile, https://aera.id/scopes/altsub, https://aera.id/scopes/nin, https://aera.id/scopes/nin_alias, https://aera.id/scopes/sign_sid) > array

subject_types_supported
optional

< string > array

token_endpoint
optional

string

token_endpoint_auth_methods_supported
optional

< string > array

ui_locales_supported
optional

< enum (en, no) > array

userinfo_endpoint
optional

string

6.5.17. PaymentInstrumentExt

Prioritized list of payment instruments.

Name Description Schema

assuranceMethod
required

Assurance method for the payment instrument. DELEGATED_SCA only require CVD to complete payment.

enum (DELEGATED_SCA, THIRD_PARTY, THREE_D_SECURE)

cardScheme
optional

The Card Scheme, mandatory when identifierType=PAY_CARD

string

cardType
optional

The Card Type. Valid values:
C = Credit
D = Debit
P = Prepaid
U = Unknown

enum (P, C, D, U)

defaultPaymentInstrument
optional

Indicates if the payment instrument is the default payment instrument in a wallet.

boolean

description
optional

A description/name for the payment instrument.

string

expirationdate
optional

The expiration date of the payment instrument.

string (date)

iconUrl
optional

A URL to a icon in SVG format (if requested) for the payment instrument.

string

identifierId
optional

The unique id for an identifier

string

identifierType
optional

The type of Identifier.

enum (PAY_CARD, PAY_ACCOUNT)

identifierValue
optional

A display safe value for the payment instrument.

string

paymentInstrumentType
optional

The Payment Instrument Type (PIT), will be mandatory when identifierType=PAY_CARD

string

priority
optional

The payment instrument priority.
Highest priority is 1, and is the recommended payment instrument to use.
Priority is from 1 to N, where N is the number of payment instruments in the list.

integer (int32)

provider
optional

The provider of the identifier.
E.g. The providing bank of an account number.

string

status
required

Status of the payment instrument. Only ACTIVE can be used for payments.

enum (ACTIVE, INACTIVE, SUSPENDED)

6.5.18. PaymentInstrumentsResponse

Name Description Schema

consumerId
optional

string

paymentInstruments
optional

Prioritized list of payment instruments.

< PaymentInstrumentExt > array

responseInfo
optional

ResponseInfo

6.5.19. ResponseInfo

Info object that can provide specific messages

Name Description Schema

externalResponseCode
optional

Additional response code from external systems.

string

message
optional

Specific response message

string

responseCode
required

Minimum length : 1

string

timeStamp
required

Timestamp. Mandatory
Minimum length : 1
Example : "2021-12-21T10:23:19.279Z"

string

6.5.20. TokenResponse

Name Description Schema

access_token
optional

The access token.

string

expires_in
optional

Seconds until the Access token expires.

integer (int64)

id_token
optional

The ID Token.

string

token_type
optional

The token type.

enum (Bearer)

6.5.21. UserInfoResponse

Name Description Schema

birthdate
optional

string

email
optional

string

https://aera.id/claims/identifier_type
optional

enum (PAY_CARD, PAY_ACCOUNT, EMAIL, MOBILE_NUMBER, ADDITIONAL_ID, WALLET_REF, ACCOUNT_NUMBER, LOYALTY, SSN, SSN_ALIAS, PID, FREJA_EID, ID_DOCUMENT_SN, HASH)

https://aera.id/claims/identifier_value
optional

string

https://aera.id/claims/nin
optional

string

https://aera.id/claims/nin_alias
optional

string (uuid)

https://aera.id/claims/nin_type
optional

string

name
optional

Given name and family name. Should be 'givenName + space + familyName', but there is no guarantee.
Example : "Kari Nordmann"

string

responseInfo
optional

ResponseInfo

sub
required

Subject - unique pairwise identifier for the subject.

string

6.5.22. VerifyResponse

Name Description Schema

dateOfBirth
required

The Date of Birth (DOB) of the Authenticated Identity.
The DOB is formatted ddMMyyyy.

string

documentId
optional

The ID of the Document that just has been signed.

string (uuid)

documentUrl
optional

The URL to the document that just has been signed.

string

identifierType
required

The IdentifierType for the unique user id for the IdentityProviderType.

enum (PAY_CARD, PAY_ACCOUNT, EMAIL, MOBILE_NUMBER, ADDITIONAL_ID, WALLET_REF, ACCOUNT_NUMBER, LOYALTY, SSN, SSN_ALIAS, PID, FREJA_EID, ID_DOCUMENT_SN, HASH)

identifierValue
required

The unique user id for the IdentityProviderType. Of type IdentifierType.

string

identityProvider
required

The identity provider (IDP) used during the authentication/signing process.

enum (nbid-oidc, nbid-substantial, aera-basic, aera-webauth, freja-eid)

pid
optional

The Personal ID (PID) of the Authenticated Identity.

string

responseInfo
optional

ResponseInfo

sdkId
optional

The SdkId of the newly SDK initialization.
Identificator that can be used to deactivate specific SDK.

string

sdkTicket
optional

The ticket that can be used directly to start a wallet session after SDK Initialization.

string (uuid)

ssn
optional

The Social Security Number.

string

ssnAlias
optional

An alias for the Social Security Number.

string (uuid)

subject
required

Subject ID of the Authenticated Identity. Unique per relying party (Data Controller).

string (uuid)

6.5.23. WalletAddAccountsRequest

Name Description Schema

accounts
required

Set of accounts to be added to wallet.

< string > array

customerVerificationData
optional

CustomerVerificationData

identifiers
optional

Set of identifiers (identifierValue and identifierType) to be used in the module.

< ModuleIdentifier > array

psuIp
optional

The IP address of the PSU=Payment Service User, i.e. end-user device IP address.
Pattern : "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$"

string

sdkTicket
optional

The SDK Ticket. Used to start a wallet session based on SDK Initialization session.

string (uuid)

6.5.24. WalletAddAccountsResponse

Name Description Schema

accountsStatus
required

Status of each account that were requested added to a wallet.

< string, ResponseInfo > map

responseInfo
optional

ResponseInfo

6.5.25. WalletBankRegisterNumbers

Name Description Schema

regNumbers
required

List of bank register numbers. It is the first 4 digits of an account number.

< string > array

6.5.26. WalletPayerScaTokenResponse

Name Schema

customerVerificationData
optional

CustomerVerificationData

responseInfo
optional

ResponseInfo

6.5.27. WalletSupportedBankRegisterNumbers

Name Description Schema

responseInfo
optional

ResponseInfo

supportedRegNumbers
optional

Set of supported bank register numbers with supported payment instrument type and bank name.

< WalletSupportedBankRegisterNumber > array

7. White Label Wallet (WLW)

The White Label Wallet (WLW) documentation will give a high-level introduction to WLW, explain how-to integrate, and contains API integration details.

WLW Table of Contents

Audience
Introduction
Actors / Abbreviations
Digital Payment Application (DPA)
Wallet Service Provider (WSP)
Payment Service Provider (PSP)
Sequence diagrams
Paths
Definitions

7.1. Audience

The Introduction and Actors / Abbreviations can be read by most readers, but the documentation is in general meant for IT Architects and Developers.

The Paths and Definitions chapters are detailed chapters meant for developers during their implementation

7.2. Introduction

The White Label Wallet (WLW) enables merchants to offer a customized Wallet solution in their merchant specific applications.

context illustration

A Wallet consists of several payment instruments enabling both payments in store and online.

The following describes components and processes required for integrating the White Label Wallet. It provides detailed descriptions of the main components and their roles in delivering secure, efficient payment and voucher management services.

The White Label Wallet allows users to seamlessly interact with their accounts, manage vouchers, and process payments while ensuring robust back-end security and functionality. These interactions occur through a series of structured APIs that facilitate communication between front-end applications and back-end systems. The APIs are designed to support authentication, voucher onboarding, payment processing, and balance management across various voucher types (e.g., meal vouchers, gift vouchers).

7.3. Actors / Abbreviations

Name Description

Merchant

The Aera customer using the Wallets SDK in their DPA

Consumer

The end-user of the DPA. The Identity linked to a specific wallet. Owner of various payment instruments.

DPA

Digital Payment Application: The merchant mobile app

DPA BE

The back-end of the DPA. Communicating with DPA and WSP.

PSP

Payment Service Provider: A service accepting electronic payments, in this regard supporting WLW payments. PSP acts as intermediaries between those who make payments (consumers) and those who accept them (merchants/retailers).

WSP

Wallet Service Provider: Providing a wallet solution to different DPAs. Responsible for communicating with WLW.

Wallets SDK

Android and iOS SDK integrated as part of the DPA, to simplify and secure communication with WLW.

WLW

White Label Wallet: A secure wallet customizable by the WSP, enabling connections to various PPS (Participating Payment System)

PPS

Participating Payment System is the types/schemes of payment instruments that can added to the wallet. E.g. Visa, MasterCard, BankAxept, Aera Account, Vouchers (Monizze, Edenred, Pluxee), and more …​

7.4. Digital Payment Application (DPA)

The Digital Payment Application is the application the consumer interacts with on their mobile device. The DPA works in conjunction with the Wallets SDK to send commands to initiate WLW sessions and payment sessions. The DPA must obtain a valid WLW session from the WSP (via DPA backend).

The DPA must also have an agreement with the WSP to access the specific wallet solution. It is not uncommon that DPA has a one-to-one relationship with the WSP.

The Wallets SDK and the Wallets SDK API documentation will be provided to the WSP upon agreement.

7.5. Wallet Service Provider (WSP)

The Wallet Service Provider is the owner of the specific Wallet solution. It is the intermediary backend responsible for managing all communication between the DPA and WLW.

(IN A LATER RELEASE) The Merchant/WSP can customize parts of the WLW user interface. It is configurable elements in WLW.

Customizable elements

  • brand colors

  • dark mode

  • logo

The WSP can also pick from a list of Participating Payment Systems (PPS) supported by WLW, that they want to support in their wallet solution. The WSP will normally provide the Wallet solution to one or more DPAs.

Separate DPA BE and WSP
Figure 15. Single DPA and DPA BE application

A good example for why you would separate the WSP into its own application, could be that you have multiple DPAs:

Multiple DPA and DPA BE
Figure 16. Multiple DPA and DPA BE

7.6. Payment Service Provider (PSP)

A merchant store uses a PSP with Aera White Label Wallet support, to initiate a payment request. The PSP is responsible for performing the payment towards the acquirer.

Detailed description on how to perform payments and the PSP will be delivered in later releases.

7.7. Sequence diagrams

7.7.1. Obtaining Access token and create a Wallets session

For communicating with the White Label Wallet you need to have a valid Aera AccessPSP Token. You can read more about what you need to Geting Started using the APIs and how to obtain AccessPSP Tokens.

For details about communication between DPA and Wallets SDK, please see the Wallets SDK API documentation. Can be obtained by having an agreement with Aera.

Create Session
Figure 17. Obtaining AccessPSP Token and Creating a White Label Wallet session.
Links to API documentation

7.7.2. POS/ECR initiated transaction

Payment Flow
Figure 18. POS/ECR calling PSP to initiate a wallet transaction

7.8. Wallets SDK

7.8.1. First time Onboarding

  1. Aera Secure ID WebView takes over display. Consumer must authenticate using SCA.

    Onboarding ItsMe

  2. Consumer must authenticate via App Pin. Biometrics are enforced, but not required.

    Create App pin
    Provide biometrics

  3. A Secure ID is created and a new WebView takes over, displaying the Wallets Dashboard

    Empty wallet dashboard

7.8.2. Authenticating existing wallet

  1. Aera Secure ID WebView takes over display.
    Consumer must authenticate via biometrics or App Pin.

    Verify with App pin
    Provide biometrics

  2. Secure ID is created and a new WebView takes over, displaying the Wallets Dashboard.

    Empty wallet dashboard

7.9. WLW APIs

7.9.1. Paths

Descriptions of resources/paths in the service.

Health
GET /wallets/health
Description

Provides a health endpoint to verify the status of the application

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Responses
HTTP Code Description Schema

200

OK

Status
Produces

  • application/json

Tags

  • Health

Example HTTP request
GET /wallets/health HTTP/1.1
Accept: application/json
Host: psp.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 21

{
  "status" : "UP"
}
Example Curl request
$ curl 'https://psp.aerahost.com/wallets/health' -i -X GET \
    -H 'Accept: application/json'
Create Wallet Session
POST /wallets/wsp/sessions
Description

This endpoint should only be used by authorized Wallet Service Providers (WSP), for a given Digital Payment Application (DPA).

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CreateSessionRequest

Responses
HTTP Code Description Schema

200

Create session response

CreateSessionResponse

401

Invalid client credentials

CommonResponse

403

Client not allowed to create wallet session.

CommonResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • WspSessionManagement

Example HTTP request
POST /wallets/wsp/sessions HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIndhbGxldHNXc3AiXSwic3ViIjoiOGM1YjU3YTQtYzMwYy00MDYwLWFhZTctYmFhMWI3NjkxOGQ3IiwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjpbImFlcmEudGVzdC1yZXNvdXJjZSJdLCJuYmYiOjE3MjI5MjcyODYsImlhdCI6MTcyMjkyNzI4NiwiZXhwIjo5OTIyOTMwODg2LCJqdGkiOiI3MmI1M2E3My1mNzFkLTRjMmItOWYwNS01MGJhZWRiZTkyMzEifQ.dJCfT3zaZypDUgE5g0Cg97NyNCXTwSvsNJKA221wW63I8j22A5NcNUey1NvWzZBboW9W0vTykazSQmYaTt1svV2A47SCEYAstlC913Cth-a-Osb2lC0nWzT-qccFUGbeEJS31wsf6XH6utcdj8uNkfdaEno8l4kfJSuaj3FDccH9NuVEMPoNdfH6bpBPPWgeKLDn7XpTwaJ77gmn2d28pcUiiSrIwc3eGNwtV9EQwIsg_Jmfcn3VZO7oDGKhL3HUKQN8aTWSiuVPdp2G736akRPSVr1uj2FT4lTnaELFSIUCh0HUFribsGDMyYQMtOIcrE3neEKBI2H6ZcHG4CaYZw
x-api-key: some-api-key
Accept: application/json
Content-Length: 54
Host: psp.aerahost.com

{
  "dpaId" : "ad1481f0-3c00-4abc-9a01-42a75e37a738"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: bXiSBJLbzVpFsYLIJ73M1XecdY+UTbn8DmviUyLSZaUP/vllUU1UGoa1YdtqdrSznFqg7I3ZnrA8pSqSBSybRv/lErmpoEB5pSedpEfLZiUnl6LcjT3f1q+8/cy5WcOaW0yTvPx5gWZDFRgEqcDshp/zOo76DrsAChRYoo33R1B2uZ+mHsvmWG9Q0IpU4STuIlafB4ZBzDWVDVy460cKuuo6so98FL2/pn/abcE2EtiqRPEcqWoOLWl0C/kJpD3KIP23oFeqMui5xPFRSiBOKfa8ivJe9F7j2u7U0TDpVZ3ulDKQ59TbWQaWrrVhbXNuSvr7c7IRvcklHiv6vUep5g==
Content-Length: 268

{
  "sessionKey" : "f9d47d03-e47d-410d-8edb-ac41d4a118e5",
  "sessionExpirationTime" : "2025-08-15T07:01:43.776Z",
  "sessionId" : "e22e8418-ed49-4393-b2ca-f9957729a6a8",
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T06:31:43.805Z"
  }
}
Example Curl request
$ curl 'https://psp.aerahost.com/wallets/wsp/sessions' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIndhbGxldHNXc3AiXSwic3ViIjoiOGM1YjU3YTQtYzMwYy00MDYwLWFhZTctYmFhMWI3NjkxOGQ3IiwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjpbImFlcmEudGVzdC1yZXNvdXJjZSJdLCJuYmYiOjE3MjI5MjcyODYsImlhdCI6MTcyMjkyNzI4NiwiZXhwIjo5OTIyOTMwODg2LCJqdGkiOiI3MmI1M2E3My1mNzFkLTRjMmItOWYwNS01MGJhZWRiZTkyMzEifQ.dJCfT3zaZypDUgE5g0Cg97NyNCXTwSvsNJKA221wW63I8j22A5NcNUey1NvWzZBboW9W0vTykazSQmYaTt1svV2A47SCEYAstlC913Cth-a-Osb2lC0nWzT-qccFUGbeEJS31wsf6XH6utcdj8uNkfdaEno8l4kfJSuaj3FDccH9NuVEMPoNdfH6bpBPPWgeKLDn7XpTwaJ77gmn2d28pcUiiSrIwc3eGNwtV9EQwIsg_Jmfcn3VZO7oDGKhL3HUKQN8aTWSiuVPdp2G736akRPSVr1uj2FT4lTnaELFSIUCh0HUFribsGDMyYQMtOIcrE3neEKBI2H6ZcHG4CaYZw' \
    -H 'x-api-key: some-api-key' \
    -H 'Accept: application/json' \
    -d '{
  "dpaId" : "ad1481f0-3c00-4abc-9a01-42a75e37a738"
}'
Delete wallet
DELETE /wallets/wsp/wallets/{sub}
Description

Will delete a wallet and all SDKs and Payment Instruments associated with it

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

sub
required

string (uuid)
Responses
HTTP Code Description Schema

200

Wallet deleted

CommonResponse

401

Invalid client credentials

CommonResponse

404

Wallet not found

CommonResponse
Produces

  • application/json

Tags

  • WspWalletsManagement

Example HTTP request
DELETE /wallets/wsp/wallets/5a493208-a67a-465b-9bc9-42f63d7718e9 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIndhbGxldHNXc3AiXSwic3ViIjoiOGM1YjU3YTQtYzMwYy00MDYwLWFhZTctYmFhMWI3NjkxOGQ3IiwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjpbImFlcmEudGVzdC1yZXNvdXJjZSJdLCJuYmYiOjE3MjI5MjcyODYsImlhdCI6MTcyMjkyNzI4NiwiZXhwIjo5OTIyOTMwODg2LCJqdGkiOiI3MmI1M2E3My1mNzFkLTRjMmItOWYwNS01MGJhZWRiZTkyMzEifQ.dJCfT3zaZypDUgE5g0Cg97NyNCXTwSvsNJKA221wW63I8j22A5NcNUey1NvWzZBboW9W0vTykazSQmYaTt1svV2A47SCEYAstlC913Cth-a-Osb2lC0nWzT-qccFUGbeEJS31wsf6XH6utcdj8uNkfdaEno8l4kfJSuaj3FDccH9NuVEMPoNdfH6bpBPPWgeKLDn7XpTwaJ77gmn2d28pcUiiSrIwc3eGNwtV9EQwIsg_Jmfcn3VZO7oDGKhL3HUKQN8aTWSiuVPdp2G736akRPSVr1uj2FT4lTnaELFSIUCh0HUFribsGDMyYQMtOIcrE3neEKBI2H6ZcHG4CaYZw
x-api-key: some-api-key
Accept: application/json
Host: psp.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: R4ktOMg8dwmC38oAhZ+wPWW3i9C7HRivgpWsMdr6icszNrhhZ5/OFp+pqbSc4cGL8gSnNpHBatTu+oxhWE7UgtH/zoMqMgDIKOVqUICjwoh50ZiWBMCSZAUVdzZLaZrgzCvQy/ncmoLgVRn7FA38qnLpGDD4ybu55cUknWPHeJmSft4Dq7oaE0/vlAWXcDKWjGLdcs3pp2m4hOWA2hkISu2wiZ//FjBqk81K1bhXUkbKZ6XkqDQkC0urK9MqNlf+NZoZ7lrI4eftX31qVihKTaz8DTIyuEa+Y+zGRS92/Hi8Ps2fznM3EmybP3OD4sLnv7NrykFcn5pGApcBF14hSw==
Content-Length: 147

{
  "responseInfo" : {
    "message" : "Successfully deleted wallet.",
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T06:31:34.393Z"
  }
}
Example Curl request
$ curl 'https://psp.aerahost.com/wallets/wsp/wallets/5a493208-a67a-465b-9bc9-42f63d7718e9' -i -X DELETE \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIndhbGxldHNXc3AiXSwic3ViIjoiOGM1YjU3YTQtYzMwYy00MDYwLWFhZTctYmFhMWI3NjkxOGQ3IiwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjpbImFlcmEudGVzdC1yZXNvdXJjZSJdLCJuYmYiOjE3MjI5MjcyODYsImlhdCI6MTcyMjkyNzI4NiwiZXhwIjo5OTIyOTMwODg2LCJqdGkiOiI3MmI1M2E3My1mNzFkLTRjMmItOWYwNS01MGJhZWRiZTkyMzEifQ.dJCfT3zaZypDUgE5g0Cg97NyNCXTwSvsNJKA221wW63I8j22A5NcNUey1NvWzZBboW9W0vTykazSQmYaTt1svV2A47SCEYAstlC913Cth-a-Osb2lC0nWzT-qccFUGbeEJS31wsf6XH6utcdj8uNkfdaEno8l4kfJSuaj3FDccH9NuVEMPoNdfH6bpBPPWgeKLDn7XpTwaJ77gmn2d28pcUiiSrIwc3eGNwtV9EQwIsg_Jmfcn3VZO7oDGKhL3HUKQN8aTWSiuVPdp2G736akRPSVr1uj2FT4lTnaELFSIUCh0HUFribsGDMyYQMtOIcrE3neEKBI2H6ZcHG4CaYZw' \
    -H 'x-api-key: some-api-key' \
    -H 'Accept: application/json'
Get Wallet details
GET /wallets/wsp/wallets/{sub}/details
Description

Getting customer data for an existing wallet

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

sub
required

string (uuid)

Query

getNin
optional

boolean
Responses
HTTP Code Description Schema

200

Wallet details object

WalletDetailsResponse

401

Invalid client credentials

CommonResponse

404

Wallet not found

CommonResponse
Produces

  • application/json

Tags

  • WspWalletsManagement

Example HTTP request
GET /wallets/wsp/wallets/5a493208-a67a-465b-9bc9-42f63d7718e9/details HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIndhbGxldHNXc3AiXSwic3ViIjoiOGM1YjU3YTQtYzMwYy00MDYwLWFhZTctYmFhMWI3NjkxOGQ3IiwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjpbImFlcmEudGVzdC1yZXNvdXJjZSJdLCJuYmYiOjE3MjI5MjcyODYsImlhdCI6MTcyMjkyNzI4NiwiZXhwIjo5OTIyOTMwODg2LCJqdGkiOiI3MmI1M2E3My1mNzFkLTRjMmItOWYwNS01MGJhZWRiZTkyMzEifQ.dJCfT3zaZypDUgE5g0Cg97NyNCXTwSvsNJKA221wW63I8j22A5NcNUey1NvWzZBboW9W0vTykazSQmYaTt1svV2A47SCEYAstlC913Cth-a-Osb2lC0nWzT-qccFUGbeEJS31wsf6XH6utcdj8uNkfdaEno8l4kfJSuaj3FDccH9NuVEMPoNdfH6bpBPPWgeKLDn7XpTwaJ77gmn2d28pcUiiSrIwc3eGNwtV9EQwIsg_Jmfcn3VZO7oDGKhL3HUKQN8aTWSiuVPdp2G736akRPSVr1uj2FT4lTnaELFSIUCh0HUFribsGDMyYQMtOIcrE3neEKBI2H6ZcHG4CaYZw
x-api-key: some-api-key
Accept: application/json
Host: psp.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: itPUzp5MnUouO4tw5ZIYg6BASu3eFI+Y7lYkXtzvvBmUHnW4QzcMEZSxNkNKm4nb5ekhMGukQxh0coRhPlH2q21x0bIWQQmVHjtT8LKZ6XgJkfON1QhxY2Kz0OVG3+HDInnCG8cO1/jdELG94R1Xr2iYyprF2pn5QyoB087sxnVoY9Eqd3zB9a/qyMLVcVt6XyP4dQsjDYHMrkxMa+vXjq4yxggPIlLUCNk773oUtfPgYESf/ht297/mTuy+yq8cIbzE2Olpj6o9iwXNXZo0/rrcvhoBehaoK+mNM/dEKUjCi035P4lYw8xJ+KQ+wthEL0/EWZAhHN+NhmPXNUMsbg==
Content-Length: 314

{
  "email" : "aera@aera.no",
  "fullName" : "aerauser",
  "loyaltyId" : "10010",
  "phoneNumber" : "+4798765432",
  "sub" : "5a493208-a67a-465b-9bc9-42f63d7718e9",
  "wspId" : "626286da-a2dd-4bdc-a79b-3fc0add6cd9a",
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T06:31:43.002Z"
  }
}
Example Curl request
$ curl 'https://psp.aerahost.com/wallets/wsp/wallets/5a493208-a67a-465b-9bc9-42f63d7718e9/details' -i -X GET \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIndhbGxldHNXc3AiXSwic3ViIjoiOGM1YjU3YTQtYzMwYy00MDYwLWFhZTctYmFhMWI3NjkxOGQ3IiwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjpbImFlcmEudGVzdC1yZXNvdXJjZSJdLCJuYmYiOjE3MjI5MjcyODYsImlhdCI6MTcyMjkyNzI4NiwiZXhwIjo5OTIyOTMwODg2LCJqdGkiOiI3MmI1M2E3My1mNzFkLTRjMmItOWYwNS01MGJhZWRiZTkyMzEifQ.dJCfT3zaZypDUgE5g0Cg97NyNCXTwSvsNJKA221wW63I8j22A5NcNUey1NvWzZBboW9W0vTykazSQmYaTt1svV2A47SCEYAstlC913Cth-a-Osb2lC0nWzT-qccFUGbeEJS31wsf6XH6utcdj8uNkfdaEno8l4kfJSuaj3FDccH9NuVEMPoNdfH6bpBPPWgeKLDn7XpTwaJ77gmn2d28pcUiiSrIwc3eGNwtV9EQwIsg_Jmfcn3VZO7oDGKhL3HUKQN8aTWSiuVPdp2G736akRPSVr1uj2FT4lTnaELFSIUCh0HUFribsGDMyYQMtOIcrE3neEKBI2H6ZcHG4CaYZw' \
    -H 'x-api-key: some-api-key' \
    -H 'Accept: application/json'
Update Wallet details
PATCH /wallets/wsp/wallets/{sub}/details
Description

Updating customer data on an existing wallet

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

sub
required

string (uuid)
Body parameter

Name : body
Flags : required
Type : UpdateWalletDetailsRequest

Responses
HTTP Code Description Schema

200

Wallet details object

WalletDetailsResponse

401

Invalid client credentials

CommonResponse

404

Wallet not found

CommonResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • WspWalletsManagement

Example HTTP request
PATCH /wallets/wsp/wallets/5a493208-a67a-465b-9bc9-42f63d7718e9/details HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIndhbGxldHNXc3AiXSwic3ViIjoiOGM1YjU3YTQtYzMwYy00MDYwLWFhZTctYmFhMWI3NjkxOGQ3IiwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjpbImFlcmEudGVzdC1yZXNvdXJjZSJdLCJuYmYiOjE3MjI5MjcyODYsImlhdCI6MTcyMjkyNzI4NiwiZXhwIjo5OTIyOTMwODg2LCJqdGkiOiI3MmI1M2E3My1mNzFkLTRjMmItOWYwNS01MGJhZWRiZTkyMzEifQ.dJCfT3zaZypDUgE5g0Cg97NyNCXTwSvsNJKA221wW63I8j22A5NcNUey1NvWzZBboW9W0vTykazSQmYaTt1svV2A47SCEYAstlC913Cth-a-Osb2lC0nWzT-qccFUGbeEJS31wsf6XH6utcdj8uNkfdaEno8l4kfJSuaj3FDccH9NuVEMPoNdfH6bpBPPWgeKLDn7XpTwaJ77gmn2d28pcUiiSrIwc3eGNwtV9EQwIsg_Jmfcn3VZO7oDGKhL3HUKQN8aTWSiuVPdp2G736akRPSVr1uj2FT4lTnaELFSIUCh0HUFribsGDMyYQMtOIcrE3neEKBI2H6ZcHG4CaYZw
x-api-key: some-api-key
Accept: application/json
Content-Length: 92
Host: psp.aerahost.com

{
  "email" : "new@email.com",
  "loyaltyId" : "a277cf46",
  "phoneNumber" : "+4722222222"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: pK85/zpmdhoUrsV3nachkGvCNkvKsRWjF4bDKhYZXT4nKk+wPSZ3L3Auc8gLI9waE9IepxxksysJzrPmHVSUM5zUV6y+dxSkJHswYsgY4MHNBqXL0/YbuPBdBu2KoJmBvYhyhDaa7KIrkbhtAEGCZaHf/5FPKVP/5gl+aFrSaJt6+aNVRn7LnSQ/n3p0iRbVxL16hCmiUQgUf8GQF9eJ0Um39RmMve7VmWl1tha5tTl3nsLUtMYoNIww3WiUr6MzxtLb+EdPKf3FQlfKuqahaDvaCQzLJGXVtMb2NSTVMYkgUcfOBE6h+V7GqI8xRuKkC9ILqhgZSRgafKZvw2/axg==
Content-Length: 318

{
  "email" : "new@email.com",
  "fullName" : "aerauser",
  "loyaltyId" : "a277cf46",
  "phoneNumber" : "+4722222222",
  "sub" : "5a493208-a67a-465b-9bc9-42f63d7718e9",
  "wspId" : "626286da-a2dd-4bdc-a79b-3fc0add6cd9a",
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T06:31:42.174Z"
  }
}
Example Curl request
$ curl 'https://psp.aerahost.com/wallets/wsp/wallets/5a493208-a67a-465b-9bc9-42f63d7718e9/details' -i -X PATCH \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIndhbGxldHNXc3AiXSwic3ViIjoiOGM1YjU3YTQtYzMwYy00MDYwLWFhZTctYmFhMWI3NjkxOGQ3IiwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjpbImFlcmEudGVzdC1yZXNvdXJjZSJdLCJuYmYiOjE3MjI5MjcyODYsImlhdCI6MTcyMjkyNzI4NiwiZXhwIjo5OTIyOTMwODg2LCJqdGkiOiI3MmI1M2E3My1mNzFkLTRjMmItOWYwNS01MGJhZWRiZTkyMzEifQ.dJCfT3zaZypDUgE5g0Cg97NyNCXTwSvsNJKA221wW63I8j22A5NcNUey1NvWzZBboW9W0vTykazSQmYaTt1svV2A47SCEYAstlC913Cth-a-Osb2lC0nWzT-qccFUGbeEJS31wsf6XH6utcdj8uNkfdaEno8l4kfJSuaj3FDccH9NuVEMPoNdfH6bpBPPWgeKLDn7XpTwaJ77gmn2d28pcUiiSrIwc3eGNwtV9EQwIsg_Jmfcn3VZO7oDGKhL3HUKQN8aTWSiuVPdp2G736akRPSVr1uj2FT4lTnaELFSIUCh0HUFribsGDMyYQMtOIcrE3neEKBI2H6ZcHG4CaYZw' \
    -H 'x-api-key: some-api-key' \
    -H 'Accept: application/json' \
    -d '{
  "email" : "new@email.com",
  "loyaltyId" : "a277cf46",
  "phoneNumber" : "+4722222222"
}'
Delete wallet sdks
DELETE /wallets/wsp/wallets/{sub}/sdks
Description

Will invalidate all SDKs for a given wallet (e.g. log out everywhere)

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

sub
required

string (uuid)
Responses
HTTP Code Description Schema

200

SDKs deleted

CommonResponse

401

Invalid client credentials

CommonResponse

404

Wallet not found

CommonResponse
Produces

  • application/json

Tags

  • WspWalletsManagement

Example HTTP request
DELETE /wallets/wsp/wallets/5a493208-a67a-465b-9bc9-42f63d7718e9/sdks HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIndhbGxldHNXc3AiXSwic3ViIjoiOGM1YjU3YTQtYzMwYy00MDYwLWFhZTctYmFhMWI3NjkxOGQ3IiwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjpbImFlcmEudGVzdC1yZXNvdXJjZSJdLCJuYmYiOjE3MjI5MjcyODYsImlhdCI6MTcyMjkyNzI4NiwiZXhwIjo5OTIyOTMwODg2LCJqdGkiOiI3MmI1M2E3My1mNzFkLTRjMmItOWYwNS01MGJhZWRiZTkyMzEifQ.dJCfT3zaZypDUgE5g0Cg97NyNCXTwSvsNJKA221wW63I8j22A5NcNUey1NvWzZBboW9W0vTykazSQmYaTt1svV2A47SCEYAstlC913Cth-a-Osb2lC0nWzT-qccFUGbeEJS31wsf6XH6utcdj8uNkfdaEno8l4kfJSuaj3FDccH9NuVEMPoNdfH6bpBPPWgeKLDn7XpTwaJ77gmn2d28pcUiiSrIwc3eGNwtV9EQwIsg_Jmfcn3VZO7oDGKhL3HUKQN8aTWSiuVPdp2G736akRPSVr1uj2FT4lTnaELFSIUCh0HUFribsGDMyYQMtOIcrE3neEKBI2H6ZcHG4CaYZw
x-api-key: some-api-key
Accept: application/json
Host: psp.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: lEJrbVhBfgnIPXU6exnScjY/+D1JQnGRMm5VloqJGaSPesrzEwGZfa4RkqOmDSYEen/ud+Jxk5CSv/08ppl2DDNb9R0JxRXjSg6UJ4RBZKTBMgOpsySDbginlpXX/0+twvcl3Lz+DeGYrv3j3GCTX9pyqTyhUQCCmUdzANgUlh26Nv5XCZENCv7XfH3kwTeOFQKRg3viFlcdKCWZiJsF8eXH32bA/ADHRvkmYu6amZ4w8+15VT7lWIq4OwMZ33jR1WxnXijgw0grMQGi+VONUL+jOLPsyrI4fgm8Ng5FntT4FR3w07Om1jvkA+LEzwS6dn3+u64klnYkY8bt7dyysw==
Content-Length: 159

{
  "responseInfo" : {
    "message" : "Successfully deleted all SDKs in wallet.",
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T06:31:31.442Z"
  }
}
Example Curl request
$ curl 'https://psp.aerahost.com/wallets/wsp/wallets/5a493208-a67a-465b-9bc9-42f63d7718e9/sdks' -i -X DELETE \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIndhbGxldHNXc3AiXSwic3ViIjoiOGM1YjU3YTQtYzMwYy00MDYwLWFhZTctYmFhMWI3NjkxOGQ3IiwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjpbImFlcmEudGVzdC1yZXNvdXJjZSJdLCJuYmYiOjE3MjI5MjcyODYsImlhdCI6MTcyMjkyNzI4NiwiZXhwIjo5OTIyOTMwODg2LCJqdGkiOiI3MmI1M2E3My1mNzFkLTRjMmItOWYwNS01MGJhZWRiZTkyMzEifQ.dJCfT3zaZypDUgE5g0Cg97NyNCXTwSvsNJKA221wW63I8j22A5NcNUey1NvWzZBboW9W0vTykazSQmYaTt1svV2A47SCEYAstlC913Cth-a-Osb2lC0nWzT-qccFUGbeEJS31wsf6XH6utcdj8uNkfdaEno8l4kfJSuaj3FDccH9NuVEMPoNdfH6bpBPPWgeKLDn7XpTwaJ77gmn2d28pcUiiSrIwc3eGNwtV9EQwIsg_Jmfcn3VZO7oDGKhL3HUKQN8aTWSiuVPdp2G736akRPSVr1uj2FT4lTnaELFSIUCh0HUFribsGDMyYQMtOIcrE3neEKBI2H6ZcHG4CaYZw' \
    -H 'x-api-key: some-api-key' \
    -H 'Accept: application/json'

7.9.2. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

CommonResponse
Name Schema

responseInfo
optional

ResponseInfo
CreateSessionRequest
Name Description Schema

dpaId
required

The id of the Digital Payment Application (DPA)

string (uuid)
CreateSessionResponse
Name Description Schema

responseInfo
optional

ResponseInfo

sessionExpirationTime
required

Session expiration time.
Minimum length : 1

string

sessionId
required

The session id identifying the session.

string (uuid)

sessionKey
required

The next session key to be used for the established session.

string (uuid)
ResponseInfo

Info object that can provide specific messages

Name Description Schema

externalResponseCode
optional

Additional response code from external systems.

string

message
optional

Specific response message

string

responseCode
required

Minimum length : 1

string

timeStamp
required

Timestamp. Mandatory
Minimum length : 1
Example : "2021-12-21T10:23:19.279Z"

string
Status
Name Schema

description
optional

string

status
optional

string
UpdateWalletDetailsRequest
Name Description Schema

email
optional

Length : 3 - 256
Pattern : "^(?=.{1,64}@)[a-zA-Z0-9_+&*\\-]+(?:\\.[a-zA-Z0-9_+&*\\-]+)*@(?=.{1,128}$)(?:[a-zA-Z0-9\\-]+\\.)+[a-zA-Z]{2,18}$"

string

loyaltyId
optional

Optional loyalty id if provided by WSP

string

phoneNumber
optional

Consumer phone number

string
WalletDetailsResponse
Name Description Schema

email
optional

User email address

string

fullName
required

Customer name
Minimum length : 1

string

idIssuerCountry
optional

The digital identity issuer country (based on the IDP).

string

loyaltyId
optional

Optional loyalty id (if provided by WSP)

string

phoneNumber
optional

Optional Consumer phone number (if provided by WSP

string

responseInfo
optional

ResponseInfo

sdkIds
optional

A set of SDK ids associated with this wallet

< string (uuid) > array

sub
required

Subject - unique pairwise identifier for the subject.

string (uuid)

wspId
required

Unique id identifying the WSP

string (uuid)

7.10. Demo PSP APIs

7.10.1. Paths

Descriptions of resources/paths in the service.

Initiate sale
POST /demo-wallet/demopsp/sale/wallet
Description

Demo endpoint for initiating a White Label Wallet sale.
NOTE: If amount is above 100 (of whatever currency), the request will fail intentionally.

Parameters
Type Name Description Schema

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string
Body parameter

Name : body
Flags : required
Type : WalletPaymentRequest

Responses
HTTP Code Description Schema

200

OK

WalletTransactionResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • DemoPSP

Example HTTP request
POST /demo-wallet/demopsp/sale/wallet HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInVjV2FsbGV0U2FsZSJdLCJzdWIiOiI4YzViNTdhNC1jMzBjLTQwNjAtYWFlNy1iYWExYjc2OTE4ZDciLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOlsiYWVyYS50ZXN0LXJlc291cmNlIl0sIm5iZiI6MTcyMjkyNzI4NiwiaWF0IjoxNzIyOTI3Mjg2LCJleHAiOjk5MzI5MjcyODYsImp0aSI6IjcyYjUzYTczLWY3MWQtNGMyYi05ZjA1LTUwYmFlZGJlOTIzMSJ9.DT-1t5B5Vn41yfxEkmztUp8YoeUrUJbstIwFkw8_l9JxaUEhUp6xmY62C0Y6vc5bjp3vRCGkysUCS6FjtT3E6oyogo-r8NDR0XfVvSBgEje6atHVWY3sgyw4Tz8wNnO4mx0y-ojOOz4CKtrQArUViUaCA063Vj4xrxcoDGxR9OWw1WNfrmU7yAmU9u7xmCDCaI6DboMiAmvWzjHOd6Zhsd6OeaQQJ-Ww-wvT6GPWQrP0pEMXf4YaOiKYkSEQZQ37KV9eS3hRGMYjiuijuc3-294F0c00Kraf_5Anhzw1Pvrro52cyWHhl9IPNHrW0X25d4rfNia1I2tZBGP3izjdQA
Accept: application/json
Content-Length: 444
Host: demo.aerahost.com

{
  "callbackUrl" : "https://example.com",
  "claimedUserIds" : [ {
    "cuid" : "12343456",
    "cuidType" : "LOYALTY"
  }, {
    "cuid" : "bcc4b2a0-872b-46f0-bf20-9339c133565b",
    "cuidType" : "SDKID"
  } ],
  "dpaId" : "b5d726b8-a882-47de-ace0-47dafa29cf93",
  "merchantId" : "922ba507-e223-4e4f-8b4d-8ae295963c92",
  "orderId" : "caf174bd-811b-4158-99d5-facc0178b9c9",
  "amountDetails" : {
    "amount" : 20,
    "currency" : "EUR"
  }
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: c+x22CoH1Li2K0cMBI7Sdbmc3FlJ5R7AgO4CJK7pwbzcrIfzSSGKTeCdXgZYILWz+9n93yAVPUenBf0ohttwz4sQ1tpU1uWJKTb4h023BE/eL+nMJXC4ILfZbpocpq3nLdP2noIHz1mCkuCx3SpTDPbcVDBPww6TJGt1uWwf6F4nZM6K1+xEFvG6PyJA0kOSqT4/IxuQlUW+t0D2HPrG9LCNETGW0SQJ1+ocrgpdxV0AT0rlH8SQ/199z4j/clM+BmbEMu98hP0ezvtK91yFplEgjXaM0Q0K/T6nLBiQa9QYLk8cvCFhLhwnYF3/kzmLZf72IYKK2QYfnHMu1sjyFg==
Content-Length: 183

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T10:55:58.802Z"
  },
  "transactionId" : "8fc09c2d-2249-44e6-9d43-774f03cbddad",
  "status" : "CREATED"
}
Example Curl request
$ curl 'https://demo.aerahost.com/demo-wallet/demopsp/sale/wallet' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInVjV2FsbGV0U2FsZSJdLCJzdWIiOiI4YzViNTdhNC1jMzBjLTQwNjAtYWFlNy1iYWExYjc2OTE4ZDciLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOlsiYWVyYS50ZXN0LXJlc291cmNlIl0sIm5iZiI6MTcyMjkyNzI4NiwiaWF0IjoxNzIyOTI3Mjg2LCJleHAiOjk5MzI5MjcyODYsImp0aSI6IjcyYjUzYTczLWY3MWQtNGMyYi05ZjA1LTUwYmFlZGJlOTIzMSJ9.DT-1t5B5Vn41yfxEkmztUp8YoeUrUJbstIwFkw8_l9JxaUEhUp6xmY62C0Y6vc5bjp3vRCGkysUCS6FjtT3E6oyogo-r8NDR0XfVvSBgEje6atHVWY3sgyw4Tz8wNnO4mx0y-ojOOz4CKtrQArUViUaCA063Vj4xrxcoDGxR9OWw1WNfrmU7yAmU9u7xmCDCaI6DboMiAmvWzjHOd6Zhsd6OeaQQJ-Ww-wvT6GPWQrP0pEMXf4YaOiKYkSEQZQ37KV9eS3hRGMYjiuijuc3-294F0c00Kraf_5Anhzw1Pvrro52cyWHhl9IPNHrW0X25d4rfNia1I2tZBGP3izjdQA' \
    -H 'Accept: application/json' \
    -d '{
  "callbackUrl" : "https://example.com",
  "claimedUserIds" : [ {
    "cuid" : "12343456",
    "cuidType" : "LOYALTY"
  }, {
    "cuid" : "bcc4b2a0-872b-46f0-bf20-9339c133565b",
    "cuidType" : "SDKID"
  } ],
  "dpaId" : "b5d726b8-a882-47de-ace0-47dafa29cf93",
  "merchantId" : "922ba507-e223-4e4f-8b4d-8ae295963c92",
  "orderId" : "caf174bd-811b-4158-99d5-facc0178b9c9",
  "amountDetails" : {
    "amount" : 20,
    "currency" : "EUR"
  }
}'
Get transaction status
GET /demo-wallet/demopsp/sale/wallet/transactions/{transactionId}
Description

Demo endpoint for getting status of a White Label Wallet transaction.

Parameters
Type Name Description Schema

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Path

transactionId
required

Transaction reference from WLW payment

string (uuid)
Responses
HTTP Code Description Schema

200

OK

WalletTransactionResponse
Produces

  • application/octet-stream

Tags

  • DemoPSP

Example HTTP request
GET /demo-wallet/demopsp/sale/wallet/transactions/56cde51a-6d4f-4e7e-ab42-559fe7a335ae HTTP/1.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInVjV2FsbGV0U2FsZSJdLCJzdWIiOiI4YzViNTdhNC1jMzBjLTQwNjAtYWFlNy1iYWExYjc2OTE4ZDciLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOlsiYWVyYS50ZXN0LXJlc291cmNlIl0sIm5iZiI6MTcyMjkyNzI4NiwiaWF0IjoxNzIyOTI3Mjg2LCJleHAiOjk5MzI5MjcyODYsImp0aSI6IjcyYjUzYTczLWY3MWQtNGMyYi05ZjA1LTUwYmFlZGJlOTIzMSJ9.DT-1t5B5Vn41yfxEkmztUp8YoeUrUJbstIwFkw8_l9JxaUEhUp6xmY62C0Y6vc5bjp3vRCGkysUCS6FjtT3E6oyogo-r8NDR0XfVvSBgEje6atHVWY3sgyw4Tz8wNnO4mx0y-ojOOz4CKtrQArUViUaCA063Vj4xrxcoDGxR9OWw1WNfrmU7yAmU9u7xmCDCaI6DboMiAmvWzjHOd6Zhsd6OeaQQJ-Ww-wvT6GPWQrP0pEMXf4YaOiKYkSEQZQ37KV9eS3hRGMYjiuijuc3-294F0c00Kraf_5Anhzw1Pvrro52cyWHhl9IPNHrW0X25d4rfNia1I2tZBGP3izjdQA
Accept: application/json
Host: demo.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: Cd6krH2lD2tRBf/7oLfiElafCoDqHhrdHg7C8N+AluOQl/K1Oq6FNihaQyEF36rWiSHygdCKoE+Qp/IfulpxJ+fA1UU+5PP2sV6lT/RDALLQpZxgKf9Vi/Wow7mlFkpoMf3ExLmz5zB6F35obFpMNJ3T1V1NHMZu+sLO1juHqZv9qtiSVZQJQ63HVy7CrYiH1F1XVgqTl1MRfqbY4X7C+6u/xpU2kAtZA6SNq87WqdSFjqb/qNbuU8WuJ9zRdY62bu2iKd+9j3HBA1d9SqtSpDEemm4QHO2ttc1lvc1SaGyiNk8qK/Lhh2ScoellMMkZlgNl+LTN6YiUiftuu4bBuQ==
Content-Length: 183

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T10:55:59.077Z"
  },
  "transactionId" : "5276f231-e982-4185-b856-76e3cf348477",
  "status" : "SUCCESS"
}
Example Curl request
$ curl 'https://demo.aerahost.com/demo-wallet/demopsp/sale/wallet/transactions/56cde51a-6d4f-4e7e-ab42-559fe7a335ae' -i -X GET \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInVjV2FsbGV0U2FsZSJdLCJzdWIiOiI4YzViNTdhNC1jMzBjLTQwNjAtYWFlNy1iYWExYjc2OTE4ZDciLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOlsiYWVyYS50ZXN0LXJlc291cmNlIl0sIm5iZiI6MTcyMjkyNzI4NiwiaWF0IjoxNzIyOTI3Mjg2LCJleHAiOjk5MzI5MjcyODYsImp0aSI6IjcyYjUzYTczLWY3MWQtNGMyYi05ZjA1LTUwYmFlZGJlOTIzMSJ9.DT-1t5B5Vn41yfxEkmztUp8YoeUrUJbstIwFkw8_l9JxaUEhUp6xmY62C0Y6vc5bjp3vRCGkysUCS6FjtT3E6oyogo-r8NDR0XfVvSBgEje6atHVWY3sgyw4Tz8wNnO4mx0y-ojOOz4CKtrQArUViUaCA063Vj4xrxcoDGxR9OWw1WNfrmU7yAmU9u7xmCDCaI6DboMiAmvWzjHOd6Zhsd6OeaQQJ-Ww-wvT6GPWQrP0pEMXf4YaOiKYkSEQZQ37KV9eS3hRGMYjiuijuc3-294F0c00Kraf_5Anhzw1Pvrro52cyWHhl9IPNHrW0X25d4rfNia1I2tZBGP3izjdQA' \
    -H 'Accept: application/json'
Cancel transaction
POST /demo-wallet/demopsp/sale/wallet/transactions/{transactionId}/cancel
Description

Demo endpoint for cancelling a White Label Wallet transaction.

Parameters
Type Name Schema

Path

transactionId
required

string (uuid)
Responses
HTTP Code Description Schema

200

OK

WalletTransactionResponse
Produces

  • application/octet-stream

Tags

  • DemoPSP

Example HTTP request
POST /demo-wallet/demopsp/sale/wallet/transactions/b56ebe1d-98b6-459a-b4b1-3f6a613c32c5/cancel HTTP/1.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInVjV2FsbGV0U2FsZSJdLCJzdWIiOiI4YzViNTdhNC1jMzBjLTQwNjAtYWFlNy1iYWExYjc2OTE4ZDciLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOlsiYWVyYS50ZXN0LXJlc291cmNlIl0sIm5iZiI6MTcyMjkyNzI4NiwiaWF0IjoxNzIyOTI3Mjg2LCJleHAiOjk5MzI5MjcyODYsImp0aSI6IjcyYjUzYTczLWY3MWQtNGMyYi05ZjA1LTUwYmFlZGJlOTIzMSJ9.DT-1t5B5Vn41yfxEkmztUp8YoeUrUJbstIwFkw8_l9JxaUEhUp6xmY62C0Y6vc5bjp3vRCGkysUCS6FjtT3E6oyogo-r8NDR0XfVvSBgEje6atHVWY3sgyw4Tz8wNnO4mx0y-ojOOz4CKtrQArUViUaCA063Vj4xrxcoDGxR9OWw1WNfrmU7yAmU9u7xmCDCaI6DboMiAmvWzjHOd6Zhsd6OeaQQJ-Ww-wvT6GPWQrP0pEMXf4YaOiKYkSEQZQ37KV9eS3hRGMYjiuijuc3-294F0c00Kraf_5Anhzw1Pvrro52cyWHhl9IPNHrW0X25d4rfNia1I2tZBGP3izjdQA
Accept: application/json
Host: demo.aerahost.com
Content-Type: application/x-www-form-urlencoded
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: bzbr0OTy2FXOcCdI3tr1y+EvU9kUbe/Q4U7+QmdmQ3Ndh8Ce5awUtXbLdZJvkD26Kc2sTOlCqdYwfuGTD53xOVf0XZdbC2VKYQCjCmPEiz6jpBNtMM9oimydagPTwMLXq+O+xL9yfiBHRtVzeu6ujtMKA2K8HivzOKVkPZrTVpfG33ryFRWDkAAEnMLhzmsW4+wvOTi3VciMJLPcNU+sgXuzqd5t94423COLd4Mu3X19cHrhCAjpE/qIIQF5Q+x164n3ENj/433Bf58IBlDTEEBi4bK879i2zV61/AIiDplVIPptTiWL7J13ABS+tA8M+clw/2M335NzXbU0gKGxJQ==
Content-Length: 184

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T10:55:59.163Z"
  },
  "transactionId" : "374f7e03-140f-42c8-9684-1fe0051e5952",
  "status" : "REJECTED"
}
Example Curl request
$ curl 'https://demo.aerahost.com/demo-wallet/demopsp/sale/wallet/transactions/b56ebe1d-98b6-459a-b4b1-3f6a613c32c5/cancel' -i -X POST \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInVjV2FsbGV0U2FsZSJdLCJzdWIiOiI4YzViNTdhNC1jMzBjLTQwNjAtYWFlNy1iYWExYjc2OTE4ZDciLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOlsiYWVyYS50ZXN0LXJlc291cmNlIl0sIm5iZiI6MTcyMjkyNzI4NiwiaWF0IjoxNzIyOTI3Mjg2LCJleHAiOjk5MzI5MjcyODYsImp0aSI6IjcyYjUzYTczLWY3MWQtNGMyYi05ZjA1LTUwYmFlZGJlOTIzMSJ9.DT-1t5B5Vn41yfxEkmztUp8YoeUrUJbstIwFkw8_l9JxaUEhUp6xmY62C0Y6vc5bjp3vRCGkysUCS6FjtT3E6oyogo-r8NDR0XfVvSBgEje6atHVWY3sgyw4Tz8wNnO4mx0y-ojOOz4CKtrQArUViUaCA063Vj4xrxcoDGxR9OWw1WNfrmU7yAmU9u7xmCDCaI6DboMiAmvWzjHOd6Zhsd6OeaQQJ-Ww-wvT6GPWQrP0pEMXf4YaOiKYkSEQZQ37KV9eS3hRGMYjiuijuc3-294F0c00Kraf_5Anhzw1Pvrro52cyWHhl9IPNHrW0X25d4rfNia1I2tZBGP3izjdQA' \
    -H 'Accept: application/json'

7.10.2. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

AmountDetails

Amount details for the Wallet payment request

Name Description Schema

additionalAmount
optional

The amount used in cashBack transactions

integer (int64)

amount
required

The amount to authorize in cents

integer (int64)

currency
required

The currency for the amount in ISO-4217 formatting using capital letters

enum (AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL)
ClaimedUserIdentifier

Claimed User IDs. Typically an SDK ID (or ideally a dynamic SDK ID) or some sort of additionalId/loyalty id (LOYALTY).

Name Description Schema

cuid
required

Claimed User ID. Typically an SDK ID or ideally a dynamic SDK ID.
Length : 8 - 50

string

cuidType
required

The type Claimed User ID.

enum (LOYALTY, SDKID, DYNAMIC_SDKID)
ResponseInfo

Info object that can provide specific messages

Name Description Schema

externalResponseCode
optional

Additional response code from external systems.

string

message
optional

Specific response message

string

responseCode
required

Minimum length : 1

string

timeStamp
required

Timestamp. Mandatory
Minimum length : 1
Example : "2021-12-21T10:23:19.279Z"

string
WalletPaymentRequest
Name Description Schema

amountDetails
required

AmountDetails

callbackUrl
required

The URL to receive the callback after the asynchronous operation is completed or has timed out.

string

claimedUserIds
required

Claimed User IDs. Typically an SDK ID (or ideally a dynamic SDK ID) or some sort of additionalId/loyalty id (LOYALTY).

< ClaimedUserIdentifier > array

dpaId
optional

The Mobile Payment Application ID

string (uuid)

merchantId
required

The merchant identifier
Length : 0 - 255
Pattern : "^[a-zA-Z0-9\\-]+$"

string

orderId
required

The orderId is used to link the customers specific order to the PSP transaction

string (uuid)
WalletTransactionResponse
Name Description Schema

responseInfo
optional

ResponseInfo

status
optional

Wallet Transaction Status - will start as CREATED and be updated according status of transaction.

enum (CREATED, INIT_WAIT, SIGN_WAIT, PPS_WAIT, PSP_WAIT, SUCCESS, EXPIRED, FAILED, REJECTED)

transactionId
optional

Wallet Transaction ID - a reference to the wallet transaction. Used when requesting status, and will be used as part of callback.

string (uuid)

7.11. Demo WSP APIs

7.11.1. Paths

Descriptions of resources/paths in the service.

Process WLW events
POST /demo-wsp/events
Description

Process incoming events regarding a wallet, e.g: new wallet onboarded.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string
Body parameter

Name : body
Flags : required
Type : WSPEventsRequest

Responses
HTTP Code Description Schema

200

Event accepted

CommonResponse

400

Bad Request

CommonResponse

404

Not Found

CommonResponse

500

Internal Server Error

CommonResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • DemoWSP

Example HTTP request
POST /wallets/events HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIndhbGxldHNBZG1pbiJdLCJzdWIiOiI4YzViNTdhNC1jMzBjLTQwNjAtYWFlNy1iYWExYjc2OTE4ZDciLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOlsiYWVyYS50ZXN0LXJlc291cmNlIl0sIm5iZiI6MTcyMjkyNzI4NiwiaWF0IjoxNzIyOTI3Mjg2LCJleHAiOjk5MzI5MjcyODYsImp0aSI6IjcyYjUzYTczLWY3MWQtNGMyYi05ZjA1LTUwYmFlZGJlOTIzMSJ9.oLjW9lMzx9NewN1JXhk9b6BBXVlgPoOTymuoBl2LyD-p9uPkhQWZ1cGpMTmsMjC2jwptNhKjfQzJlAbBDAtNhHnxoPgxkRI3q1dJnd17Lnwo5GKEjF-8zwP6xbf9YesHuRZvPnQS8B223E8iYiKXoDkrdrpZwf7r74xM67ulZEj6P6k7MdL_BHoHQ-EU2xc8R0AYS5DnEneCuv55DVzmhZjxtFllAcMeBXjo4iMcUHpYzUEd2OuyuwF2PukA50mgFYpZsE3De65lqJlyVjpZHFSLZ1OzphayGmhUQsm3rtanNNIGbFaY70F0GXF28IVInm-DkXxIf7OSN5jxk4PWeA
Accept: application/json
Content-Length: 522
Host: a.wsp.com

{
  "events" : [ {
    "sub" : "5a493208-a67a-465b-9bc9-42f63d7718e9",
    "type" : "ONBOARDING",
    "initiator" : "CONSUMER",
    "startTime" : "2025-08-15T06:33:59.233Z",
    "completionTime" : "2025-08-15T06:34:04.233Z",
    "statusCode" : "0",
    "statusReason" : "Wallets SDK onboarding successful.",
    "data" : {
      "sdkId" : [ "e999173b-0546-4586-8772-399586c63742" ],
      "sessionId" : [ "4b09ee86-079a-4411-a6ef-1dc7fa1b5438" ]
    },
    "idempotencyKey" : "2a9d85c8-faad-4ccb-95ef-75956da153e8"
  } ]
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: nXhQzNwvzQQtkZQGjkUmRbB1XdlUSL7QrJvvSTZP1/Av0dypew4kqua+runGXSve1x+pAiAknjpWs0Hkyk1ZoLmyrCBTbMvCGKmGL+ZQ+d7Ey8Z6VVWZSNY1s/Yqn2/EZufuWws758dZ4H27NCEXXHzwA5w8mZubn5VGLsC/B3nnXITJVcrn1aieRKhscP3SRXUXXPo8jARVe4+NljIKYL1sR/fp5m0eZLHXr/Y7GDt3ub8ot4+++eC3kkHtERQk/o7Th16W5bvHuuKRdn4j+Q78m5vlZzNuD7urAwg/LI0WI0p8ooIIlJ6X3bqqtWtQ9dTXk+4/4PNYbiPcjSodBA==
Content-Length: 99

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T06:33:59.256Z"
  }
}
Example Curl request
$ curl 'https://a.wsp.com/wallets/events' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIndhbGxldHNBZG1pbiJdLCJzdWIiOiI4YzViNTdhNC1jMzBjLTQwNjAtYWFlNy1iYWExYjc2OTE4ZDciLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOlsiYWVyYS50ZXN0LXJlc291cmNlIl0sIm5iZiI6MTcyMjkyNzI4NiwiaWF0IjoxNzIyOTI3Mjg2LCJleHAiOjk5MzI5MjcyODYsImp0aSI6IjcyYjUzYTczLWY3MWQtNGMyYi05ZjA1LTUwYmFlZGJlOTIzMSJ9.oLjW9lMzx9NewN1JXhk9b6BBXVlgPoOTymuoBl2LyD-p9uPkhQWZ1cGpMTmsMjC2jwptNhKjfQzJlAbBDAtNhHnxoPgxkRI3q1dJnd17Lnwo5GKEjF-8zwP6xbf9YesHuRZvPnQS8B223E8iYiKXoDkrdrpZwf7r74xM67ulZEj6P6k7MdL_BHoHQ-EU2xc8R0AYS5DnEneCuv55DVzmhZjxtFllAcMeBXjo4iMcUHpYzUEd2OuyuwF2PukA50mgFYpZsE3De65lqJlyVjpZHFSLZ1OzphayGmhUQsm3rtanNNIGbFaY70F0GXF28IVInm-DkXxIf7OSN5jxk4PWeA' \
    -H 'Accept: application/json' \
    -d '{
  "events" : [ {
    "sub" : "5a493208-a67a-465b-9bc9-42f63d7718e9",
    "type" : "ONBOARDING",
    "initiator" : "CONSUMER",
    "startTime" : "2025-08-15T06:33:59.233Z",
    "completionTime" : "2025-08-15T06:34:04.233Z",
    "statusCode" : "0",
    "statusReason" : "Wallets SDK onboarding successful.",
    "data" : {
      "sdkId" : [ "e999173b-0546-4586-8772-399586c63742" ],
      "sessionId" : [ "4b09ee86-079a-4411-a6ef-1dc7fa1b5438" ]
    },
    "idempotencyKey" : "2a9d85c8-faad-4ccb-95ef-75956da153e8"
  } ]
}'
Process WLW transaction init request
POST /demo-wsp/transactions/init
Description

Accept a WLW transaction init request, and forward it to the correct DPA.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string
Body parameter

Name : body
Flags : required
Type : WspTransactionInitRequest

Responses
HTTP Code Description Schema

200

Default success response

CommonResponse

400

Bad Request

CommonResponse

404

Not Found

CommonResponse

500

Internal Server Error

CommonResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • DemoWSP

Example HTTP request
POST /wallets/transactions/init HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIndhbGxldHNBZG1pbiJdLCJzdWIiOiI4YzViNTdhNC1jMzBjLTQwNjAtYWFlNy1iYWExYjc2OTE4ZDciLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOlsiYWVyYS50ZXN0LXJlc291cmNlIl0sIm5iZiI6MTcyMjkyNzI4NiwiaWF0IjoxNzIyOTI3Mjg2LCJleHAiOjk5MzI5MjcyODYsImp0aSI6IjcyYjUzYTczLWY3MWQtNGMyYi05ZjA1LTUwYmFlZGJlOTIzMSJ9.oLjW9lMzx9NewN1JXhk9b6BBXVlgPoOTymuoBl2LyD-p9uPkhQWZ1cGpMTmsMjC2jwptNhKjfQzJlAbBDAtNhHnxoPgxkRI3q1dJnd17Lnwo5GKEjF-8zwP6xbf9YesHuRZvPnQS8B223E8iYiKXoDkrdrpZwf7r74xM67ulZEj6P6k7MdL_BHoHQ-EU2xc8R0AYS5DnEneCuv55DVzmhZjxtFllAcMeBXjo4iMcUHpYzUEd2OuyuwF2PukA50mgFYpZsE3De65lqJlyVjpZHFSLZ1OzphayGmhUQsm3rtanNNIGbFaY70F0GXF28IVInm-DkXxIf7OSN5jxk4PWeA
Accept: application/json
Content-Length: 484
Host: a.wsp.com

{
  "status" : "CREATED",
  "transactionId" : "178ea2d1-974b-4ec1-af92-30dea290bb40",
  "user" : {
    "cuids" : [ {
      "cuid" : "10010",
      "cuidType" : "LOYALTY"
    }, {
      "cuid" : "73a8f576-c23a-47dc-9be6-b29d83faa86c",
      "cuidType" : "SDKID"
    } ]
  },
  "session" : {
    "sessionExpirationTime" : "2025-08-15T07:03:59.930286631Z[Etc/UTC]",
    "sessionId" : "61fa26ff-516a-4e42-a431-12f4760c03b1",
    "sessionKey" : "a17896a5-6120-4643-9347-2c0ec2317484"
  }
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: m4Q5QE0i0cGd/VxapGhWSXW8A/l/kcb0rILjmz8dgQgT2fTZI1mPAxHGr2JBPoTH2hizzPbbPYAL4pu/iZwiBM+i8DZjpEJJSH1ltZjiJXJeRfpjmwdf9FkgH4G8rQPjOLQFupKdVVUynLZfIGmk1AALsqDplmWj8BYXMgAI/tNi94si/j8fupy/l/1bb8UYypd/JqRVwtLh5J6lBolCdmktZIK04nveSUtr2Yj0kFlpHeZbC2tGcn5T4th3nWMJ6X4/440W2jLh5sxYBAm42TXO9fwzkFNS0sKYgyDxcKhBtrfBXTkWN8eyFlpUOjxIlUfHDaCujBxyrXccnOD00A==
Content-Length: 99

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T06:33:59.944Z"
  }
}
Example Curl request
$ curl 'https://a.wsp.com/wallets/transactions/init' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIndhbGxldHNBZG1pbiJdLCJzdWIiOiI4YzViNTdhNC1jMzBjLTQwNjAtYWFlNy1iYWExYjc2OTE4ZDciLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOlsiYWVyYS50ZXN0LXJlc291cmNlIl0sIm5iZiI6MTcyMjkyNzI4NiwiaWF0IjoxNzIyOTI3Mjg2LCJleHAiOjk5MzI5MjcyODYsImp0aSI6IjcyYjUzYTczLWY3MWQtNGMyYi05ZjA1LTUwYmFlZGJlOTIzMSJ9.oLjW9lMzx9NewN1JXhk9b6BBXVlgPoOTymuoBl2LyD-p9uPkhQWZ1cGpMTmsMjC2jwptNhKjfQzJlAbBDAtNhHnxoPgxkRI3q1dJnd17Lnwo5GKEjF-8zwP6xbf9YesHuRZvPnQS8B223E8iYiKXoDkrdrpZwf7r74xM67ulZEj6P6k7MdL_BHoHQ-EU2xc8R0AYS5DnEneCuv55DVzmhZjxtFllAcMeBXjo4iMcUHpYzUEd2OuyuwF2PukA50mgFYpZsE3De65lqJlyVjpZHFSLZ1OzphayGmhUQsm3rtanNNIGbFaY70F0GXF28IVInm-DkXxIf7OSN5jxk4PWeA' \
    -H 'Accept: application/json' \
    -d '{
  "status" : "CREATED",
  "transactionId" : "178ea2d1-974b-4ec1-af92-30dea290bb40",
  "user" : {
    "cuids" : [ {
      "cuid" : "10010",
      "cuidType" : "LOYALTY"
    }, {
      "cuid" : "73a8f576-c23a-47dc-9be6-b29d83faa86c",
      "cuidType" : "SDKID"
    } ]
  },
  "session" : {
    "sessionExpirationTime" : "2025-08-15T07:03:59.930286631Z[Etc/UTC]",
    "sessionId" : "61fa26ff-516a-4e42-a431-12f4760c03b1",
    "sessionKey" : "a17896a5-6120-4643-9347-2c0ec2317484"
  }
}'
Process WLW transaction result request
POST /demo-wsp/transactions/result
Description

Accept a WLW transaction result after a transaction is complete/failed, and possibly forward to correct DPA.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string
Body parameter

Name : body
Flags : required
Type : WspTransactionResultRequest

Responses
HTTP Code Description Schema

200

Default success response

CommonResponse

400

Bad Request

CommonResponse

404

Not Found

CommonResponse

500

Internal Server Error

CommonResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • DemoWSP

Example HTTP request
POST /wallets/transactions/result HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIndhbGxldHNBZG1pbiJdLCJzdWIiOiI4YzViNTdhNC1jMzBjLTQwNjAtYWFlNy1iYWExYjc2OTE4ZDciLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOlsiYWVyYS50ZXN0LXJlc291cmNlIl0sIm5iZiI6MTcyMjkyNzI4NiwiaWF0IjoxNzIyOTI3Mjg2LCJleHAiOjk5MzI5MjcyODYsImp0aSI6IjcyYjUzYTczLWY3MWQtNGMyYi05ZjA1LTUwYmFlZGJlOTIzMSJ9.oLjW9lMzx9NewN1JXhk9b6BBXVlgPoOTymuoBl2LyD-p9uPkhQWZ1cGpMTmsMjC2jwptNhKjfQzJlAbBDAtNhHnxoPgxkRI3q1dJnd17Lnwo5GKEjF-8zwP6xbf9YesHuRZvPnQS8B223E8iYiKXoDkrdrpZwf7r74xM67ulZEj6P6k7MdL_BHoHQ-EU2xc8R0AYS5DnEneCuv55DVzmhZjxtFllAcMeBXjo4iMcUHpYzUEd2OuyuwF2PukA50mgFYpZsE3De65lqJlyVjpZHFSLZ1OzphayGmhUQsm3rtanNNIGbFaY70F0GXF28IVInm-DkXxIf7OSN5jxk4PWeA
Accept: application/json
Content-Length: 274
Host: a.wsp.com

{
  "status" : "SUCCESS",
  "transactionId" : "40ed8098-956a-4d89-9e48-43e544618c4e",
  "user" : {
    "cuids" : [ {
      "cuid" : "10010",
      "cuidType" : "LOYALTY"
    }, {
      "cuid" : "73a8f576-c23a-47dc-9be6-b29d83faa86c",
      "cuidType" : "SDKID"
    } ]
  }
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: Cnq3dAGRRtE/b9k6em8ohPMEUHMssyxtRCwwRr9R8RXR+SPK/bhIt4g9j28qXJ9h/hlhpihjn3pfkFTY9of13amupNWoc/8Qp9JhmZHu82cnc0O1jMxnsvacWPNdsxA+TvnuNCNXtnE05E3oYv01l2ft1INgm/LuFOU2mRjb/QPLAtFCl+j2XriRnAm4Y0LOaajbJmODEcVhTvviCXnByY+KxtXcuGAn0NH+OSj75LVQ2EpULZNjR/OV3iwYhf4dwDJlzzGFkbFCc9WuW1TImyn7a3c6OvgYCC2CtG5cm/cUEoa45upXQBb7PNf+rJ4tsrj7c2A9dgRCB+B0aOgvNA==
Content-Length: 99

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T06:33:58.568Z"
  }
}
Example Curl request
$ curl 'https://a.wsp.com/wallets/transactions/result' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbIndhbGxldHNBZG1pbiJdLCJzdWIiOiI4YzViNTdhNC1jMzBjLTQwNjAtYWFlNy1iYWExYjc2OTE4ZDciLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOlsiYWVyYS50ZXN0LXJlc291cmNlIl0sIm5iZiI6MTcyMjkyNzI4NiwiaWF0IjoxNzIyOTI3Mjg2LCJleHAiOjk5MzI5MjcyODYsImp0aSI6IjcyYjUzYTczLWY3MWQtNGMyYi05ZjA1LTUwYmFlZGJlOTIzMSJ9.oLjW9lMzx9NewN1JXhk9b6BBXVlgPoOTymuoBl2LyD-p9uPkhQWZ1cGpMTmsMjC2jwptNhKjfQzJlAbBDAtNhHnxoPgxkRI3q1dJnd17Lnwo5GKEjF-8zwP6xbf9YesHuRZvPnQS8B223E8iYiKXoDkrdrpZwf7r74xM67ulZEj6P6k7MdL_BHoHQ-EU2xc8R0AYS5DnEneCuv55DVzmhZjxtFllAcMeBXjo4iMcUHpYzUEd2OuyuwF2PukA50mgFYpZsE3De65lqJlyVjpZHFSLZ1OzphayGmhUQsm3rtanNNIGbFaY70F0GXF28IVInm-DkXxIf7OSN5jxk4PWeA' \
    -H 'Accept: application/json' \
    -d '{
  "status" : "SUCCESS",
  "transactionId" : "40ed8098-956a-4d89-9e48-43e544618c4e",
  "user" : {
    "cuids" : [ {
      "cuid" : "10010",
      "cuidType" : "LOYALTY"
    }, {
      "cuid" : "73a8f576-c23a-47dc-9be6-b29d83faa86c",
      "cuidType" : "SDKID"
    } ]
  }
}'

7.11.2. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

ClaimedUserIdentifier

Claimed User IDs. Typically an SDK ID (or ideally a dynamic SDK ID) or some sort of additionalId/loyalty id (LOYALTY).

Name Description Schema

cuid
required

Claimed User ID. Typically an SDK ID or ideally a dynamic SDK ID.
Length : 8 - 50

string

cuidType
required

The type Claimed User ID.

enum (SDKID, DYNAMIC_SDKID, LOYALTY)
CommonResponse
Name Schema

responseInfo
optional

ResponseInfo
ResponseInfo

Info object that can provide specific messages

Name Description Schema

externalResponseCode
optional

Additional response code from external systems.

string

message
optional

Specific response message

string

responseCode
required

Minimum length : 1

string

timeStamp
required

Timestamp. Mandatory
Minimum length : 1
Example : "2021-12-21T10:23:19.279Z"

string
SessionDto

Transaction session credentials

Name Description Schema

sessionExpirationTime
required

Session expiration time.
Minimum length : 1

string

sessionId
required

The session id identifying the session.

string (uuid)

sessionKey
required

The next session key to be used for the established session.

string (uuid)
WSPEvent

List of WSP events.

Name Description Schema

completionTime
required

The completion time of the event. Always included.

string (date-time)

data
optional

Additional data defined by eventType. Name/value.

< string, < string > array > map

idempotencyKey
required

Unique random of the event to avoid duplicates of same event. Shall at least be a V4 UUID for entropy to avoid collisions

string (uuid)

initiator
required

The initiator of the event (SYSTEM=Wallet background job, e.g. searching for expired payment methods)

enum (CONSUMER, PSP, SYSTEM, WSP)

startTime
optional

The start time of the event. (Optional)

string (date-time)

statusCode
required

A specific status code of the event ('0' => success)

string

statusReason
optional

A specific status reason (explanation of statusCode)

string

sub
required

The subject (wallet) related to the event

string (uuid)

type
required

The type of event

enum (AUTHENTICATION, AUTHENTICATION_REQUIRED, ONBOARDING, PAYMENT_METHOD_ADDED, PAYMENT_METHOD_DELETED, PAYMENT_METHOD_EXPIRED, PAYMENT_METHOD_EXPIRING, TRANSACTION, WALLET_CREATED, WALLET_DELETED)
WSPEventsRequest
Name Description Schema

events
required

List of WSP events.

< WSPEvent > array
WalletUser

Id of wallet user

Name Description Schema

cuids
required

Claimed User IDs. Typically an SDK ID (or ideally a dynamic SDK ID) or some sort of additionalId/loyalty id (LOYALTY).

< ClaimedUserIdentifier > array
WspTransactionInitRequest
Name Description Schema

session
required

SessionDto

status
required

Wallet Transaction Status - will start as CREATED and be updated according status of transaction.

enum (CREATED, INIT_WAIT, SIGN_WAIT, PPS_WAIT, PSP_WAIT, SUCCESS, EXPIRED, FAILED, REJECTED)

transactionId
required

Id of specific transaction

string (uuid)

user
required

WalletUser
WspTransactionResultRequest
Name Description Schema

status
required

Wallet Transaction Status - will start as CREATED and be updated according status of transaction.

enum (CREATED, INIT_WAIT, SIGN_WAIT, PPS_WAIT, PSP_WAIT, SUCCESS, EXPIRED, FAILED, REJECTED)

transactionId
required

Id of specific transaction

string (uuid)

user
required

WalletUser

8. Aera ID Services

Service paths and model definition for the Aera ID Services. Can for instance be used to verify a signature originating from the Aera SDK.

8.1. Paths

Descriptions of resources/paths in the service.

8.1.1. Get Devices for Consumer.

GET /aid/api/devices/identifierType/{identifierType}/{identifierValue}
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

identifierType
required

User id type.

string

Path

identifierValue
required

The unique user id. Of type IdentifierType.

string
Responses
HTTP Code Description Schema

200

OK

DevicesResponse
Produces

  • application/vnd.aid.v1+json

Tags

  • AeraID

8.1.2. Get Devices for Consumer.

GET /aid/api/devices/identifierType/{identifierType}/{identifierValue}/{conceptId}
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

conceptId
required

The SDK concept. Of type UUID.

string (uuid)

Path

identifierType
required

User id type.

string

Path

identifierValue
required

The unique user id. Of type IdentifierType.

string
Responses
HTTP Code Description Schema

200

OK

DevicesResponse
Produces

  • application/vnd.aid.v1+json

Tags

  • AeraID

8.1.3. Get SDK info for Consumer.

GET /aid/sdk/manage/identifierType/{identifierType}/{identifierValue}
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

identifierType
required

User id type.

string

Path

identifierValue
required

The unique user id. Of type IdentifierType.

string
Responses
HTTP Code Description Schema

200

OK

SdkStatusResponse
Produces

  • application/vnd.aid.v1+json

Tags

  • AeraID

8.1.4. Manage all SDKs for Consumer.

POST /aid/sdk/manage/identifierType/{identifierType}/{identifierValue}/{action}
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

action
required

Action to perform on SDK. Valid actions: BLOCK, UNBLOCK, REVOKE, DELETE.

string

Path

identifierType
required

string

Path

identifierValue
required

The unique user id. Of type IdentifierType.

string
Responses
HTTP Code Description Schema

200

OK

SdkUpdateResponse
Produces

  • application/vnd.aid.v1+json

Tags

  • AeraID

8.1.5. Get information about SDK.

GET /aid/sdk/manage/sdkId/{sdkId}
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

sdkId
required

Unique SDK identifier.

string
Responses
HTTP Code Description Schema

200

OK

SdkStatusResponse
Produces

  • application/vnd.aid.v1+json

Tags

  • AeraID

8.1.6. Manage SDK.

POST /aid/sdk/manage/sdkId/{sdkId}/{action}
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

action
required

Action to perform on SDK. Valid actions: BLOCK, UNBLOCK, REVOKE, DELETE.

string

Path

sdkId
required

Unique SDK identifier.

string
Responses
HTTP Code Description Schema

200

OK

SdkUpdateResponse
Produces

  • application/vnd.aid.v1+json

Tags

  • AeraID

8.1.7. Verify QR

POST /aid/sdk/verifyQR
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : QRRequest

Responses
HTTP Code Description Schema

200

OK

QRResponse
Consumes

  • application/vnd.aid.v1+json

Produces

  • application/vnd.aid.v1+json

Tags

  • AeraID

8.1.8. Init SDK session

POST /aid/session/sdk/init
Description

Create a session for initialization of a SecureID SDK

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : SessionInitRequest

Responses
HTTP Code Description Schema

200

OK

SessionInitResponse
Consumes

  • application/vnd.aid.v1+json

Produces

  • application/vnd.aid.v1+json

Tags

  • AID_SESSION

8.1.9. Get user info by token

GET /aid/session/sdk/verify/token/{authenticationToken}
Description

Verify successful SDK initialization and gets the user info.

Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

authenticationToken
required

The Authentication Token returned after successful Authentication.

string
Responses
HTTP Code Description Schema

200

OK

UserInfoResponse
Produces

  • application/vnd.aid.v1+json

Tags

  • AID_SESSION

8.1.10. Verify a Signature signed by Consumer via Aera SDK.

POST /aid/signatures/verify
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : VerifySignatureRequest

Responses
HTTP Code Description Schema

200

OK

VerifySignatureResponse
Consumes

  • application/vnd.aid.v1+json

Produces

  • application/vnd.aid.v1+json

Tags

  • AeraID

Example HTTP request
POST /aid/authentications/aid HTTP/1.1
Content-Type: application/json;charset=UTF-8
session-key: de7dc2ab-eb75-40be-ac61-313f3158f47b
Accept: application/json
Content-Length: 33
Host: api.aerahost.com

{
  "b64payload" : "b64payload"
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
Content-Security-Policy: default-src 'none'; script-src 'self'; style-src 'self'; img-src data: 'self';
signature: ZzqS6agthXncH0e4/KgGyMnSoxpT1to0k0AJ51wap0Jc9WnK5FVUAEf3cBlUZ2Zdqrx/jxpv5hJrNN/PVButW5wnG6ipzf0ImP0SH0KBePaG67IUQ0PGHtSD6eNGUITxvYiRNm5tfU3Nwt1Orjh9gJqVl0kBhjESzYseHQ/CXphMoHi1e8XX5+YdDDbwCYrAzNK5VR2Cc1jgFFK5t3hEfx6fcGvdc1AWf05deKJ57F0ooYMOkkW8swP38nNVrbjrJVOZvt+m0RIOfZCJvKHY6Q1RO272MmBVotByIBCMwylqMgbUQ7hvrkF3ES3mXLLPZqLwNCXDjeyxZgc1HVbGdA==
Content-Length: 5

61010
Example Curl request
$ curl 'https://api.aerahost.com/aid/authentications/aid' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'session-key: de7dc2ab-eb75-40be-ac61-313f3158f47b' \
    -H 'Accept: application/json' \
    -d '{
  "b64payload" : "b64payload"
}'

8.2. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

8.2.1. AndroidDetails

Android SDK details.

Name Description Schema

apiLevel
required

Device Api Level at registration.

integer (int32)

currentSdkVersionNumber
optional

Current sdkVersion.

integer (int32)

manufacturer
required

Device manufacturer.

string

model
required

Device model.

string

sdkVersionNumber
required

SdkVersion at registration.

integer (int32)

transCounter
required

Current transaction counter.

integer (int32)

8.2.2. DevicesResponse

Name Description Schema

devices
optional

Devices.

< Device > array

responseInfo
optional

ResponseInfo

8.2.3. IosDetails

IOS SDK details.

Name Description Schema

currentSdkVersionNumber
optional

Current sdkVersion.

integer (int32)

manufacturer
required

Device manufacturer.

string

model
required

Device model.

string

sdkVersionNumber
required

SdkVersion at registration.

integer (int32)

transCounter
required

Current transaction counter.

integer (int32)

8.2.4. ModuleIdentifier

Set of identifiers (identifierdescription and identifierType) to be used in the module.

Name Description Schema

identifierType
required

The type of the Identifier.

enum (NIN)

identifierValue
required

The description of the Identifier.
Length : 1 - 255

string

8.2.5. QRRequest

Name Description Schema

action
required

Action.
Length : 5 - 20

string

data
required

Base64 encoded protected data.
Length : 30 - 800

string

id
required

Identification value.
Length : 10 - 50

string

query
optional

Request query parameters.

string

signature
optional

Signature.

string

8.2.6. QRResponse

Name Description Schema

identifierType
required

IdentifierType, eg PID.

string

identifierValue
required

Identifier of SDK owner.

string

protectedData
optional

string

responseInfo
optional

ResponseInfo

scopes
optional

string

transRef
optional

integer (int64)

validityMinutes
optional

integer (int32)

8.2.7. ResponseInfo

Info object that can provide specific messages

Name Description Schema

externalResponseCode
optional

Additional response code from external systems.

string

message
optional

Specific response message

string

responseCode
required

Minimum length : 1

string

timeStamp
required

Timestamp. Mandatory
Minimum length : 1
Example : "2021-12-21T10:23:19.279Z"

string

8.2.8. SdkStatusResponse

Name Description Schema

responseInfo
optional

ResponseInfo

status
optional

Status

statusList
optional

SDK status.

< Status > array

8.2.9. SdkUpdateResponse

Name Description Schema

responseInfo
optional

ResponseInfo

transactionId
optional

TransactionId.

string (uuid)

updated
optional

Number of SDKs updated by action.

integer (int32)

8.2.10. SessionInitRequest

Name Description Schema

identifiers
optional

Set of identifiers (identifierdescription and identifierType) to be used in the module.

< ModuleIdentifier > array

identityProviders
optional

Filter to reduce the list of identity providers (IDP) shown when starting authenticate/sign module.
If only 1, the chosen identity provider will start automatically.
If no value is set, all configured IDPs will be shown.

< enum (nbid-oidc, nbid-substantial, aera-basic, aera-webauth, freja-eid, itsme, aera-simple, aera-docid, nbid-oidc, itsme) > array

8.2.11. SessionInitResponse

Name Description Schema

responseInfo
optional

ResponseInfo

sessionExpirationTime
optional

Session expiration time. Mandatory

string

sessionId
optional

The session id identifying the session.

string (uuid)

url
optional

The URL to the User Interface.

string

8.2.12. Status

SDK status.

Name Description Schema

adminEvents
optional

< JsonNode > array

androidDetails
optional

AndroidDetails

capabilities
optional

SDK capabilities

< Capability > array

createdTime
required

SDK creation time.

string

dataControllerId
optional

string

identifierType
required

IdentifierType, eg PID.

enum (PAY_CARD, PAY_ACCOUNT, EMAIL, MOBILE_NUMBER, ADDITIONAL_ID, WALLET_REF, ACCOUNT_NUMBER, LOYALTY, SSN, SSN_ALIAS, PID, FREJA_EID, ID_DOCUMENT_SN, HASH)

identifierValue
required

Identifier of SDK owner.

string

iosDetails
optional

IosDetails

lastUsedTime
required

SDK last use time.

string

masterSdkId
optional

IOS device being master for this watch.

string

osType
required

Device operating system.

string

registrationMode
optional

SDK initialization mode.

enum (REQUIRE_BIOMETRIC, PREFER_BIOMETRIC, DUAL_MODE, REQUIRE_SECURE_LOCK_SCREEN, FIDO_AUTHENTICATION, FIDO_WEB_AUTHENTICATION, REQUIRE_BIOMETRIC_OR_APPIN)

sdkId
required

SDK ID.

string

sdkStatus
required

SDK status.

string

usageEvents
optional

< JsonNode > array

8.2.13. UserInfoResponse

Name Description Schema

birthdate
optional

The Date of Birth (DOB) of the Authenticated Identity.
The DOB is formatted as a ISO 8601 Date (yyyy-MM-dd).

string (date)

email
optional

E-mail.

string

https://aera.id/claims/id_issuer_country
required

The digital identity issuer country (based on the IDP).

string

https://aera.id/claims/identifier_type
optional

The IdentifierType for the unique user id for the IdentityProviderType.

enum (PAY_CARD, PAY_ACCOUNT, EMAIL, MOBILE_NUMBER, ADDITIONAL_ID, WALLET_REF, ACCOUNT_NUMBER, LOYALTY, SSN, SSN_ALIAS, PID, FREJA_EID, ID_DOCUMENT_SN, HASH)

https://aera.id/claims/identifier_value
optional

The unique user id for the IdentityProviderType. Of type IdentifierType.

string

https://aera.id/claims/idp
required

The identity provider (IDP) used during the authentication/signing process.

string

https://aera.id/claims/nin
optional

National Identity Number.

string

https://aera.id/claims/nin_alias
optional

An alias for the National Identity Number.

string (uuid)

https://aera.id/claims/nin_type
optional

Type of National Identity Number.

string

name
optional

Given name and family name. Should be 'givenName + space + familyName', but there is no guarantee.
Example : "Kari Nordmann"

string

responseInfo
optional

ResponseInfo

sdkId
optional

sdkId is the identifier of the created SDK.

string

sdkLevel
optional

sdkLevel is a number indicating level of the security profile/policy of the created SDK.

integer (int32)

sub
required

Subject - unique pairwise identifier for the subject.

string (uuid)

8.2.14. VerifySignatureRequest

Name Description Schema

b64Nonce
required

Base64 encoded nonce that was sent to SDK to be signed. May be used to mitigate replay-attacks.
Length : 1 - 128
Pattern : "^[A-Za-z0-9+/=]*$"

string

b64Tbs
required

Base64 encoded data that was sent to SDK to be signed.
Length : 1 - 2000
Pattern : "^[A-Za-z0-9+/=]*$"

string

signature
required

Base64 encoded signature generated by the SDK.
Length : 1 - 3000
Pattern : "^[A-Za-z0-9+/=]*$"

string

verifyNoReplay
optional

Require replayed messages to fail verification.

boolean

8.2.15. VerifySignatureResponse

Name Description Schema

authenticationToken
optional

AuthenticationToken when signing requires BankID

string

dateOfBirth
optional

Date of birth of SDK owner

string

identifierType
required

IdentifierType, eg PID.

string

identifierValue
required

Identifier of SDK owner.

string

pid
optional

DEPRECATED - Use identifierType and identifierValue. PID of SDK owner

string

responseInfo
optional

ResponseInfo

sdkId
required

Unique SDK identifier

string

signKeyType
required

Signing keyType used in SDK when generating signature

string

signType
required

Signing type used in SDK when generating signature

string

signatureValid
required

Outcome of signature verification

boolean

9. Identity Services

Service paths and model definition for the Identity-Identities Services

9.1. What is Identity Services

Services for managing an Identity representation. An Identity is a JSON Document including a unique ConsumerID and the following resources:

  • Identifier: Identifiers used to uniquely identify an Identity, e.g. a Visa Card, Mobile Number

  • Loyalty: The Loyalty Programs belonging to the Identity

  • Attributes: Other attributes belonging to the Identity, e.g. address, postal code, etc

Will only be able to access data belonging to the requesting Merchant or a partner

9.2. Paths

Descriptions of resources/paths in the service.

9.2.1. Add a new Identity

POST /identities/
Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : IdentityRequest

Responses
HTTP Code Description Schema

201

Created Identity successfully

IdentityResponse

400

Bad Request

CommonResponse

409

Conflict - a resource already exist

CommonResponse
Consumes

  • application/vnd.identities.v1+json

Produces

  • application/vnd.identities.v1+json

Tags

  • Manage Identities

Example HTTP request
POST /identities/ HTTP/1.1
Content-Type: application/vnd.identities.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYWQyODM2YjItZmE5ZS0xMWU3LThjM2YtOWEyMTRjZjA5M2FlIiwic2NvcGUiOlsiYWRkSWRlbnRpdHkiLCJmaW5kTG95YWx0aWVzQnlJZGVudGlmaWVyIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDQsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.esrN5esU-tgMsQ2sVbe50B93kbwjH151FuuEBoHbYByrJ5pm-na3DOFRVUK592vgyS6bxy890Fk9Y_MiGSNDCfumaujsLicih14TpNYzRzAVkCmKrdSzzvXNbpxYIgvj_-llOVR_r7_GXDy_uLXjHJ_AkeFucDx-4HgrZyPCGXaGmSDJWA8ZPP3hJItVx5jNiMu7WLwOXjTncpT50FW1Fi-EvvvPDmrwtgaw7rKnNsYFWAuNQtokp3w8ppCKMy2uLkj2jkTtONBdU2aGbc_6YXCKndMW0fplEgfhqUu1dKK2-1yQhPPwjWX2H4RSDy-X0s6AKMejBPScOSJ8yut0oQ
merchant-id: 15b74790-be22-11e7-abc4-cec278b6b50a
device-id: 238972340982347863
Accept: application/vnd.identities.v1+json
Content-Length: 640
Host: api.aerahost.com

{
  "identity" : {
    "identifiers" : [ {
      "identifierType" : "MOBILE_NUMBER",
      "identifierValue" : "+4791234567"
    }, {
      "identifierType" : "PAY_CARD",
      "identifierValue" : "************2987",
      "encryptionKey" : {
        "keyId" : "TotalTestKey",
        "encryptionType" : "DUKPT",
        "derivationId" : "EAEQERE=",
        "encryptedKey" : "AFLAAB8=",
        "keyVersion" : "20160920",
        "terminalGroup" : "AEVI"
      },
      "encryptedValue" : "656E736A6B3832373837363134336B6A686173646867",
      "bin" : "123456",
      "cardScheme" : "VISA",
      "paymentInstrumentType" : "03"
    } ]
  }
}
Example HTTP response
HTTP/1.1 201 Created
Content-Type: application/vnd.identities.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: vSh+F6F1793TkbhRz8AhZL+yMJzSeVAmYzGg4zOjLG8SAVkZmjqnqefayF07ap1AKfUf4hAdf5bHMtaYGPNQ+o/KbJvyDi6ywOJSzOgHptlXHQpSZg90v+QAAxMpZ9xFGXgoI3JwtM9rgMBpO/k9Uca6nmTZURme2DGE6m1khs41a/a6QAHfDgoICRdyivW9x4fHyCYIxjgCaTBlglEUcnyfAL6hPEB/pcUfFEJlpMnAvGfXus1vfANVpIjb+jECa+amar+8GwOaCzj8SMuSens+oHqiSNkCe+cvDVzZWxKW73Ng5A+kBlp9L8cryl/V+rGlzu1GO/zn80iQfMPFcA==
Content-Length: 624

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-11T13:19:53.726Z"
  },
  "identity" : {
    "consumerId" : "0e27b15f-2b13-4ab5-a2bd-d291582fa39d",
    "identifiers" : [ {
      "identifierId" : "48435e6d5e57e1a929cf82a9da6825913d56fcd6",
      "identifierType" : "MOBILE_NUMBER",
      "identifierValue" : "+4791234567"
    }, {
      "identifierId" : "17435e6d5e13e1a929cf82a9da6825913d56fba1",
      "identifierType" : "PAY_CARD",
      "identifierValue" : "************2987",
      "cardScheme" : "VISA",
      "paymentInstrumentType" : "03",
      "tokenValue" : "564RKSYT72GC5"
    } ]
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/identities/' -i -X POST \
    -H 'Content-Type: application/vnd.identities.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYWQyODM2YjItZmE5ZS0xMWU3LThjM2YtOWEyMTRjZjA5M2FlIiwic2NvcGUiOlsiYWRkSWRlbnRpdHkiLCJmaW5kTG95YWx0aWVzQnlJZGVudGlmaWVyIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDQsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.esrN5esU-tgMsQ2sVbe50B93kbwjH151FuuEBoHbYByrJ5pm-na3DOFRVUK592vgyS6bxy890Fk9Y_MiGSNDCfumaujsLicih14TpNYzRzAVkCmKrdSzzvXNbpxYIgvj_-llOVR_r7_GXDy_uLXjHJ_AkeFucDx-4HgrZyPCGXaGmSDJWA8ZPP3hJItVx5jNiMu7WLwOXjTncpT50FW1Fi-EvvvPDmrwtgaw7rKnNsYFWAuNQtokp3w8ppCKMy2uLkj2jkTtONBdU2aGbc_6YXCKndMW0fplEgfhqUu1dKK2-1yQhPPwjWX2H4RSDy-X0s6AKMejBPScOSJ8yut0oQ' \
    -H 'merchant-id: 15b74790-be22-11e7-abc4-cec278b6b50a' \
    -H 'device-id: 238972340982347863' \
    -H 'Accept: application/vnd.identities.v1+json' \
    -d '{
  "identity" : {
    "identifiers" : [ {
      "identifierType" : "MOBILE_NUMBER",
      "identifierValue" : "+4791234567"
    }, {
      "identifierType" : "PAY_CARD",
      "identifierValue" : "************2987",
      "encryptionKey" : {
        "keyId" : "TotalTestKey",
        "encryptionType" : "DUKPT",
        "derivationId" : "EAEQERE=",
        "encryptedKey" : "AFLAAB8=",
        "keyVersion" : "20160920",
        "terminalGroup" : "AEVI"
      },
      "encryptedValue" : "656E736A6B3832373837363134336B6A686173646867",
      "bin" : "123456",
      "cardScheme" : "VISA",
      "paymentInstrumentType" : "03"
    } ]
  }
}'

9.2.2. Search for an Identity by an Identifier

POST /identities/find-by-identifier
Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Query

filter
optional

Filter for reducing data in response. E.g. '?filter=identifierType:MOBILE_NUMBER'

string
Body parameter

Name : body
Flags : required
Type : IdentifierRequest

Responses
HTTP Code Description Schema

200

OK

IdentityResponse
Consumes

  • application/vnd.identities.v1+json

Produces

  • application/vnd.identities.v1+json

Tags

  • Search Identities

Example HTTP request
POST /identities/find-by-identifier HTTP/1.1
Content-Type: application/vnd.identities.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ
Accept: application/vnd.identities.v1+json
Content-Length: 107
Host: api.aerahost.com

{
  "identifier" : {
    "identifierType" : "ADDITIONAL_ID",
    "identifierValue" : "1234AHNGDC2345"
  }
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.identities.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: D8x9MPn8UEaVPeVIg+XclJLJuWI/cwo98ZRKGfvcRxuq50N6lCrkMOYX7RETwfmS8kPDUByuBOjd5EZ1ivilqrbYMb+hEHDg0A1jfE1dyBw3a204oQNW2FSuP0x6+wioqTlOPsBa2qDjV8XQ4Th9iP1m0EsgDu4KGetFurzcBDnA/EORMvHtEMLv4Ut/WPwANByu6euvHMlaJeHYBMAnsw+7ip07IivNO8qOZdnnijPDfsCX57zb7/48hYqs5LcmFuFvLiO9vbD4/RhU7Nt9Ck/5C3wlc5SFaO1/34qbdPX1p1lXFiAV1eUntOexUcv+ikOWuxyBK/2QBLEyxkShaw==
Content-Length: 868

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-11T13:19:56.467Z"
  },
  "identity" : {
    "consumerId" : "0e27b15f-2b13-4ab5-a2bd-d291582fa39d",
    "loyalties" : [ {
      "loyaltyType" : "AeraClub",
      "loyaltyValue" : "3210123456789"
    } ],
    "identifiers" : [ {
      "identifierId" : "82635e6d5e13e1a929cf82a9da8374513d56fcd3",
      "identifierType" : "ADDITIONAL_ID",
      "identifierValue" : "1234AHNGDC2345"
    }, {
      "identifierId" : "17435e6d5e13e1a929cf82a9da6825913d56fba1",
      "identifierType" : "PAY_CARD",
      "identifierValue" : "************2987",
      "cardScheme" : "VISA",
      "paymentInstrumentType" : "03"
    }, {
      "identifierId" : "928465e6d5e13e1a036cf82b9da927845633d56eab7",
      "identifierType" : "WALLET_REF",
      "identifierValue" : "0e32455f-2b13-a2bd-dasdfg234"
    } ]
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/identities/find-by-identifier' -i -X POST \
    -H 'Content-Type: application/vnd.identities.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ' \
    -H 'Accept: application/vnd.identities.v1+json' \
    -d '{
  "identifier" : {
    "identifierType" : "ADDITIONAL_ID",
    "identifierValue" : "1234AHNGDC2345"
  }
}'

9.2.3. Find Identities (ConsumerId) for Payment Card with the requested 'cardScheme'.

GET /identities/find-by-payment-card
Parameters
Type Name Description Schema Default

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Query

cardScheme
required

The Card Scheme for identifierType=PAY_CARD.

string

Query

page
optional

The page in case of large data set (first page = 0).

integer (int32)

0

Query

pageSize
optional

The page size, i.e. maximum returned identities. Max value is 1000 per page.

integer (int32)

100
Responses
HTTP Code Description Schema

200

OK

IdentitiesWithCardSchemeResponse
Produces

  • application/vnd.identities.v1+json

Tags

  • Search Identities

Example HTTP request
GET /identities/find-by-payment-card?cardScheme=MASTERCARD HTTP/1.1
Content-Type: application/vnd.identities.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ
Accept: application/vnd.identities.v1+json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.identities.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: BSpYifTnInvmQqOf42iYTaZPKjQH91bpEmtGkK70QpZx3PBSA+tygqZ8AHmCC1trdX/RNkQrgrxNW0t9gSqkyxl2Vwbdk9toeAM65Bom4wZOjIIzOZ66x8oJOONezsjYBX2B9B7WpK7JtXvyA0TN6ujKRHngyjS+Gktl8B9TINoc0G1fc4u8bxOhsdhog85cFlZtzRcMVAnvtkFclzVDwiPo9rQvBLnOgSxJenwKsK+3T6kxNzRchiHijKVNTtgSX3fExINDAvSsdQ9n/fizZ9gyyOOhyeGOpk626FJN1vnvkX1EqGW5XuwIUhy3sSW9D1pZbCgYduaTosqRzfAF5g==
Content-Length: 161

{
  "consumerIds" : [ "0e27b15f-2b13-4ab5-a2bd-d291582fa39d" ],
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-11T13:19:56.248Z"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/identities/find-by-payment-card?cardScheme=MASTERCARD' -i -X GET \
    -H 'Content-Type: application/vnd.identities.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ' \
    -H 'Accept: application/vnd.identities.v1+json'

9.2.4. Get all Payment Cards that expires within the defined period ('from' - 'to')

GET /identities/find-expiring-payment-cards
Parameters
Type Name Description Schema Default

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Query

from
required

The from date for the period. ISO-8601 on format yyyy-MM-dd.

string (date)

Query

page
optional

The page in case of large data set (first page = 0). Maximum returned payment cards are 5000 per page.

integer (int32)

0

Query

to
required

The to date for the period. ISO-8601 on format yyyy-MM-dd.

string (date)
Responses
HTTP Code Description Schema

200

OK

ExpiringPaymentCardsResponse
Produces

  • application/vnd.identities.v1+json

Tags

  • Search Identities

Example HTTP request
GET /identities/find-expiring-payment-cards?from=2022-01-01&to=2022-01-31 HTTP/1.1
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ
Accept: application/vnd.identities.v1+json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.identities.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: P8dJKJWwj+rIULR3hHxa1G9pF4hwTyKG+WuaFsNYGYm4AgyMKyIaOWvFIDY5WDZPzSInivR8yMDJEjhqnlWRnMzSGRSzBkvJpe08ABhr2VYTJ3LvWbctuP73wNaY0nwydttSt5zJtB0ACmMp4AUUhmYyUMNGuHUl2oCvzQ4AYNP2EfG16RD5qm76ewYfz1HW6cWrvr/+pf/bP063qEcHDkD4nIHTUpA8cHclklWIFzoeIwSU333IGds2y7VpE5pyUBLh4/wDy+4/QmlE1390r3g41OZbs4BjGK6TfkXj19U49ZoNI+/8WaGbZEvgAORsFjlkrB5NQCM3M1N7DufJLg==
Content-Length: 398

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-11T13:19:54.212Z"
  },
  "expiringPaymentCards" : [ {
    "consumerId" : "0e27b15f-2b13-4ab5-a2bd-d291582fa39d",
    "identifierId" : "17435e6d5e13e1a929cf82a9da6825913d56fba1",
    "maskedPan" : "************2987",
    "cardScheme" : "VISA",
    "paymentInstrumentType" : "03",
    "expirationDate" : "2020-07-31"
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/identities/find-expiring-payment-cards?from=2022-01-01&to=2022-01-31' -i -X GET \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ' \
    -H 'Accept: application/vnd.identities.v1+json'

9.2.5. Search for Payment Instruments by an Identifier

POST /identities/find-payment-instruments
Parameters
Type Name Description Schema Default

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Query

includeExpired
optional

Set to 'true' to also include expired payment instruments in response

boolean

"false"
Body parameter

Name : body
Flags : required
Type : IdentifierRequest

Responses
HTTP Code Description Schema

200

OK

PaymentInstrumentResponse
Consumes

  • application/vnd.identities.v1+json

Produces

  • application/vnd.identities.v1+json

Tags

  • Search Identities

Example HTTP request
POST /identities/find-payment-instruments HTTP/1.1
Content-Type: application/vnd.identities.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ
Accept: application/vnd.identities.v1+json
Content-Length: 107
Host: api.aerahost.com

{
  "identifier" : {
    "identifierType" : "ADDITIONAL_ID",
    "identifierValue" : "1234AHNGDC2345"
  }
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.identities.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: nM25E0u5s4eAG1WS0ISCfaZxCiC3giFTDPIWgXviCnjlC9PL+2hE7MGlZ456FVzAKnyjLsigJeRllrDrgkZuCjPc9ltJ6e0DM1GUQHUT7qczc60G4APivW35OmK/WMZy2KdqSPtyVke92x7+kl/8imXdAF2zF8zCar6vByHROuDvlmokK04QNx3ppm4aFoKf9oATvdEt0bQYcf1kqIIh3kEHhwMG6bu75eKKdQfKfrrW2JtACTGcO6DiqQYNb4rXE6mGa7wLSCOxyt5YfJ3NxRkzcelDIh5VpO8hOnUomdKD5JQ51XsyhIQyc/X0b6s5eHciprsenul6bp7Qg6GO5g==
Content-Length: 697

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-11T13:19:55.344Z"
  },
  "consumerId" : "0e27b15f-2b13-4ab5-a2bd-d291582fa39d",
  "paymentInstruments" : [ {
    "identifierId" : "42e112bda4f155704ba1b56bf35df348d220f228",
    "identifierType" : "PAY_ACCOUNT",
    "identifierValue" : "********911",
    "priority" : 1,
    "defaultPaymentInstrument" : true,
    "provider" : "myProvider"
  }, {
    "identifierId" : "f7cc8cda9bef7ce8e09d3c69a9e06f7920948d8d",
    "identifierType" : "PAY_CARD",
    "identifierValue" : "************6543",
    "priority" : 2,
    "expirationdate" : "2028-12-31",
    "cardScheme" : "VISA",
    "defaultPaymentInstrument" : false
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/identities/find-payment-instruments' -i -X POST \
    -H 'Content-Type: application/vnd.identities.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ' \
    -H 'Accept: application/vnd.identities.v1+json' \
    -d '{
  "identifier" : {
    "identifierType" : "ADDITIONAL_ID",
    "identifierValue" : "1234AHNGDC2345"
  }
}'

9.2.6. Get Application Status (Health check)

GET /identities/health
Responses
HTTP Code Description Schema

200

Identity Health OK

Status
Produces

  • application/vnd.identities.v1+json

  • application/json

Tags

  • Identity Services Health

Example HTTP request
GET /identities/health HTTP/1.1
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Accept: application/json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 21

{
  "status" : "UP"
}
Example Curl request
$ curl 'https://api.aerahost.com/identities/health' -i -X GET \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Accept: application/json'

9.2.7. Delete an Identifier using request body, no ConsumerId.

DELETE /identities/identifiers
Parameters
Type Name Description Schema Default

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Query

useExpirationDate
optional

true if expirationDate or expirationLocalDate should be used as part of finding the Identifier

boolean

"false"
Body parameter

Name : body
Flags : required
Type : IdentifierRequest

Responses
HTTP Code Description Schema

204

No Content - Deleted successfully

No Content

400

Bad Request

CommonResponse

404

Not Found

CommonResponse
Consumes

  • application/vnd.identities.v1+json

Produces

  • application/vnd.identities.v1+json

Tags

  • Manage Identity Identifiers

Example HTTP request
DELETE /identities/identifiers HTTP/1.1
Content-Type: application/vnd.identities.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ
Accept: application/vnd.identities.v1+json
Content-Length: 395
Host: api.aerahost.com

{
  "identifier" : {
    "identifierType" : "PAY_CARD",
    "identifierValue" : "************2987",
    "encryptionKey" : {
      "keyId" : "NAME-OF-PUBLIC-KEY",
      "encryptionType" : "RSAOAEP"
    },
    "encryptedValue" : "ZkR6VW5GTUkvVHNkR0Y5S3V4UGZqL0U3amV2bUk3Li4u",
    "bin" : "123456",
    "cardScheme" : "VISA",
    "paymentInstrumentType" : "03",
    "expirationDate" : "1023"
  }
}
Example HTTP response
HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Example Curl request
$ curl 'https://api.aerahost.com/identities/identifiers' -i -X DELETE \
    -H 'Content-Type: application/vnd.identities.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ' \
    -H 'Accept: application/vnd.identities.v1+json' \
    -d '{
  "identifier" : {
    "identifierType" : "PAY_CARD",
    "identifierValue" : "************2987",
    "encryptionKey" : {
      "keyId" : "NAME-OF-PUBLIC-KEY",
      "encryptionType" : "RSAOAEP"
    },
    "encryptedValue" : "ZkR6VW5GTUkvVHNkR0Y5S3V4UGZqL0U3amV2bUk3Li4u",
    "bin" : "123456",
    "cardScheme" : "VISA",
    "paymentInstrumentType" : "03",
    "expirationDate" : "1023"
  }
}'

9.2.8. Search for Loyalties by an Identifier (ID-LOOKUP via Terminal)

POST /identities/loyalties/find-by-identifier
Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : IdentifierRequest

Responses
HTTP Code Description Schema

200

OK

LoyaltiesResponse
Consumes

  • application/vnd.identities.v1+json

Produces

  • application/vnd.identities.v1+json

Tags

  • Identity Services via Terminal

Example HTTP request
POST /identities/loyalties/find-by-identifier HTTP/1.1
Content-Type: application/vnd.identities.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYWQyODM2YjItZmE5ZS0xMWU3LThjM2YtOWEyMTRjZjA5M2FlIiwic2NvcGUiOlsiYWRkSWRlbnRpdHkiLCJmaW5kTG95YWx0aWVzQnlJZGVudGlmaWVyIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDQsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.esrN5esU-tgMsQ2sVbe50B93kbwjH151FuuEBoHbYByrJ5pm-na3DOFRVUK592vgyS6bxy890Fk9Y_MiGSNDCfumaujsLicih14TpNYzRzAVkCmKrdSzzvXNbpxYIgvj_-llOVR_r7_GXDy_uLXjHJ_AkeFucDx-4HgrZyPCGXaGmSDJWA8ZPP3hJItVx5jNiMu7WLwOXjTncpT50FW1Fi-EvvvPDmrwtgaw7rKnNsYFWAuNQtokp3w8ppCKMy2uLkj2jkTtONBdU2aGbc_6YXCKndMW0fplEgfhqUu1dKK2-1yQhPPwjWX2H4RSDy-X0s6AKMejBPScOSJ8yut0oQ
merchant-id: 15b74790-be22-11e7-abc4-cec278b6b50a
device-id: 238972340982347863
stan: 123456
retransmission-counter: 0
Accept: application/vnd.identities.v1+json
Content-Length: 491
Host: api.aerahost.com

{
  "identifier" : {
    "identifierType" : "PAY_CARD",
    "identifierValue" : "************2987",
    "encryptionKey" : {
      "keyId" : "TotalTestKey",
      "encryptionType" : "DUKPT",
      "derivationId" : "EAEQERE=",
      "encryptedKey" : "AFLAAB8=",
      "keyVersion" : "20160920",
      "terminalGroup" : "AEVI"
    },
    "encryptedValue" : "656E736A6B3832373837363134336B6A686173646867",
    "bin" : "123456",
    "cardScheme" : "VISA",
    "paymentInstrumentType" : "03"
  }
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.identities.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: VYByksK8ZtXuu8fTtgCxpAVDVKYJKthIHdQ1CHrzkwjmhwlQ7d5SmaZlGESl4ZxJLxM5H5IbIXmK+vwH2HHGSIQ8FQHgo5q5zCqF1BZedR/YNFsWX3zOsrovxJTRRO/+rBlihVpgar4SQjnZmzYpa/hmGQJztOaTe1yxeFfQ7Rxr9W/qp7So8vQt5YM4wLVG83H7GwuIP1AzuOiWsRy/Qra2FrZs/ye7GVVAp3I00TnFYLjyTGtxz6hqA3WO59hJ1NwRN3z6S7K4eNazSRf9/tcYhkTwNTMcstZ7pRuB0VZnBYdSAN8C5xepFchehmvfoz76VPRGF41M9f30B67/VA==
Content-Length: 252

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-11T13:19:55.653Z"
  },
  "consumerId" : "0e27b15f-2b13-4ab5-a2bd-d291582fa39d",
  "loyalties" : [ {
    "loyaltyType" : "AeraClub",
    "loyaltyValue" : "3210123456789"
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/identities/loyalties/find-by-identifier' -i -X POST \
    -H 'Content-Type: application/vnd.identities.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiYWQyODM2YjItZmE5ZS0xMWU3LThjM2YtOWEyMTRjZjA5M2FlIiwic2NvcGUiOlsiYWRkSWRlbnRpdHkiLCJmaW5kTG95YWx0aWVzQnlJZGVudGlmaWVyIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDQsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.esrN5esU-tgMsQ2sVbe50B93kbwjH151FuuEBoHbYByrJ5pm-na3DOFRVUK592vgyS6bxy890Fk9Y_MiGSNDCfumaujsLicih14TpNYzRzAVkCmKrdSzzvXNbpxYIgvj_-llOVR_r7_GXDy_uLXjHJ_AkeFucDx-4HgrZyPCGXaGmSDJWA8ZPP3hJItVx5jNiMu7WLwOXjTncpT50FW1Fi-EvvvPDmrwtgaw7rKnNsYFWAuNQtokp3w8ppCKMy2uLkj2jkTtONBdU2aGbc_6YXCKndMW0fplEgfhqUu1dKK2-1yQhPPwjWX2H4RSDy-X0s6AKMejBPScOSJ8yut0oQ' \
    -H 'merchant-id: 15b74790-be22-11e7-abc4-cec278b6b50a' \
    -H 'device-id: 238972340982347863' \
    -H 'stan: 123456' \
    -H 'retransmission-counter: 0' \
    -H 'Accept: application/vnd.identities.v1+json' \
    -d '{
  "identifier" : {
    "identifierType" : "PAY_CARD",
    "identifierValue" : "************2987",
    "encryptionKey" : {
      "keyId" : "TotalTestKey",
      "encryptionType" : "DUKPT",
      "derivationId" : "EAEQERE=",
      "encryptedKey" : "AFLAAB8=",
      "keyVersion" : "20160920",
      "terminalGroup" : "AEVI"
    },
    "encryptedValue" : "656E736A6B3832373837363134336B6A686173646867",
    "bin" : "123456",
    "cardScheme" : "VISA",
    "paymentInstrumentType" : "03"
  }
}'

9.2.9. Delete a shared ID-resolve record. Usually immediately after it has been used

DELETE /identities/loyalties/shared-transactions/{sharedIdResolveId}
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

sharedIdResolveId
required

string (uuid)
Responses
HTTP Code Description Schema

204

No Content - Deleted successfully

No Content

400

Bad Request

CommonResponse

404

Not Found

CommonResponse
Produces

  • application/vnd.identities.v1+json

  • application/json

Tags

  • Manage Identities

Example HTTP request
DELETE /identities/loyalties/shared-transactions/53d72752-5436-4765-93c5-9d2d6110ef0b HTTP/1.1
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ
Accept: application/vnd.identities.v1+json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Example Curl request
$ curl 'https://api.aerahost.com/identities/loyalties/shared-transactions/53d72752-5436-4765-93c5-9d2d6110ef0b' -i -X DELETE \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ' \
    -H 'Accept: application/vnd.identities.v1+json'

9.2.10. Get all identity transactions (via Terminal) for a merchant for one day

GET /identities/transactions
Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Query

merchantId
required

The merchantId to retrive transactions for

string

Query

onlyOffline
optional

true if only offline transactions should be returned

boolean

Query

searchDateTime
required

The day to search for transactions, format: yyyy-MM-dd’T’HH:mmTZD. TZD/timezone is represented by Z (UTC) or offset from UTC, e.g. +02:00. Must be url encoded.

string
Responses
HTTP Code Description Schema

200

OK

TransactionsResponse
Produces

  • application/vnd.identities.v1+json

Tags

  • Identity Services via Terminal

Example HTTP request
GET /identities/transactions?merchantId=12345&searchDateTime=2018-04-17T00%3A00%2B02%3A00&onlyOffline=false HTTP/1.1
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ
Accept: application/vnd.identities.v1+json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.identities.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: gqeE+TEYv7u9wlODdeIVh+AxpvsSNXHcyKXVsB+fYikUxarWHbleXpYmOfSgm34/07H8UWzmhYKkaS/PAy1S4d04XGiD5uD/e32Btz96XlL/gl3uk3tGYmmimc3aOcO50w6fkn8hsDNo0TTNQf6N9l2suZsnVSracNMlU5H4REHwLdxvf/UXh9dhxFhCHdO/xO1F5bLjfeNts0NW8dBz04gViyVoUkRsxo7yd4ynxyuwxYpKAimvhhLSNAIsVQR6iMWXM3B+CbJAbGErnwdpHBclVcL4RktnFAgo5H9AvuKBgKijTcflyz8WClsPQ/W0HWgD0UN7dikU8ceORYYsUQ==
Content-Length: 585

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-11T13:19:54.719Z"
  },
  "transactions" : [ {
    "merchantId" : "12345",
    "deviceId" : "1234567",
    "stan" : "98128761235",
    "retransmissionCounter" : 0,
    "identityResponse" : {
      "responseInfo" : {
        "responseCode" : "0",
        "timeStamp" : "2018-04-17T16:01:41:730Z"
      },
      "identity" : {
        "loyalties" : [ {
          "loyaltyType" : "AeraClub",
          "loyaltyValue" : "987213485432"
        } ]
      }
    },
    "timeStamp" : "2018-04-17T16:01:41.737Z"
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/identities/transactions?merchantId=12345&searchDateTime=2018-04-17T00%3A00%2B02%3A00&onlyOffline=false' -i -X GET \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ' \
    -H 'Accept: application/vnd.identities.v1+json'

9.2.11. Get an Identity by ConsumerId

GET /identities/{consumerId}
Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

consumerId
required

string (uuid)
Responses
HTTP Code Description Schema

200

Get Identity OK

IdentityResponse

400

Bad Request

CommonResponse

404

Not Found

CommonResponse
Produces

  • application/vnd.identities.v1+json

Tags

  • Manage Identities

Example HTTP request
GET /identities/0e27b15f-2b13-4ab5-a2bd-d291582fa39d HTTP/1.1
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ
Accept: application/vnd.identities.v1+json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.identities.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: NQSAb6lA0U5v+NS7dx8DYsbsAaAQPC6LAPk9Qz18tW/90MldCg5/Ybyy7S54pwZ87CLgDWwhcGmtHYI/EUmiIrGOHry8+yx4gCQ4w0AAPfNUCH+CexRQOXzoR96iV8sOoeMm3RFXShxZHj8k+LWZbN1j2XlQxJzUY/vD+mbd+KQwQc3UYQ9tK/814qBAQr265Wn8nZaeToiZyyPvjRbKK97BJgXj7YCiTsooBsl3Z0GDJ6COlOmtj79RdQ0PrMZUqBMNEL4U9xjhgQwdMUOIK01LtFEnsIoGRuQQijAosgGjc45uuT5WXUoBKndxFWU6rGKkPxfLpSf9otXkzz8Ceg==
Content-Length: 467

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-11T13:19:56.667Z"
  },
  "identity" : {
    "consumerId" : "0e27b15f-2b13-4ab5-a2bd-d291582fa39d",
    "loyalties" : [ {
      "loyaltyType" : "AeraClub",
      "loyaltyValue" : "3210123456789"
    } ],
    "identifiers" : [ {
      "identifierId" : "74e7107acf5c1499bef8735f3eeb0e0f93936de3a2",
      "identifierType" : "MOBILE_NUMBER",
      "identifierValue" : "+4741234567"
    } ]
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/identities/0e27b15f-2b13-4ab5-a2bd-d291582fa39d' -i -X GET \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ' \
    -H 'Accept: application/vnd.identities.v1+json'

9.2.12. Update an existing Identity

PUT /identities/{consumerId}
Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

consumerId
required

string (uuid)
Body parameter

Name : body
Flags : required
Type : IdentityRequest

Responses
HTTP Code Description Schema

200

Updated Identity successfully

IdentityResponse

400

Bad Request

CommonResponse

409

Conflict - a resource already exist

CommonResponse
Consumes

  • application/vnd.identities.v1+json

Produces

  • application/vnd.identities.v1+json

Tags

  • Manage Identities

Example HTTP request
PUT /identities/0e27b15f-2b13-4ab5-a2bd-d291582fa39d HTTP/1.1
Content-Type: application/vnd.identities.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ
Accept: application/vnd.identities.v1+json
Content-Length: 243
Host: api.aerahost.com

{
  "identity" : {
    "loyalties" : [ {
      "loyaltyType" : "AeraClub",
      "loyaltyValue" : "3210123456789"
    } ],
    "identifiers" : [ {
      "identifierType" : "ACCOUNT_NUMBER",
      "identifierValue" : "12345678911"
    } ]
  }
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.identities.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: CjvLUTKrNSePar76zfaBBtYXei2OsE2F2V+nsq8CB5k1RRnc9fIr1Jbra5Var/Wcxth7n76ccytA4f4gsxMwHRmHPArGN0oW/tBsOz5VoJv0Qko4FxFP8/Bz4pzBy5dlTz+83MW0oB9gTqSw4fiSMYDEWHu8oPdY0ZsLqtM47QYVLPizDz2DMgUzF6WYqxA6P6zdM4mlLYEdc9L95HfVUqagg3Cs78kENs6xw9obnE0/Oo12m1qOn+i457Yjp556Pfv9RpwfBDQdnwpfM6yG311B7S8/jQQgzjyoTSDwoKp5k//vMz1tjZw4QMz3lFDaF7iYFzD8al8x0O+x7Dh1IQ==
Content-Length: 553

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-11T13:19:55.850Z"
  },
  "identity" : {
    "consumerId" : "0e27b15f-2b13-4ab5-a2bd-d291582fa39d",
    "loyalties" : [ {
      "loyaltyType" : "AeraClub",
      "loyaltyValue" : "3210123456789"
    } ],
    "identifiers" : [ {
      "identifierId" : "8bc2d836f073d861f629a78e91846ee7ce1f56d4",
      "identifierType" : "ACCOUNT_NUMBER",
      "identifierValue" : "********911",
      "tokenValue" : "564RKSYT72GC5",
      "originalIdentifierValue" : "12345678911"
    } ]
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/identities/0e27b15f-2b13-4ab5-a2bd-d291582fa39d' -i -X PUT \
    -H 'Content-Type: application/vnd.identities.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ' \
    -H 'Accept: application/vnd.identities.v1+json' \
    -d '{
  "identity" : {
    "loyalties" : [ {
      "loyaltyType" : "AeraClub",
      "loyaltyValue" : "3210123456789"
    } ],
    "identifiers" : [ {
      "identifierType" : "ACCOUNT_NUMBER",
      "identifierValue" : "12345678911"
    } ]
  }
}'

9.2.13. Delete an existing Identity

DELETE /identities/{consumerId}
Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

consumerId
required

string (uuid)
Responses
HTTP Code Description Schema

204

No Content - Deleted successfully

No Content

400

Bad Request

CommonResponse

404

Not Found

CommonResponse
Produces

  • application/vnd.identities.v1+json

Tags

  • Manage Identities

Example HTTP request
DELETE /identities/0e27b15f-2b13-4ab5-a2bd-d291582fa39d HTTP/1.1
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Example Curl request
$ curl 'https://api.aerahost.com/identities/0e27b15f-2b13-4ab5-a2bd-d291582fa39d' -i -X DELETE \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ'

9.2.14. Partial update of an existing Identity

PATCH /identities/{consumerId}
Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

consumerId
required

string (uuid)
Body parameter

Name : body
Flags : required
Type : IdentityRequest

Responses
HTTP Code Description Schema

200

Patched Identity successfully

IdentityResponse

400

Bad Request

CommonResponse

409

Conflict - a resource already exist

CommonResponse
Consumes

  • application/vnd.identities.v1+json

Produces

  • application/vnd.identities.v1+json

Tags

  • Manage Identities

Example HTTP request
PATCH /identities/0e27b15f-2b13-4ab5-a2bd-d291582fa39d HTTP/1.1
Content-Type: application/vnd.identities.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ
Accept: application/vnd.identities.v1+json
Content-Length: 135
Host: api.aerahost.com

{
  "identity" : {
    "attributes" : [ {
      "attributeType" : "ADDRESS",
      "attributeValue" : "Identity street 1"
    } ]
  }
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.identities.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: A3eVenUAi734VqB1ATVDtoG1S5GH961rdPto3qFR8c3/HouCGeyOVP1aWhBN6iuPR67+8nKl+PbXrJkwhvV2GQezhzBb/eCsSrvaZ22U6KNa3HKTNDiGd0mNHCcivr0aJpHDVlFVHNervzOiEJPOCvO/WON54T40cwKwE67KiLMr3ov+V2YdLLyGVZoAF4NCUoiNGgwfwwMlfCnRh4p/O+opnkJVRl4jcV8y9mwO1O793xSeZAubuoNjZs7ReWuUuDSkfrHTqT1LX4GcwZhf4d8zQo+qDI+RL9Xs1Lja+aRGdVAOIEF8JRRcJpPMDIL8g2pHYVuly1+VfqRKSUdLQw==
Content-Length: 579

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-11T13:19:56.625Z"
  },
  "identity" : {
    "consumerId" : "0e27b15f-2b13-4ab5-a2bd-d291582fa39d",
    "loyalties" : [ {
      "loyaltyType" : "AeraClub",
      "loyaltyValue" : "3210123456789"
    } ],
    "identifiers" : [ {
      "identifierId" : "74e7107acf5c1499bef8735f3eeb0e0f93936de3a2",
      "identifierType" : "MOBILE_NUMBER",
      "identifierValue" : "+4741234567"
    } ],
    "attributes" : [ {
      "attributeType" : "ADDRESS",
      "attributeValue" : "Identity street 1"
    } ]
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/identities/0e27b15f-2b13-4ab5-a2bd-d291582fa39d' -i -X PATCH \
    -H 'Content-Type: application/vnd.identities.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ' \
    -H 'Accept: application/vnd.identities.v1+json' \
    -d '{
  "identity" : {
    "attributes" : [ {
      "attributeType" : "ADDRESS",
      "attributeValue" : "Identity street 1"
    } ]
  }
}'

9.2.15. Add an Identifier to an existing Identity

POST /identities/{consumerId}/identifiers
Parameters
Type Name Description Schema

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

consumerId
required

string (uuid)
Body parameter

Name : body
Flags : required
Type : IdentifierRequest

Responses
HTTP Code Description Schema

201

Created

IdentifierResponse
Consumes

  • application/vnd.identities.v1+json

Produces

  • application/vnd.identities.v1+json

Tags

  • Manage Identity Identifiers

Example HTTP request
POST /identities/0e27b15f-2b13-4ab5-a2bd-d291582fa39d/identifiers HTTP/1.1
Content-Type: application/vnd.identities.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ
Accept: application/vnd.identities.v1+json
Content-Length: 395
Host: api.aerahost.com

{
  "identifier" : {
    "identifierType" : "PAY_CARD",
    "identifierValue" : "************2987",
    "encryptionKey" : {
      "keyId" : "NAME-OF-PUBLIC-KEY",
      "encryptionType" : "RSAOAEP"
    },
    "encryptedValue" : "ZkR6VW5GTUkvVHNkR0Y5S3V4UGZqL0U3amV2bUk3Li4u",
    "bin" : "123456",
    "cardScheme" : "VISA",
    "paymentInstrumentType" : "03",
    "expirationDate" : "1023"
  }
}
Example HTTP response
HTTP/1.1 201 Created
Content-Type: application/vnd.identities.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: I0jbFSm+hMjeKTpElfzu+b9Nr8G862MQuf4Bk7FTelAi9YtrUbeQxEqSZMkNrugD5mp+Q6b7AlBKl1IYzqkctVMsXVGbOmEBYanaEVyJjyTzUsT2PTCICMr8K3nLlpqyfi8stA1+77koGI7vEMIP9KsFLLsble0MB9FlUqXbj14tMBdGkMxSY1K9MrFC/Whj6JGZAhXqs0gEyeZI6DczV4fILvaMCu/nuJIbGuf5ioCERgg1bEQVQm9Cs/UTolNJ7p4nBgVjPIYz9dvvzCU4q0laIG7V9EcEcTUHmuylBwKMKICIG/dFeZVn8aG2L+rWl0RCaTSPfjxDP0qTLmlDow==
Content-Length: 396

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-11T13:19:47.564Z"
  },
  "identifier" : {
    "identifierId" : "17435e6d5e13e1a929cf82a9da6825913d56fba1",
    "identifierType" : "PAY_CARD",
    "identifierValue" : "************2987",
    "cardScheme" : "VISA",
    "paymentInstrumentType" : "03",
    "expirationDate" : "1023",
    "tokenValue" : "564RKSYT72GC5"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/identities/0e27b15f-2b13-4ab5-a2bd-d291582fa39d/identifiers' -i -X POST \
    -H 'Content-Type: application/vnd.identities.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ' \
    -H 'Accept: application/vnd.identities.v1+json' \
    -d '{
  "identifier" : {
    "identifierType" : "PAY_CARD",
    "identifierValue" : "************2987",
    "encryptionKey" : {
      "keyId" : "NAME-OF-PUBLIC-KEY",
      "encryptionType" : "RSAOAEP"
    },
    "encryptedValue" : "ZkR6VW5GTUkvVHNkR0Y5S3V4UGZqL0U3amV2bUk3Li4u",
    "bin" : "123456",
    "cardScheme" : "VISA",
    "paymentInstrumentType" : "03",
    "expirationDate" : "1023"
  }
}'

9.2.16. Delete an Identifier using request body

DELETE /identities/{consumerId}/identifiers
Parameters
Type Name Description Schema Default

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

consumerId
required

string (uuid)

Query

useExpirationDate
optional

true if expirationDate or expirationLocalDate should be used as part of finding the Identifier

boolean

"false"
Body parameter

Name : body
Flags : required
Type : IdentifierRequest

Responses
HTTP Code Description Schema

204

No Content - Deleted successfully

No Content

400

Bad Request

CommonResponse

404

Not Found

CommonResponse
Consumes

  • application/vnd.identities.v1+json

Produces

  • application/vnd.identities.v1+json

Tags

  • Manage Identity Identifiers

Example HTTP request
DELETE /identities/0e27b15f-2b13-4ab5-a2bd-d291582fa39d/identifiers HTTP/1.1
Content-Type: application/vnd.identities.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ
Accept: application/vnd.identities.v1+json
Content-Length: 395
Host: api.aerahost.com

{
  "identifier" : {
    "identifierType" : "PAY_CARD",
    "identifierValue" : "************2987",
    "encryptionKey" : {
      "keyId" : "NAME-OF-PUBLIC-KEY",
      "encryptionType" : "RSAOAEP"
    },
    "encryptedValue" : "ZkR6VW5GTUkvVHNkR0Y5S3V4UGZqL0U3amV2bUk3Li4u",
    "bin" : "123456",
    "cardScheme" : "VISA",
    "paymentInstrumentType" : "03",
    "expirationDate" : "1023"
  }
}
Example HTTP response
HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Example Curl request
$ curl 'https://api.aerahost.com/identities/0e27b15f-2b13-4ab5-a2bd-d291582fa39d/identifiers' -i -X DELETE \
    -H 'Content-Type: application/vnd.identities.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ' \
    -H 'Accept: application/vnd.identities.v1+json' \
    -d '{
  "identifier" : {
    "identifierType" : "PAY_CARD",
    "identifierValue" : "************2987",
    "encryptionKey" : {
      "keyId" : "NAME-OF-PUBLIC-KEY",
      "encryptionType" : "RSAOAEP"
    },
    "encryptedValue" : "ZkR6VW5GTUkvVHNkR0Y5S3V4UGZqL0U3amV2bUk3Li4u",
    "bin" : "123456",
    "cardScheme" : "VISA",
    "paymentInstrumentType" : "03",
    "expirationDate" : "1023"
  }
}'

9.2.17. Delete an Identifier

DELETE /identities/{consumerId}/identifiers/{identifierId}
Parameters
Type Name Description Schema Default

Header

Accept
optional

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

consumerId
required

string (uuid)

Path

identifierId
required

string

Query

ignoreDefaultPaymentInstrument
optional

Relevant for IdentifierType=PAY_?, will delete even if defaultPaymentInstrument=true, and choose a random PAY_? as new default

boolean

"false"
Responses
HTTP Code Description Schema

204

No Content - Deleted successfully

No Content

400

Bad Request

CommonResponse

404

Not Found

CommonResponse
Produces

  • application/vnd.identities.v1+json

Tags

  • Manage Identity Identifiers

Example HTTP request
DELETE /identities/0e27b15f-2b13-4ab5-a2bd-d291582fa39d/identifiers/17435e6d5e13e1a929cf82a9da6825913d56fba1 HTTP/1.1
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995
x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Example Curl request
$ curl 'https://api.aerahost.com/identities/0e27b15f-2b13-4ab5-a2bd-d291582fa39d/identifiers/17435e6d5e13e1a929cf82a9da6825913d56fba1' -i -X DELETE \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'x-amzn-trace-id: Root=1-5fdb1e8e-4f35d2c04f5d327916850995' \
    -H 'x-amzn-requestid: 92ac8e15-4231-4d9e-b1a8-1a40a00ce400' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbElkZW50aXRpZXMiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwNCwianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.PsqD4G3kEI77lh5_Te2e6NlUWrYM1HI10H2A7bO0p4TeTRqZQF36J-x0MVf-cyECRuUCoLiaL5BXbHw0tT_7A3ak5f375oX8abRzkMoVvLrQPVOfIceEUC8iMcndN1V4keyOiJxju2FANFkbmAwuNxg1DeGPEu9O-UQJGnEz3O_fPDGKQG1gwb6UlB4wjC0S88cG1ozeY2_UpTH84u81K6uszumvoP2NnlP_zkQaNGGR5AZKqmN9n_MJM8DiAbaSVpnM9-DEZJZRDkohWmQ__BbUxaRfvEO2GQrC6eqZ0TB2aPluspOl78u1nb9v-PftqzdAd3WSqjItvr8THJaJQQ'

9.3. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

9.3.1. Attribute

A list of other attributes

Name Description Schema

attributeType
required

The type of Attribute.
Example : "ADDRESS"

enum (ADDRESS, CITY, COUNTRY, FIRST_NAME, FULL_NAME, MIDDLE_NAME, LAST_NAME, POSTAL_CODE, COMPANY, BIRTH_DATE)

attributeValue
required

The description of the Attribute.
Length : 0 - 255
Example : "Apalveien 111"

string

authenticationLevel
optional

The authentication level according to the the eIDAS Regulation.

enum (ZERO_ASSURANCE, LOW_ASSURANCE, SUBSTANTIAL_ASSURANCE, HIGH_ASSURANCE)

9.3.2. CommonResponse

Name Schema

responseInfo
optional

ResponseInfo

9.3.3. EncryptionKey

Identification of the encryption key. Mandatory if the identifier is encrypted

Name Description Schema

encryptionType
optional

The type of encryption used. Default value is DUKPT
Example : "RSAOAEP"

enum (DUKPT, RSAOAEP)

keyId
required

Identification of the key.
Minimum length : 1
Pattern : "^[A-Za-z0-9-_]{1,30}$"
Example : "SOME-COMPANY-TEST-V0"

string

9.3.4. ExpiringPaymentCard

List of expiring/expired payment cards.

Name Description Schema

cardScheme
optional

The Card Scheme of the payment card

string

consumerId
optional

The consumerId identifying the Identity having the payment card

string (uuid)

expirationDate
optional

Expiration date for the payment card. Format: yyyy-MM-dd

string (date)

identifierId
optional

The IdentifierId of the payment card

string

maskedPan
optional

The masked PAN (Primary Account Number) of the payment card

string

paymentInstrumentType
optional

The Payment Instrument Type (PIT) of the payment card

string

9.3.5. ExpiringPaymentCardsResponse

Name Description Schema

expiringPaymentCards
optional

List of expiring/expired payment cards.

< ExpiringPaymentCard > array

responseInfo
optional

ResponseInfo

9.3.6. Identifier

A list of Identifiers

Name Description Schema

authenticationLevel
optional

The authentication level according to the the eIDAS Regulation.

enum (ZERO_ASSURANCE, LOW_ASSURANCE, SUBSTANTIAL_ASSURANCE, HIGH_ASSURANCE)

bin
optional

A payment card’s BIN number (4-8 first digits)
Length : 4 - 8
Pattern : "^[0-9]{4,8}$"
Example : "12345678"

string

cardScheme
optional

The Card Scheme, mandatory when identifierType=PAY_CARD
Length : 0 - 25
Pattern : "^[a-zA-Z0-9\\s]*$"
Example : "VISA"

string

cardType
optional

The Card Type. Valid values:
C = Credit
D = Debit
P = Prepaid
U = Unknown
Example : "C"

enum (P, C, D, U)

defaultPaymentInstrument
optional

Indicates if the payment instrument is the default payment instrument in a wallet.

boolean

description
optional

A description for the identifier
Length : 0 - 255
Example : "My Visa Card"

string

encryptedValue
optional

Set if identifier is encrypted
Length : 0 - 512
Example : "vOXA9UnW…​BlhQ="

string

encryptionKey
optional

EncryptionKey

expirationDate
optional

Expiration date for a payment card. Format: MMYY
Length : 0 - 4
Pattern : "^(0[1-9]|1[0-2])[0-9]{2}$"
Example : "1221"

string

expirationLocalDate
optional

Expiration date for a payment method. Format: yyyy-MM-dd
Example : "2021-12-31"

string (date)

identifierId
optional

The unique id for an identifier
Length : 40
Pattern : "^[a-zA-Z0-9]+$"
Example : "f63a027e10…​0a15"

string

identifierType
required

The type of Identifier.
Example : "PAY_CARD"

enum (PAY_CARD, PAY_ACCOUNT, EMAIL, MOBILE_NUMBER, ADDITIONAL_ID, WALLET_REF, ACCOUNT_NUMBER, LOYALTY, SSN, SSN_ALIAS, PID, FREJA_EID, ID_DOCUMENT_SN, HASH)

identifierValue
required

A display safe description for the identifier. Will be masked in responses for ACCOUNT_NUMBER and PAY_CARD
Length : 0 - 255
Example : "…​7297"

string

originalIdentifierValue
optional

Original identifier description used when creating Identifier. For response only.
Length : 10 - 50
Example : "<usually not set>"

string

paymentAccountReference
optional

A Payment Account Reference (PAR) is an EMVCo standard value used to link tokenized and PAN-based transactions without PAN as the linkage mechanism. A PAR is 29 characters long. The first four characters of the PAR will contain BIN Controller Identifier. The remaining 25 characters are randomly assigned unique numbers.
Length : 29
Pattern : "^[a-zA-Z0-9]+$"

string

paymentInstrumentType
optional

The Payment Instrument Type (PIT), will be mandatory when identifierType=PAY_CARD
Length : 0 - 3
Pattern : "^[0-9]{2,3}$"
Example : "03"

string

9.3.7. IdentifierRequest

Name Schema

identifier
required

Identifier

9.3.8. IdentifierResponse

Name Schema

identifier
optional

Identifier

responseInfo
optional

ResponseInfo

9.3.9. IdentitiesWithCardSchemeResponse

Name Description Schema

consumerIds
optional

List of consumerId identifying Identity with Identifier=PAY_CARD and cardScheme as requested.

< string (uuid) > array

responseInfo
optional

ResponseInfo

9.3.10. Identity

The Identity representing a Consumer

Name Description Schema

attributes
optional

A list of other attributes

< Attribute > array

consumerId
optional

The unique id of an Identity

string (uuid)

identifiers
optional

A list of Identifiers

< Identifier > array

loyalties
optional

A list of Loyalty Memberships

< Loyalty > array

9.3.11. IdentityRequest

Name Schema

identity
required

Identity

9.3.12. IdentityResponse

Name Schema

identity
optional

Identity

responseInfo
optional

ResponseInfo

9.3.13. LoyaltiesResponse

Name Description Schema

consumerId
optional

The unique id of an Identity

string (uuid)

externalLoyalties
optional

The Loyalties returned from a Cross Loyalty search

< Loyalty > array

loyalties
optional

The Loyalties returned from a loyalty search

< Loyalty > array

responseInfo
optional

ResponseInfo

sharedIdResolve
optional

Shared ID resolves (loyalty searches) from other merchants. Used for instance in bi-lateral agreements where a consumer gets a benefit if shopped both places.

< SharedIdResolve > array

9.3.14. Loyalty

A list of Loyalty Memberships

Name Description Schema

loyaltyType
required

The type of loyalty program
Length : 0 - 255

string

loyaltyValue
required

The value (id/number) of the member’s loyalty program
Length : 0 - 255

string

9.3.15. PaymentInstrument

Prioritized list of payment instruments.

Name Description Schema

cardScheme
optional

The Card Scheme, mandatory when identifierType=PAY_CARD

string

cardType
optional

The Card Type. Valid values:
C = Credit
D = Debit
P = Prepaid
U = Unknown

enum (P, C, D, U)

defaultPaymentInstrument
optional

Indicates if the payment instrument is the default payment instrument in a wallet.

boolean

description
optional

A description/name for the payment instrument.

string

expirationdate
optional

The expiration date of the payment instrument.

string (date)

identifierId
optional

The unique id for an identifier

string

identifierType
optional

The type of Identifier.

enum (PAY_CARD, PAY_ACCOUNT)

identifierValue
optional

A display safe value for the payment instrument.

string

paymentInstrumentType
optional

The Payment Instrument Type (PIT), will be mandatory when identifierType=PAY_CARD

string

priority
optional

The payment instrument priority.
Highest priority is 1, and is the recommended payment instrument to use.
Priority is from 1 to N, where N is the number of payment instruments in the list.

integer (int32)

provider
optional

The provider of the identifier.
E.g. The providing bank of an account number.

string

9.3.16. PaymentInstrumentResponse

Name Description Schema

consumerId
optional

string (uuid)

paymentInstruments
optional

Prioritized list of payment instruments.

< PaymentInstrument > array

responseInfo
optional

ResponseInfo

9.3.17. ResponseInfo

Info object that can provide specific messages

Name Description Schema

externalResponseCode
optional

Additional response code from external systems.

string

message
optional

Specific response message

string

responseCode
required

Minimum length : 1

string

timeStamp
required

Timestamp. Mandatory
Minimum length : 1
Example : "2021-12-21T10:23:19.279Z"

string

9.3.18. SharedIdResolve

Shared ID resolves (loyalty searches) from other merchants. Used for instance in bi-lateral agreements where a consumer gets a benefit if shopped both places.

Name Description Schema

created
optional

Timestamp of the ID-Resolve at the merchant.

string (date-time)

id
optional

The identificator of this shared ID-Resolve. Can be used to delete after usage.

string (uuid)

merchant
optional

Usually the StoreId where the ID-Resolve is originated

string

9.3.19. Status

Name Schema

description
optional

string

status
optional

string

9.3.20. Transaction

Name Description Schema

deviceId
optional

The device that initiated the transaction

string

identityResponse
optional

TransactionResponseWrapper

merchantId
optional

The merchant that initiated the transaction

string

retransmissionCounter
optional

How many times the request is sent

integer (int32)

stan
optional

System Trace Audit Number

string

timeStamp
optional

Timestamp for when the transaction was completed

string (date-time)

9.3.21. TransactionResponseWrapper

The response sent as a result of the transaction

Name Description Schema

identity
optional

Identity

loyalties
optional

The Loyalties returned from a loyalty search (ID-LOOKUP)

< Loyalty > array

responseInfo
optional

ResponseInfo

9.3.22. TransactionsResponse

Name Schema

responseInfo
optional

ResponseInfo

transactions
optional

< Transaction > array

10. Authentication Services

Service paths and model definition for the Identity-Authentication Services

10.1. What is Authentication Services

Resource used to get an Authentication/Verification of an Identity or its identifiers. This can for example be National Personal ID, Mobile Phone Number, E-mail, Name etc.

Also offer service for sending One-Time Password (OTP) or Tokens via SMS.

10.2. Paths

Descriptions of resources/paths in the service.

10.2.1. Generate a token that may be used for email or SMS verification.

POST /authenticate/generate/verificationCode
Parameters
Type Name Description Schema

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : GenerateVerificationCodeRequest

Responses
HTTP Code Description Schema

200

OK

GenerateVerificationCodeResponse
Consumes

  • application/vnd.authentication.v1+json

Produces

  • application/vnd.authentication.v1+json

Tags

  • Authentication

Example HTTP request
POST /authenticate/generate/verificationCode HTTP/1.1
Content-Type: application/vnd.authentication.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMDEwODhmNjQtMzFkZi00NGYzLThkMDAtODg0Y2U5YTc1MjIxIiwic2NvcGUiOlsic2VuZFZhbGlkYXRpb25TTVMiLCJnZW5lcmF0ZVZlcmlmaWNhdGlvbkNvZGUiLCJ2ZXJpZnlWZXJpZmljYXRpb25Db2RlIiwiZ2V0UGVyc29uSW5mb0ZpbmFucyJdLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJuYmYiOjE1MjQ3MjgxODksImlhdCI6MTUyNDcyODE4OSwiZXhwIjo5OTgzNDExOTAzLCJqdGkiOiIyZDY1YjRhOS05YTk2LTQ5YWYtYjI3Yi1lNWEzOTNiMzBmNzUifQ.YCZOPGsk-QJhCbv0QJoNOZfFiCd81CrFj6-I7z3vm_eQy7sfpJ-dg_2m-eSGmX0sOHFP2b3qMVUU9PCSiYDU16DY22Cx5ZKbOUeiWqu6yDjI1WJwnBrejcOb_-evgiw_OCExc5K_7EdcuKPO8L0lSWMvPiN_nWWmq0eT-bKUtH_su9A4DmBc-_ZYODNyQGD59tCe4-PT9F6Q0OGmxezdto0SVkFx39X2uxT8s8PIRVohSm2HC55PLlwzMG_jUDQpZwuDDWT1rLkDqfjgfIZTMVvSoOtRji55mF2Ii_vyCb5ZkXvZGZEifGzTVllvFY-MGgm-0qEkTsnEZMi4HsgN-Q
Accept: application/vnd.authentication.v1+json
Content-Length: 163
Host: api.aerahost.com

{
  "requestInfo" : {
    "timeStamp" : "2025-08-13T06:35:02.92Z"
  },
  "smsType" : "TOKEN",
  "verificationId" : "test@mail.com",
  "validityDuration" : "P14D"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.authentication.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: Go/DlVK+oUvVIuMlUOyamRvhVNBN4kLiPZXtI09Sv+sLc37CpmLdEWrOJPb+cpKXXmlEBeALDn0fVC/AJrrRTLJtrhJQW8bbus0QOipD2vUitQljBDV2sePWSNH+nttC42xwErejo/zDM/PQViH34wo1iFynUfKKyrFOD7k9Oehn9FoneFxRJ4FEV9516HL4WmVSDKqQcFywdUtZq5Qt7z8UjIuPY57KJJ8FH5XZqaO5m0LnunkCQ6BgR2+Oad+sUMGttlU4KK86lFQ9gFRXA8/2ElSzbGhGq7QTkODW1v22KItNsOIQlFGNf5UlrmOaCrskp4RynFdMmHEdahrzcA==
Content-Length: 275

{
  "responseInfo" : {
    "message" : "Generated verificationCode for ID: test@mail.com, valid until: 2025-08-27T06:35:02.945686081Z",
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T06:35:02.945Z"
  },
  "verificationCode" : "dc110c42-d04d-4bd4-bf87-08a233b67f8e"
}
Example Curl request
$ curl 'https://api.aerahost.com/authenticate/generate/verificationCode' -i -X POST \
    -H 'Content-Type: application/vnd.authentication.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMDEwODhmNjQtMzFkZi00NGYzLThkMDAtODg0Y2U5YTc1MjIxIiwic2NvcGUiOlsic2VuZFZhbGlkYXRpb25TTVMiLCJnZW5lcmF0ZVZlcmlmaWNhdGlvbkNvZGUiLCJ2ZXJpZnlWZXJpZmljYXRpb25Db2RlIiwiZ2V0UGVyc29uSW5mb0ZpbmFucyJdLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJuYmYiOjE1MjQ3MjgxODksImlhdCI6MTUyNDcyODE4OSwiZXhwIjo5OTgzNDExOTAzLCJqdGkiOiIyZDY1YjRhOS05YTk2LTQ5YWYtYjI3Yi1lNWEzOTNiMzBmNzUifQ.YCZOPGsk-QJhCbv0QJoNOZfFiCd81CrFj6-I7z3vm_eQy7sfpJ-dg_2m-eSGmX0sOHFP2b3qMVUU9PCSiYDU16DY22Cx5ZKbOUeiWqu6yDjI1WJwnBrejcOb_-evgiw_OCExc5K_7EdcuKPO8L0lSWMvPiN_nWWmq0eT-bKUtH_su9A4DmBc-_ZYODNyQGD59tCe4-PT9F6Q0OGmxezdto0SVkFx39X2uxT8s8PIRVohSm2HC55PLlwzMG_jUDQpZwuDDWT1rLkDqfjgfIZTMVvSoOtRji55mF2Ii_vyCb5ZkXvZGZEifGzTVllvFY-MGgm-0qEkTsnEZMi4HsgN-Q' \
    -H 'Accept: application/vnd.authentication.v1+json' \
    -d '{
  "requestInfo" : {
    "timeStamp" : "2025-08-13T06:35:02.92Z"
  },
  "smsType" : "TOKEN",
  "verificationId" : "test@mail.com",
  "validityDuration" : "P14D"
}'

10.2.2. Get Application Status (Health check)

GET /authenticate/health
Parameters
Type Name Description Schema

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Responses
HTTP Code Description Schema

200

OK

Status
Produces

  • application/json

Tags

  • Authentication

Example HTTP request
GET /authenticate/health HTTP/1.1
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Accept: application/json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 21

{
  "status" : "UP"
}
Example Curl request
$ curl 'https://api.aerahost.com/authenticate/health' -i -X GET \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Accept: application/json'

10.2.3. Send SMS with support for either token link or OTP

POST /authenticate/send/sms
Parameters
Type Name Description Schema

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : SendSMSRequest

Responses
HTTP Code Description Schema

200

OK

SendMessageResponse
Consumes

  • application/vnd.authentication.v1+json

Produces

  • application/vnd.authentication.v1+json

Tags

  • Authentication

Example HTTP request
POST /authenticate/send/sms HTTP/1.1
Content-Type: application/vnd.authentication.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMDEwODhmNjQtMzFkZi00NGYzLThkMDAtODg0Y2U5YTc1MjIxIiwic2NvcGUiOlsic2VuZFZhbGlkYXRpb25TTVMiLCJnZW5lcmF0ZVZlcmlmaWNhdGlvbkNvZGUiLCJ2ZXJpZnlWZXJpZmljYXRpb25Db2RlIiwiZ2V0UGVyc29uSW5mb0ZpbmFucyJdLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJuYmYiOjE1MjQ3MjgxODksImlhdCI6MTUyNDcyODE4OSwiZXhwIjo5OTgzNDExOTAzLCJqdGkiOiIyZDY1YjRhOS05YTk2LTQ5YWYtYjI3Yi1lNWEzOTNiMzBmNzUifQ.YCZOPGsk-QJhCbv0QJoNOZfFiCd81CrFj6-I7z3vm_eQy7sfpJ-dg_2m-eSGmX0sOHFP2b3qMVUU9PCSiYDU16DY22Cx5ZKbOUeiWqu6yDjI1WJwnBrejcOb_-evgiw_OCExc5K_7EdcuKPO8L0lSWMvPiN_nWWmq0eT-bKUtH_su9A4DmBc-_ZYODNyQGD59tCe4-PT9F6Q0OGmxezdto0SVkFx39X2uxT8s8PIRVohSm2HC55PLlwzMG_jUDQpZwuDDWT1rLkDqfjgfIZTMVvSoOtRji55mF2Ii_vyCb5ZkXvZGZEifGzTVllvFY-MGgm-0qEkTsnEZMi4HsgN-Q
Accept: application/vnd.authentication.v1+json
Content-Length: 206
Host: api.aerahost.com

{
  "requestInfo" : {
    "timeStamp" : "2025-08-13T06:35:00.214Z"
  },
  "smsType" : "TOKEN",
  "toNumbers" : [ "91234567" ],
  "from" : "Aera",
  "messageText" : "<token>",
  "validityDuration" : "PT2H"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.authentication.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: Zo9naVxonO64UwJGa7k4iez6DigwH2J3aEOobdoCl05HVoJbKkxoj7SodE+pRdvlhsx2i5hk8HxKuHQdjZ1ES9nCg35Ut6IUa5B8Yq0ASznHEBp8GrfUmq0kMx8u2wJ+hsEDMq4O4pA54harTAon2IVSLseUq7zS5RFOBMR4yHW/NtcxLImGeT0AbVCOV+/AnDVhQvr87R4kkOoFlgJPsIj0HgL80Zf6/a7qY6Qd61FqITJTfsRZuSFrUKiDYV6P7z4G0O2EC+qiRPaMW4J1X95XnDW4L+mwHTkZqTcorQzDyx3zLffd6RCWYeYDdUQQYnG+dJ0R8W80YeyrO/2Wpw==
Content-Length: 183

{
  "responseInfo" : {
    "message" : "Send SMS request received successfully, and has processed 1 SMS.",
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T06:35:00.868Z"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/authenticate/send/sms' -i -X POST \
    -H 'Content-Type: application/vnd.authentication.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMDEwODhmNjQtMzFkZi00NGYzLThkMDAtODg0Y2U5YTc1MjIxIiwic2NvcGUiOlsic2VuZFZhbGlkYXRpb25TTVMiLCJnZW5lcmF0ZVZlcmlmaWNhdGlvbkNvZGUiLCJ2ZXJpZnlWZXJpZmljYXRpb25Db2RlIiwiZ2V0UGVyc29uSW5mb0ZpbmFucyJdLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJuYmYiOjE1MjQ3MjgxODksImlhdCI6MTUyNDcyODE4OSwiZXhwIjo5OTgzNDExOTAzLCJqdGkiOiIyZDY1YjRhOS05YTk2LTQ5YWYtYjI3Yi1lNWEzOTNiMzBmNzUifQ.YCZOPGsk-QJhCbv0QJoNOZfFiCd81CrFj6-I7z3vm_eQy7sfpJ-dg_2m-eSGmX0sOHFP2b3qMVUU9PCSiYDU16DY22Cx5ZKbOUeiWqu6yDjI1WJwnBrejcOb_-evgiw_OCExc5K_7EdcuKPO8L0lSWMvPiN_nWWmq0eT-bKUtH_su9A4DmBc-_ZYODNyQGD59tCe4-PT9F6Q0OGmxezdto0SVkFx39X2uxT8s8PIRVohSm2HC55PLlwzMG_jUDQpZwuDDWT1rLkDqfjgfIZTMVvSoOtRji55mF2Ii_vyCb5ZkXvZGZEifGzTVllvFY-MGgm-0qEkTsnEZMi4HsgN-Q' \
    -H 'Accept: application/vnd.authentication.v1+json' \
    -d '{
  "requestInfo" : {
    "timeStamp" : "2025-08-13T06:35:00.214Z"
  },
  "smsType" : "TOKEN",
  "toNumbers" : [ "91234567" ],
  "from" : "Aera",
  "messageText" : "<token>",
  "validityDuration" : "PT2H"
}'

10.2.4. Verify Mobile Terminated (MT) One-Time Password (OTP)

POST /authenticate/verify/verificationCode
Parameters
Type Name Description Schema

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : VerifyVerificationCodeRequest

Responses
HTTP Code Description Schema

200

OK

VerifyVerificationCodeResponse
Consumes

  • application/vnd.authentication.v1+json

Produces

  • application/vnd.authentication.v1+json

Tags

  • Authentication

Example HTTP request
POST /authenticate/verify/verificationCode HTTP/1.1
Content-Type: application/vnd.authentication.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMDEwODhmNjQtMzFkZi00NGYzLThkMDAtODg0Y2U5YTc1MjIxIiwic2NvcGUiOlsic2VuZFZhbGlkYXRpb25TTVMiLCJnZW5lcmF0ZVZlcmlmaWNhdGlvbkNvZGUiLCJ2ZXJpZnlWZXJpZmljYXRpb25Db2RlIiwiZ2V0UGVyc29uSW5mb0ZpbmFucyJdLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJuYmYiOjE1MjQ3MjgxODksImlhdCI6MTUyNDcyODE4OSwiZXhwIjo5OTgzNDExOTAzLCJqdGkiOiIyZDY1YjRhOS05YTk2LTQ5YWYtYjI3Yi1lNWEzOTNiMzBmNzUifQ.YCZOPGsk-QJhCbv0QJoNOZfFiCd81CrFj6-I7z3vm_eQy7sfpJ-dg_2m-eSGmX0sOHFP2b3qMVUU9PCSiYDU16DY22Cx5ZKbOUeiWqu6yDjI1WJwnBrejcOb_-evgiw_OCExc5K_7EdcuKPO8L0lSWMvPiN_nWWmq0eT-bKUtH_su9A4DmBc-_ZYODNyQGD59tCe4-PT9F6Q0OGmxezdto0SVkFx39X2uxT8s8PIRVohSm2HC55PLlwzMG_jUDQpZwuDDWT1rLkDqfjgfIZTMVvSoOtRji55mF2Ii_vyCb5ZkXvZGZEifGzTVllvFY-MGgm-0qEkTsnEZMi4HsgN-Q
Accept: application/vnd.authentication.v1+json
Content-Length: 158
Host: api.aerahost.com

{
  "requestInfo" : {
    "timeStamp" : "2025-08-13T06:34:59.883Z"
  },
  "verificationCode" : "dc110c42-d04d-4bd4-bf87-08a233b67f8e",
  "smsType" : "TOKEN"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.authentication.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: XRdfzZdi0eeQI9vHbI5c3k2KS7KYV9iq5EB/4d8Nljpv7uMJlJ3qThAped8iXMsS33+7aOQRvewjR+9DX2xHprAKtJYKvZxerwC1yWnB4V0zMnEyblq0b5jcRywgAgS7seHdDo6dBbgdQrse88rIAqE20Srqsersy8+Mguva5LHP4LGcKA7zVkdF37uWN9ZtshK5DPGVQxXxnZPt3Q9Ifz1wfqKFM06GfGL9W48EtIaG1Tv7M4dsiCaTgqmaqKUAzIr+WLHxGvGXhAjSANk41oxweh5TofmussmLzSJ0M/ezLDU21BGXdRGonNAd0YBHJwmwG6fg/JLrF74cJSdYVQ==
Content-Length: 229

{
  "responseInfo" : {
    "message" : "The provided verificationCode is valid for verificationId: test@mail.com",
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T06:34:59.965Z"
  },
  "verificationId" : "test@mail.com"
}
Example Curl request
$ curl 'https://api.aerahost.com/authenticate/verify/verificationCode' -i -X POST \
    -H 'Content-Type: application/vnd.authentication.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMDEwODhmNjQtMzFkZi00NGYzLThkMDAtODg0Y2U5YTc1MjIxIiwic2NvcGUiOlsic2VuZFZhbGlkYXRpb25TTVMiLCJnZW5lcmF0ZVZlcmlmaWNhdGlvbkNvZGUiLCJ2ZXJpZnlWZXJpZmljYXRpb25Db2RlIiwiZ2V0UGVyc29uSW5mb0ZpbmFucyJdLCJpc3MiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJhdWQiOiJhZXJhLnRlc3QtcmVzb3VyY2UiLCJuYmYiOjE1MjQ3MjgxODksImlhdCI6MTUyNDcyODE4OSwiZXhwIjo5OTgzNDExOTAzLCJqdGkiOiIyZDY1YjRhOS05YTk2LTQ5YWYtYjI3Yi1lNWEzOTNiMzBmNzUifQ.YCZOPGsk-QJhCbv0QJoNOZfFiCd81CrFj6-I7z3vm_eQy7sfpJ-dg_2m-eSGmX0sOHFP2b3qMVUU9PCSiYDU16DY22Cx5ZKbOUeiWqu6yDjI1WJwnBrejcOb_-evgiw_OCExc5K_7EdcuKPO8L0lSWMvPiN_nWWmq0eT-bKUtH_su9A4DmBc-_ZYODNyQGD59tCe4-PT9F6Q0OGmxezdto0SVkFx39X2uxT8s8PIRVohSm2HC55PLlwzMG_jUDQpZwuDDWT1rLkDqfjgfIZTMVvSoOtRji55mF2Ii_vyCb5ZkXvZGZEifGzTVllvFY-MGgm-0qEkTsnEZMi4HsgN-Q' \
    -H 'Accept: application/vnd.authentication.v1+json' \
    -d '{
  "requestInfo" : {
    "timeStamp" : "2025-08-13T06:34:59.883Z"
  },
  "verificationCode" : "dc110c42-d04d-4bd4-bf87-08a233b67f8e",
  "smsType" : "TOKEN"
}'

10.3. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

10.3.1. GenerateVerificationCodeRequest

Name Description Schema

requestInfo
required

RequestInfo

smsType
required

The Type of verification code to generate

enum (TOKEN, OTP, TEXT)

validityDuration
optional

Duration of period that the Token will be stored. Based on ISO-8601 duration format PnDTnHnMn.nS; e.g. PT60S (60 seconds)
Pattern : "^P[0-9YMWDTHS.,-:]+$"

string

verificationId
required

The e-mail address, phone number etc, or a hashed variant.
Length : 0 - 255

string

10.3.2. GenerateVerificationCodeResponse

Name Description Schema

responseInfo
optional

ResponseInfo

verificationCode
optional

The generated verification code

string

10.3.3. ResponseInfo

Info object that can provide specific messages

Name Description Schema

externalResponseCode
optional

Additional response code from external systems.

string

message
optional

Specific response message

string

responseCode
required

Minimum length : 1

string

timeStamp
required

Timestamp. Mandatory
Minimum length : 1
Example : "2021-12-21T10:23:19.279Z"

string

10.3.4. SendMessageResponse

Name Schema

responseInfo
optional

ResponseInfo

10.3.5. SendSMSRequest

Name Description Schema

from
required

The name (max 11 characters) or mobile number of the sender.
Length : 0 - 20

string

messageText
required

The content of the SMS. The placeholder &lttoken&gt is required if smsType = TOKEN or OTP
Length : 0 - 255

string

requestInfo
required

RequestInfo

smsType
required

Type of sms to be sent

enum (TOKEN, OTP, TEXT)

toNumbers
required

A list of destination numbers

< string > array

validityDuration
optional

Duration of period that the Token will be stored. Based on ISO-8601 duration format PnDTnHnMn.nS; e.g. PT60S (60 seconds)

string

10.3.6. Status

Name Schema

description
optional

string

status
optional

string

10.3.7. VerifyVerificationCodeRequest

Name Description Schema

requestInfo
required

RequestInfo

smsType
required

The Type of verification code to verify.

enum (TOKEN, OTP, TEXT)

verificationCode
required

The verification code to be verified.
Length : 0 - 255

string

verificationId
optional

The verification id linked to the verification code. Required if type = OTP
Length : 0 - 255

string

10.3.8. VerifyVerificationCodeResponse

Name Description Schema

responseInfo
optional

ResponseInfo

verificationId
optional

The e-mail address, phone number etc. if success.

string

11. Document Services

Service paths and model definition for the Document Services

11.1. Paths

Descriptions of resources/paths in the service.

11.1.1. Add a new Document

POST /documents/
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : DocumentRequest

Responses
HTTP Code Description Schema

201

Created

DocumentMetaData
Consumes

  • application/vnd.documents.v1+json

Produces

  • application/vnd.documents.v1+json

Tags

  • documents

Example HTTP request
POST /documents/ HTTP/1.1
Content-Type: application/vnd.documents.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMzViOWU3ODktNDg2Ni00NDUzLWIzMjgtMjQ5NzlmODJmMDYwIiwic2NvcGUiOlsiYWxsRG9jdW1lbnRzIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDQsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.t4B-WDnPBeiupeXsn4r456Efs_M-lDxMqVc3febvZnwrkquGZfyifB9dXT3LDgkHaMdyBEVRNqNNmuzhOnzfNDc2feigiYlLGPf9S9e-Ruu7Vw3N0zxWH1IqvdxHs14X7EGs0JepzhVzJ00CvdVzv1jcgmzMR2cK9gfzyzu0v0YM-MSfkHYgvAh5jQtvL55GY2ftzZDYna_q0sUaoD-4AuU2bLKGbj8g0OhM5kCR_9g_zP9-kHVLQjTHrttFjDeNhCMrpEAhyGkMsipC_9Gv2tcWwcpS_GzcsrjvfdXt3etpdzVF_28lewKsTIuomlSvu29mIGnUnn8l2H5ol_k9lg
Accept: application/vnd.documents.v1+json
Content-Length: 379
Host: api.aerahost.com

{
  "document" : {
    "documentId" : "0e27b15f-2b13-4ab5-a2bd-d291582fa39d",
    "consumerReference" : "14060024287",
    "pid" : "9570-3216-4-32471",
    "externalReference" : "EXT12345678910",
    "description" : "Description",
    "encoding" : "Base64",
    "mimeType" : "application/jose",
    "version" : "v1.0",
    "content" : "UGxlYXNlIHNpZ24gdGhpcyBkb2N1bWVudA=="
  }
}
Example HTTP response
HTTP/1.1 201 Created
Content-Type: application/vnd.documents.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: l/YZtUEJoTf+2sZobcfcR2rLzI885HHuQ+CGlsJSPDPEGLnq+Y3AxhoTlzA38T6dGF3fMetYuzM3LIk/l1YBQKQiyAe5LA0ftf880i/7hzTsEII/O0rZwz2eyK7C6wDbzFJTJyv5NSBVjybcBNdaioGufU/50KQALogvbSj0LFRdnuMgQXwM9akBSjtM1ek4Z966ATM2kiaoM58AuTK9z8o4DZqaHHhmtnZS0WaIo7EJEabQhinCSaHvvOs6Cvjwe58w1mQm7A27AMv1fUoPCrHvIeTv5kXlj+8N7WXXsKTB0yJNBy8xzw9c9d4H497x59tyNHUbw3nmcSLgc09/mw==
Content-Length: 322

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T06:34:58.728Z"
  },
  "documentId" : "0e27b15f-2b13-4ab5-a2bd-d291582fa39d",
  "description" : "Description",
  "createdTime" : "2025-08-13T06:34:58.727Z",
  "documentUrl" : "https://foobar.com/documents/0e27b15f-2b13-4ab5-a2bd-d291582fa39d"
}
Example Curl request
$ curl 'https://api.aerahost.com/documents/' -i -X POST \
    -H 'Content-Type: application/vnd.documents.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMzViOWU3ODktNDg2Ni00NDUzLWIzMjgtMjQ5NzlmODJmMDYwIiwic2NvcGUiOlsiYWxsRG9jdW1lbnRzIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDQsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.t4B-WDnPBeiupeXsn4r456Efs_M-lDxMqVc3febvZnwrkquGZfyifB9dXT3LDgkHaMdyBEVRNqNNmuzhOnzfNDc2feigiYlLGPf9S9e-Ruu7Vw3N0zxWH1IqvdxHs14X7EGs0JepzhVzJ00CvdVzv1jcgmzMR2cK9gfzyzu0v0YM-MSfkHYgvAh5jQtvL55GY2ftzZDYna_q0sUaoD-4AuU2bLKGbj8g0OhM5kCR_9g_zP9-kHVLQjTHrttFjDeNhCMrpEAhyGkMsipC_9Gv2tcWwcpS_GzcsrjvfdXt3etpdzVF_28lewKsTIuomlSvu29mIGnUnn8l2H5ol_k9lg' \
    -H 'Accept: application/vnd.documents.v1+json' \
    -d '{
  "document" : {
    "documentId" : "0e27b15f-2b13-4ab5-a2bd-d291582fa39d",
    "consumerReference" : "14060024287",
    "pid" : "9570-3216-4-32471",
    "externalReference" : "EXT12345678910",
    "description" : "Description",
    "encoding" : "Base64",
    "mimeType" : "application/jose",
    "version" : "v1.0",
    "content" : "UGxlYXNlIHNpZ24gdGhpcyBkb2N1bWVudA=="
  }
}'

11.1.2. Gets all documents linked to a consumer-reference

GET /documents/consumer-reference/{consumerReference}
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

consumerReference
required

string
Responses
HTTP Code Description Schema

200

OK

DocumentsResponse
Produces

  • application/vnd.documents.v1+json

Tags

  • documents

Example HTTP request
GET /documents/consumer-reference/14060024287 HTTP/1.1
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMzViOWU3ODktNDg2Ni00NDUzLWIzMjgtMjQ5NzlmODJmMDYwIiwic2NvcGUiOlsiYWxsRG9jdW1lbnRzIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDQsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.t4B-WDnPBeiupeXsn4r456Efs_M-lDxMqVc3febvZnwrkquGZfyifB9dXT3LDgkHaMdyBEVRNqNNmuzhOnzfNDc2feigiYlLGPf9S9e-Ruu7Vw3N0zxWH1IqvdxHs14X7EGs0JepzhVzJ00CvdVzv1jcgmzMR2cK9gfzyzu0v0YM-MSfkHYgvAh5jQtvL55GY2ftzZDYna_q0sUaoD-4AuU2bLKGbj8g0OhM5kCR_9g_zP9-kHVLQjTHrttFjDeNhCMrpEAhyGkMsipC_9Gv2tcWwcpS_GzcsrjvfdXt3etpdzVF_28lewKsTIuomlSvu29mIGnUnn8l2H5ol_k9lg
Accept: application/vnd.documents.v1+json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.documents.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: G520RSqiRBrIjgQPPeWLAtyzVdpkkxOXVa+nq8hlpM+ZEqKWIu2ITJTeLtGr0c71B9eL121aPhuN+3WfzT5ivDOMZTCuUOYc+kz/H5ePfMQWxRrBANU2CB1C3mWyVbnthO4LsgW2edwD8Bjt4emjvmN76tdQgxE08WpuG/MG3fxqMP+FyXGua7jOF02TeLfTXntgPslHXQiSdME4wXlj91Cu5XqNvPY+pHxjST/IYV+GahNBOJZUPq/mLNAxlkEy1X6z/Lq50oR+NDNMl84Yu5QxaQARELl4Sud1badEEgUYbIl+DMup2BtjmoytckgY+2Ok6X5BHWX9Gm2VDFeexg==
Content-Length: 356

{
  "documents" : [ {
    "documentId" : "0e27b15f-2b13-4ab5-a2bd-d291582fa39d",
    "description" : "Description",
    "createdTime" : "2025-08-12T06:34:58.882Z",
    "documentUrl" : "https://foobar.com/documents/0e27b15f-2b13-4ab5-a2bd-d291582fa39d"
  } ],
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T06:34:58.883Z"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/documents/consumer-reference/14060024287' -i -X GET \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMzViOWU3ODktNDg2Ni00NDUzLWIzMjgtMjQ5NzlmODJmMDYwIiwic2NvcGUiOlsiYWxsRG9jdW1lbnRzIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDQsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.t4B-WDnPBeiupeXsn4r456Efs_M-lDxMqVc3febvZnwrkquGZfyifB9dXT3LDgkHaMdyBEVRNqNNmuzhOnzfNDc2feigiYlLGPf9S9e-Ruu7Vw3N0zxWH1IqvdxHs14X7EGs0JepzhVzJ00CvdVzv1jcgmzMR2cK9gfzyzu0v0YM-MSfkHYgvAh5jQtvL55GY2ftzZDYna_q0sUaoD-4AuU2bLKGbj8g0OhM5kCR_9g_zP9-kHVLQjTHrttFjDeNhCMrpEAhyGkMsipC_9Gv2tcWwcpS_GzcsrjvfdXt3etpdzVF_28lewKsTIuomlSvu29mIGnUnn8l2H5ol_k9lg' \
    -H 'Accept: application/vnd.documents.v1+json'

11.1.3. Get Application Status (Health check)

GET /documents/health
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Responses
HTTP Code Description Schema

200

OK

Status
Produces

  • application/json

  • application/vnd.documents.v1+json

Tags

  • documents

Example HTTP request
GET /documents/health HTTP/1.1
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Accept: application/json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 21

{
  "status" : "UP"
}
Example Curl request
$ curl 'https://api.aerahost.com/documents/health' -i -X GET \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Accept: application/json'

11.1.4. Gets a document by a documentId

GET /documents/{documentId}
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

documentId
required

string
Responses
HTTP Code Description Schema

200

OK

DocumentResponse
Produces

  • application/vnd.documents.v1+json

Tags

  • documents

Example HTTP request
GET /documents/0e27b15f-2b13-4ab5-a2bd-d291582fa39d HTTP/1.1
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMzViOWU3ODktNDg2Ni00NDUzLWIzMjgtMjQ5NzlmODJmMDYwIiwic2NvcGUiOlsiYWxsRG9jdW1lbnRzIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDQsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.t4B-WDnPBeiupeXsn4r456Efs_M-lDxMqVc3febvZnwrkquGZfyifB9dXT3LDgkHaMdyBEVRNqNNmuzhOnzfNDc2feigiYlLGPf9S9e-Ruu7Vw3N0zxWH1IqvdxHs14X7EGs0JepzhVzJ00CvdVzv1jcgmzMR2cK9gfzyzu0v0YM-MSfkHYgvAh5jQtvL55GY2ftzZDYna_q0sUaoD-4AuU2bLKGbj8g0OhM5kCR_9g_zP9-kHVLQjTHrttFjDeNhCMrpEAhyGkMsipC_9Gv2tcWwcpS_GzcsrjvfdXt3etpdzVF_28lewKsTIuomlSvu29mIGnUnn8l2H5ol_k9lg
Accept: application/vnd.documents.v1+json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.documents.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: e/1ZYeSq1fffdNYpme1EnY0nAhNNRT1i71IHWZ96g01JjZx6fd2cqoCVBMey20NFzMUwskadm4LviC8KV+PpgZBB5QPq8+vo97iEJ8bk8foM3gN5FkN9QpJ+Klijr4ywzSvCuX8xowqhnmuRLSBjJo7ZBsy8JVWzUR/gurubTW3lDzGQiYBCKXmu9HwGEypauBMWGtk5QMRYskqbfQrknAMrL/Si8eBIx2JYEoLNDKhsrsdqlvTumRQK6/WBfqjC6XNfExykxQI57BXnlYb9rriUmQbPmXaw4HPAoBWUrsRYslOdbqR63KkBwhXU+RNiKuCextHBMlf+bRlTaMmOEw==
Content-Length: 524

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-13T06:34:56.497Z"
  },
  "document" : {
    "documentId" : "0e27b15f-2b13-4ab5-a2bd-d291582fa39d",
    "consumerReference" : "14060024287",
    "pid" : "9570-3216-4-32471",
    "externalReference" : "EXT12345678910",
    "description" : "Description",
    "encoding" : "Base64",
    "mimeType" : "application/jose",
    "version" : "v1.0",
    "createdTime" : "2025-08-12T06:34:56.497Z",
    "content" : "UGxlYXNlIHNpZ24gdGhpcyBkb2N1bWVudA=="
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/documents/0e27b15f-2b13-4ab5-a2bd-d291582fa39d' -i -X GET \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMzViOWU3ODktNDg2Ni00NDUzLWIzMjgtMjQ5NzlmODJmMDYwIiwic2NvcGUiOlsiYWxsRG9jdW1lbnRzIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDQsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.t4B-WDnPBeiupeXsn4r456Efs_M-lDxMqVc3febvZnwrkquGZfyifB9dXT3LDgkHaMdyBEVRNqNNmuzhOnzfNDc2feigiYlLGPf9S9e-Ruu7Vw3N0zxWH1IqvdxHs14X7EGs0JepzhVzJ00CvdVzv1jcgmzMR2cK9gfzyzu0v0YM-MSfkHYgvAh5jQtvL55GY2ftzZDYna_q0sUaoD-4AuU2bLKGbj8g0OhM5kCR_9g_zP9-kHVLQjTHrttFjDeNhCMrpEAhyGkMsipC_9Gv2tcWwcpS_GzcsrjvfdXt3etpdzVF_28lewKsTIuomlSvu29mIGnUnn8l2H5ol_k9lg' \
    -H 'Accept: application/vnd.documents.v1+json'

11.1.5. Delete a document by a documentId

DELETE /documents/{documentId}
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

documentId
required

string
Responses
HTTP Code Description Schema

204

No Content

No Content
Tags

  • documents

Example HTTP request
DELETE /documents/0e27b15f-2b13-4ab5-a2bd-d291582fa39d HTTP/1.1
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMzViOWU3ODktNDg2Ni00NDUzLWIzMjgtMjQ5NzlmODJmMDYwIiwic2NvcGUiOlsiYWxsRG9jdW1lbnRzIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDQsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.t4B-WDnPBeiupeXsn4r456Efs_M-lDxMqVc3febvZnwrkquGZfyifB9dXT3LDgkHaMdyBEVRNqNNmuzhOnzfNDc2feigiYlLGPf9S9e-Ruu7Vw3N0zxWH1IqvdxHs14X7EGs0JepzhVzJ00CvdVzv1jcgmzMR2cK9gfzyzu0v0YM-MSfkHYgvAh5jQtvL55GY2ftzZDYna_q0sUaoD-4AuU2bLKGbj8g0OhM5kCR_9g_zP9-kHVLQjTHrttFjDeNhCMrpEAhyGkMsipC_9Gv2tcWwcpS_GzcsrjvfdXt3etpdzVF_28lewKsTIuomlSvu29mIGnUnn8l2H5ol_k9lg
Accept: application/vnd.documents.v1+json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Example Curl request
$ curl 'https://api.aerahost.com/documents/0e27b15f-2b13-4ab5-a2bd-d291582fa39d' -i -X DELETE \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMzViOWU3ODktNDg2Ni00NDUzLWIzMjgtMjQ5NzlmODJmMDYwIiwic2NvcGUiOlsiYWxsRG9jdW1lbnRzIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDQsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.t4B-WDnPBeiupeXsn4r456Efs_M-lDxMqVc3febvZnwrkquGZfyifB9dXT3LDgkHaMdyBEVRNqNNmuzhOnzfNDc2feigiYlLGPf9S9e-Ruu7Vw3N0zxWH1IqvdxHs14X7EGs0JepzhVzJ00CvdVzv1jcgmzMR2cK9gfzyzu0v0YM-MSfkHYgvAh5jQtvL55GY2ftzZDYna_q0sUaoD-4AuU2bLKGbj8g0OhM5kCR_9g_zP9-kHVLQjTHrttFjDeNhCMrpEAhyGkMsipC_9Gv2tcWwcpS_GzcsrjvfdXt3etpdzVF_28lewKsTIuomlSvu29mIGnUnn8l2H5ol_k9lg' \
    -H 'Accept: application/vnd.documents.v1+json'

11.2. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

11.2.1. Document

The Document to archive

Name Description Schema

consumerReference
optional

A consumer reference for the Document, e.g. the Social Security Number (SSN) for signed documents.
Length : 0 - 36

string

content
required

The content of the Document
Minimum length : 1

string

createdTime
required

The Offset Creation Time of the Document

string (date-time)

description
required

The description/title of the Document.
Length : 1 - 128

string

documentId
required

The Document ID, should be a UUID.
Length : 26 - 36

string

encoding
required

The encoding of the Document
Length : 1 - 36

string

externalReference
optional

An external reference for the Document, e.g. an orderId.
Length : 0 - 36

string

mimeType
required

The MIME Type of the Document

enum (text/plain, x-application/seid-sdo, application/jose, application/json)

pid
optional

The BankID Personal ID (PID) used as a reference to the Document.
Length : 0 - 61
Pattern : "^(UN:NO-)?([0-9]{4})-[0-9]{4,6}-[0-9]{1,2}-([0-9]{1,38})$"

string

version
required

The version of the Document
Length : 1 - 36

string

11.2.2. DocumentMetaData

Name Description Schema

createdTime
required

The Offset Creation Time of the Document

string (date-time)

description
required

The description/title of the Document.
Length : 1 - 128

string

documentId
optional

The Document ID. Used to retrieve/delete the document.

string

documentUrl
optional

The link to the document.

string

responseInfo
optional

ResponseInfo

11.2.3. DocumentRequest

Name Schema

document
required

Document

11.2.4. DocumentResponse

Name Schema

document
optional

Document

responseInfo
optional

ResponseInfo

11.2.5. DocumentsResponse

Name Description Schema

documents
optional

The documents found based on request.

< DocumentMetaData > array

responseInfo
optional

ResponseInfo

11.2.6. ResponseInfo

Info object that can provide specific messages

Name Description Schema

externalResponseCode
optional

Additional response code from external systems.

string

message
optional

Specific response message

string

responseCode
required

Minimum length : 1

string

timeStamp
required

Timestamp. Mandatory
Minimum length : 1
Example : "2021-12-21T10:23:19.279Z"

string

11.2.7. Status

Name Schema

description
optional

string

status
optional

string

12. Payment Services

Service paths and model definition for the Payment Services

12.1. What is Aera Payment Service

Aera Payment Service is an application that handles payment requests via APIs or using the Aera Payment Page.
This documentation focuses mainly on how to use the Aera Payment Page and some of the more important API endpoints.

12.2. Aera Payment Page

The Aera Payment Page is a payment page that can be rendered inside the merchant web application (iFrame) or in a mobile application (WebView).

12.2.1. Introduction

The Aera Payment Service provides an API endpoint for starting an Aera Payment Page session. This API endpoint returns a URL which points to an Aera Payment Page and a session. The client loads the payment page in their web application. This can be done in an iFrame or WebView, or in redirect mode. The different modes are described in a section below. The payment page will utilize other Aera services during the payment session, and will notify the merchant application frontend when the payment session is complete.

The following sections shows a high level view of how to integrate the Aera Payment Page and what to expect in the notifications.

High level sequence diagram

The following diagram shows the use of Aera Payment Page. After the sequence in the diagram is finished the authorization is created. The merchant will then be able to capture the reserved amount at a later stage. More detailed sequence diagrams follow in later sections.

Aera Payment Page - High level
Figure 19. Aera Payment Page - High level
Aera Payment Page notifications to the merchant frontend

The payment page reports back to the merchant frontend application when the payment session has completed. A notification will be sent for successful and unsuccessful payments. Depending on what was requested by the Merchant when starting the payment session, different notification types will be used by the Payment Window to notify the merchant frontend application.

Redirect mode

To activate the Redirect Mode the parameter StartSessionRequest.callbackUrl must be provided when initializing the payment session. The Merchant provides a URL in this field, to which the Payment Page will redirect the end user after the payment page has completed. The callbackUrl can be set up with parameters from the merchant (i.e. for session handling), which will be replied on the redirect.

IFrame mode

The IFrame mode is the default mode and will be activated when the field StartSessionRequest.callbackUrl is omitted from the request to start a payment session. When the Payment Page completes a PostMessage will be sent to notify the surrounding application.

When showing the Payment Page in an IFrame in the Merchant Application, some payment methods has proven to introduce 3. party cookies. To avoid this problem, do not display the Payment Page in an IFrame and use the Redirect mode.

Payment Page notification details

The following table describes the different outline and content of the Payment Page notifications and when to expect the different types. On the right hand side the differences between the PostMessage and the Redirect format are shown. The response examples are shown for combinations of different actions and payment results.

Action Payment result PostMessage Redirect
Parameters added to redirect URL

CARD_VERIFY Deprecated

OK

"ID_OUT_PROCEED_PAYMENT"

message=ID_OUT_PROCEED_PAYMENT

ERROR

"ID_OUT_CANCEL_PAYMENT"

message=ID_OUT_CANCEL_PAYMENT

CANCEL

"ID_OUT_CANCEL_PAYMENT"

message=ID_OUT_CANCEL_PAYMENT

CARD_AUTH

OK

{ message="ID_OUT_PROCEED_PAYMENT", type="<TYPE>", action="CARD_AUTH" }

message=ID_OUT_PROCEED_PAYMENT&type=<TYPE>&action=CARD_AUTH

ERROR

{ message: "ID_OUT_ERROR_PAYMENT", type: "<TYPE>", action: "CARD_AUTH", details: {"nativeBankResponseCode": "<relevant code>",
"aeraResponseCode": "<relevant code>" }}

message=ID_OUT_ERROR_PAYMENT&type=<TYPE>&action=CARD_AUTH
&details={"nativeBankResponseCode":"<relevant code>","aeraResponseCode":"<relevant code>"}

CANCEL

{ message="ID_OUT_CANCEL_PAYMENT", type="<TYPE>", action="CARD_AUTH" }

message=ID_OUT_CANCEL_PAYMENT&type=<TYPE>&action=CARD_AUTH

UNKNOWN
(Pending)

message="ID_OUT_UNKNOWN_PAYMENT", type="<TYPE>", action="CARD_AUTH" }

message=ID_OUT_UNKNOWN_PAYMENT&type=<TYPE>&action=CARD_AUTH

N/A

Error on init

"ID_OUT_CANCEL_PAYMENT"

message=ID_OUT_ERROR_PAYMENT

The type returned by the post message object or redirect URL parameter reflects the payment method selected by the end user. For card payment the value will be "CARD".

The unknown state will be returned when the outcome of the payment is not determined during the payment session. An example is an invoice that is pending a credit check.

If the payment fails before reaching the acquirer or Bank, the native bank response code URL parameter will be omitted.

If the payment window for any reason experience an error on initialisation, the post message will be a string even if the action normally would give an object. This is because of being backward compatible. The payment window does not yet know the action, and returns the legacy string.

12.2.2. Starting a payment session

The merchant will start a payment session with Aera by calling the startSession endpoint.

The start session request contains information about the payment, like the merchantId, amount, what action to perform, etc. The details can be found in https://api-docs.aerahost.com/index.html#_payment-startsession.

Certain payment methods and payment functionality require specific parameters in the start session request to be enabled. This will be described in the sections below.

The start session takes a parameter appActionType. This parameter tells the payment window which action to perform during payment. We recommend that this value is set to CARD_AUTH, meaning that the payment window will perform the authorisation. Note that this needs to be set explicitly, as the CARD_VERIFY action is default for backward compatibility reasons.

Card payment

The parameters required to start a payment session supporting card payment, are the ones in the list below.

Parameters card payment

  • merchantId

  • externalTransactionId

  • orderNumber

  • currency

  • grossAmount

  • netAmount

  • taxAmount

  • country

  • appActionType

The recommended value for appActionType is CARD_AUTH.

Card payment with Card on File

If the card on file functionality is desired, where the end user is given the option to store the card for later payments, the following parameters are also required. The merchant must also be enabled for the Card on File product in the Aera configuration portal.

Parameters enabling Card on File

  • identifierType

  • identifierValue

The two parameters are identifying an end user in the Aera payment service. If the end user chooses to store a card during the payment session, the stored card will be shown in later payments by providing the same identifier type and value in the next payment initialisation.

12.2.3. Render the payment window

The start session response contains two values. These are described in the table below.

Parameter Description

appUrl

A URL to the payment window connected to the payment session

paymentReference

A reference to the payment to be used by the merchant in subsequent payment actions (e.g. Capture)

The appUrl must be rendered in the merchant web application in an iFrame or a WebView. When the payment window completes, a postMessage is returned as described in the introduction above.

12.2.4. Explicitly get transaction data

Aera payment service provides a method for retrieving the transaction details. The details can be found at https://api-docs.aerahost.com/index.html#_payment-statuspayment.

The response will contain a list of events for the payment. After the payment window is complete, the status response will contain information about the outcome of the authorisation.

12.2.5. Sequence diagrams

This section shows the messages involved in a payment window session. It is based on the high level sequence diagram from the introduction, but contains more detail for each step.

Card payment authorisation

The following sequence diagram shows how to make an authorisation in a payment window session. Note that the sequence diagram does not cover all the parameters in each API method, please refer to the API documentation for the details. The parameters show are directly related to the payment method.

Aera Payment Page - Authorisation
Figure 20. Aera Payment Page - Authorisation

The option of explicitly retrieve transaction information is shown in the alternative box at the bottom of the sequence diagram.

The sequence diagram for the authorisation shown above, form a basis of what is needed for performing a payment window session.

Card payment with Card on File

The Card on File functionality enables the end user to store the card for later payments. This will only require the end user to type CVC value in subsequent payments, if the stored card is chosen.

The sequence diagram for Card on File is similar to the card payment example above. The specific parameters required are shown in bold in each method. For the merchant the only difference is content of the start session request.

Aera Payment Page - Card on File
Figure 21. Aera Payment Page - Card on File

12.2.6. Cancel the authorisation

If the merchant wants to cancel the reservation, the Cancel endpoint should be used providing either the paymentReference from the start session response, or the transactionReference returned as part of the get transaction status response.

The API details can be seen at https://api-docs.aerahost.com/index.html#_payment-cancelpayment.

Cancel authorisation
Figure 22. Cancel authorisation

12.2.7. Capture the authorisation

When the merchant is ready to ship the goods, the Capture is used to capture the reserved amount. The merchant can choose to capture the money based on the paymentReference from the start session response, or the transaction reference returned by the get transaction status method. The former might be the easiest.

The capture response contains a transactionId to be used as a transactionReference if the capture needs to be refunded at some point.

The Aera payment service supports partial captures, but the rules are also set by the card scheme and merchant category code.

The API details can be seen at https://api-docs.aerahost.com/index.html#_payment-capturepayment.

Capture authorisation
Figure 23. Capture authorisation

12.2.8. Refund (part of) the payment

When there is a need to refund part of the payment or the payment as a whole, the Refund endpoint should be used. A transactionId from the capture response must be provided as a transactionReference.

There is an accounting keeping track of how much of a particular capture that is refunded. Assume the authorisation is NOK 1000, and the capture is divided into two partial captures of NOK 500 each. It is not possible to refund more than the capture amount. If the merchant wants to refund NOK 600, the refund must be divided against both the capture references.

The API details can be seen at https://api-docs.aerahost.com/index.html#_payment-refundpayment.

Refund payment
Figure 24. Refund payment

12.3. Unknown transaction state

A client that sends a transaction request must take further actions when the transaction is in an unknown state. A transaction is in an unknown state in these situations

  • The client times out during the transaction request towards APS.

  • APS responds with any of these ResponseCodes: 50000,50100,50200,50300,50400,50420.

  • APS responds with HTTP 5XX error code

  • APS responds with the ResponseCode 40007 (Transaction is currently processing)

The possible actions for the client is:

  • Replay the original request (idempotency) until a known state is reached

  • Send a new transaction request that repeals the original transaction request.

12.4. API endpoints

This section covers some API endpoints in more detail, that is not covered in the Aera payment page section above.

12.4.1. Add card outside a payment session

Related to the Card on File functionality explained above, it is also possible to add a card to the wallet outside a payment session. This is useful for merchants that wants to support an end user to add a card from inside a mobile APP.

The same identifierType and identifierValue as for a card payment session must be provided, to identify the end users wallet.

To add a card this way, an add card session must be started. The response provides a URL that must be rendered in the merchant environment in either an iFrame or a WebView. The end user will then be presented a user interface for adding the card details. Depending on the outcome, the iFrame or WebView sends one of the following postMessages to the surrounding web document.

Result PostMessage content

A card is added to the wallet

ID_OUT_CARD_DONE

The adding card process is cancelled

ID_OUT_CARD_CANCEL

The API details can be seen here https://api-docs.aerahost.com/index.html#_payment-startaddcardsession.

12.4.2. Search wallet content

To get the content of a wallet, provide identifierType and identifierValue to the endpoint "Search for Wallet Payment Instruments by an Identifier". The response contains a list of all payment instrument for the identifier.

The API details can be seen here https://api-docs.aerahost.com/index.html#_payment-findpaymentinstruments.

12.4.3. Delete a payment instrument from wallet

To delete a card from the wallet outside a payment session, provide consumerId and identifierId to the endpoint "Deletes an Identifier (Payment Instrument), regardsless if default payment instrument, by its ConsumerId and IdentifierId". The consumerId and instrumentId can be found by first listing the wallet content.

The API details can be seen here https://api-docs.aerahost.com/index.html#_payment-deleteidentifier.

12.4.4. Perform merchant initiated Sale

After retrieving the wallet content, the merchant can perform MIT Sale based on one of the stored cards. When using this endpoint, the liability shifts from the issuing Bank to the Merchant.

The parameters listed below are required for sending a merchant initiated sale request:

  • identifierType of the end user - ex. ADDIIONAL_ID

  • identifierValue of the end user - ex. <non PII end user id>

  • paymentInstrumentIdentifierId - unique ID for the selected payment instrument

The Customer Verification Data (a signature from Aera Secure ID) element is not yet supported for customer identification in this endpoint. That might change in a future release.

The API details can be seen here https://api-docs.aerahost.com/index.html#_payment-salemitpayment.

MIT Sale
Figure 25. MIT Sale

12.4.5. Authorize with Low Value Transaction exemption

When referencing an existing card from a wallet or using the default payment instrument, it is possible to try an authorization using LVT exemption. When using the default payment instrument it is required that the default payment instrument is a payment card.

One of the two parameters in the list must be provided, not both.

  • paymentInstrumentIdentifierId - reference to the card in wallet

  • useDefaultPaymentInstrument - instruct to use the default payment instrument

In addition, the SCAExemption must also be provided.

The PaymentExemptionResponse can vary depending on the result of the exemption attempt. If the exemption is accepted or the transaction fails for another reason than Soft Decline, the response will contain a PaymentExemptionResult. On a successful response, the authorization is made without any user interaction (no payment window, not 3DS challenge, etc.).

If the exemption attempt results in a Soft Decline, the system executes a startSession behind the scenes. The response will reflect this and contain an APPUrl and a paymentReference. The merchant will then have to initiate the payment window as if a regular startSesison is requested.

The API details can be seen here https://api-docs.aerahost.com/development/index.html#_payment-authorizepaymentexemption

12.5. Paths

Descriptions of resources/paths in the service.

12.5.1. Authorize transaction - used to perform an authorization.

POST /payments/authorize
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : PaymentRequest

Responses
HTTP Code Description Schema

200

OK

PaymentResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/authorize HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 755
Host: api.aerahost.com

{
  "merchantId" : "AERA",
  "externalTransactionId" : "12345LJDF345",
  "orderNumber" : "20180404",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1100,
  "taxAmount" : 100,
  "originatingSystem" : "MobileApp",
  "country" : "NO",
  "comment" : null,
  "customerVerificationData" : {
    "cryptogram" : "TEtKU0Y4NzIzNDVKS0xEUzg3NjQyM2prbGIrZHNha0pGR0pIZnNhZG84NzRyYWpza21uSkhGRGxranNhZGZrS0xKaDc3NjVGR0RIR1NudnNoZ2ZkWVRubWZKSGY=",
    "nonce" : "OTg3NjU0MzIxMg==",
    "signedData" : "eyJtZXJjaGFudElkIjoiQUVSQSIsIm1lcmNoYW50TmFtZSI6IkFlcmEiLCJjdXJyZW5jeSI6Ik5PSyIsImdyb3NzQW1vdW50IjoxMTAwfQ=="
  },
  "delayedCharge" : false,
  "authorizedMerchants" : [ "MID03493", "MID04333" ],
  "merchantInitiated" : false,
  "authType" : "PRE_AUTH"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: SUl3XlB88TnknXYdJyeAUctAhGErEVY0oYV8C3V0lOrYK+PeoGhETvTWGYdaYmFQ9Q0MXVkyWptbBrQg21hHQS0EK/g8M0EV+IdduLLA37oRMa/ecBHPI7jpgVKbmHz8GNfYsPjpu8MK3XRkECDk1CRwKctr4Uk9lbg2tEcBsWcvk9LYs+Xog8d/z9lIG22nwkrzYxYTZ1TSF5Nr/AJHYAry72pDqu2ncf7Fh7immxLOvIbzm1ciRSWWUhas2ltVWPlKzZBRKEgxIgB9w+dAeVnuWnI4/k1ThwyTnono5eK0UmwjLkVJU2gmY169vQZkj8jc1+8Er4Y5CsWfD/RZDQ==
Content-Length: 445

{
  "responseInfo" : {
    "message" : "Service succeeded",
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T15:04:37.019Z"
  },
  "result" : {
    "transactionId" : "WVBZKVRM5WTC1",
    "externalTransactionId" : "12345LJDF345",
    "paymentMethod" : "Visa",
    "processor" : "EXBANK",
    "maskedVPAN" : "****5005",
    "expirationDate" : "1121",
    "authorizationCode" : "213462",
    "merchantId" : "AERA",
    "cardType" : "C"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/authorize' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "AERA",
  "externalTransactionId" : "12345LJDF345",
  "orderNumber" : "20180404",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1100,
  "taxAmount" : 100,
  "originatingSystem" : "MobileApp",
  "country" : "NO",
  "comment" : null,
  "customerVerificationData" : {
    "cryptogram" : "TEtKU0Y4NzIzNDVKS0xEUzg3NjQyM2prbGIrZHNha0pGR0pIZnNhZG84NzRyYWpza21uSkhGRGxranNhZGZrS0xKaDc3NjVGR0RIR1NudnNoZ2ZkWVRubWZKSGY=",
    "nonce" : "OTg3NjU0MzIxMg==",
    "signedData" : "eyJtZXJjaGFudElkIjoiQUVSQSIsIm1lcmNoYW50TmFtZSI6IkFlcmEiLCJjdXJyZW5jeSI6Ik5PSyIsImdyb3NzQW1vdW50IjoxMTAwfQ=="
  },
  "delayedCharge" : false,
  "authorizedMerchants" : [ "MID03493", "MID04333" ],
  "merchantInitiated" : false,
  "authType" : "PRE_AUTH"
}'

12.5.2. ApplePay authorize transaction - used to perform an authorization after an ApplePay in app or ApplePay on web transaction

POST /payments/authorize/applepay
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : ApplePayRequest

Responses
HTTP Code Description Schema

200

OK

PaymentResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/authorize/applepay HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 1884
Host: api.aerahost.com

{
  "merchantId" : "AERA",
  "externalTransactionId" : "aaba4d4a-f34a-4e5f-91e5-ef005c8917ac",
  "orderNumber" : "122343234",
  "currency" : "NOK",
  "amount" : 1000,
  "paymentData" : {
    "data" : "f3/fcnNsSweH8j0WEFWEFWRGRWEGWRGWRGFvdkcqMpmUKVibrTEyXQU3YojRrKzf90mDdpvSkyc7APYxfwX6evc8BfA8IqdN38NAUdq6+0JhE43/Uze9ciUPSE4H4KFy6utS8o+xuzhQlD6Fw4zxJ/FFLIsxZEV9kQGnBdsyQ2/nab3iuhJOAXoVkcvmjqHDdMlGNfspCOAhb7cmNgURu1WJZqreolmpiyzSsgtQ9GHPcllDf+j4C8WRPbStYowV90ZyIxDbS2L/zlH/iHvY+jrMGusjgYPY/R4Or3If6T4VBfIWY08VCiD8Z45lgV29BNXhLBqNuVoynYMW+miW5QA7hAfuayADGncqA0/1rcc+VqEzN0B3U",
    "signature" : "MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIID5jCCA4ugAwIBAgIIaGD2mdnMpw8wCgYIKoZIzj0EAwIwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE2MDYwMzE4MTY0MFoXDTIxMDYwMjE4MTY0MFowYjEoMCYGA1UEAwwfZWNjLXNtcC1icm9rZXItc2lnbl9VQzQtU0FOREJPWDEUMBIGA1UECwwLaU9TIFN5c3RlbXMxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEgjD9q8Oc914gLFDZm0US5jfiqQHdbLPgsc1LUmeY+M9OvegaJajCHkwz3c6OKpbC9q+hkwNFxOh6RCbOlRsSlaOCAhEwggINMEUGCCsGAQUFBwEBBDkwNzA1BggrBgEFBQcwAYYpaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZWFpY2EzMDIwHQYDVR0OBBYEFAIkMAua7u1GMZekplopnkJxghxFMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUI/JJxE+T5O8n5sT2KGw/orv9LkswggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgefjfeehuefnefefniefJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZm",
    "version" : "EC_v1",
    "ephemeralPublicKey" : "MFkwEFE0FEJ3EF9HF3KSDFMOPSDFOPFSDuvUXGQfzqtQm5qDK1WFWEFWEWEFs85E5BQosHNqUxA==",
    "publicKeyHash" : "EERCobQBvtM9EJ3FMPF3J9kuBIz5f0H2C/pU=",
    "transactionId" : "331f4c6689530384845923234ad068b1eb0afdb56da9dae5"
  }
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: iXujjSy1klm3lTQBScVGolPxXFXp88sWnlXKE/KpqWtis0s9oWtNT64eEeN3b++eDVCN/9nY7AV20QzACVUWM+RtSr+JVgG40ZHCDeQDVfEBgKOcwiSk1G4ypjPwxMI360ClvvEwrc5tDICjzteX3Kj4W6hfsyBQI27fa/xgTKbpSZHtc1HPJoFF8f8GWaiXSBjCFn/c/eJ5fn72p5zXnG8fv/YWCKwc8rdAekTMX4diGSMDZopbSn+/ulDnM2KGFuREGvTu9wSBTslntSFas2Tk1aXNrloz3q0LhsRZVCL/QgfJTD1PIaN8/uwRW+6jJfGRlXF7tPzFQdtKYceJDA==
Content-Length: 505

{
  "responseInfo" : {
    "message" : "Service succeeded",
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T15:04:36.873Z"
  },
  "result" : {
    "transactionId" : "WVBZKVRM5WTC1",
    "externalTransactionId" : "aaba4d4a-f34a-4e5f-91e5-ef005c8917ac",
    "paymentMethod" : "Visa",
    "processor" : "EXBANK",
    "maskedVPAN" : "****5005",
    "expirationDate" : "1121",
    "authorizationCode" : "213462",
    "merchantId" : "AERA",
    "cardType" : "C",
    "paymentInstrumentType" : "03"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/authorize/applepay' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "AERA",
  "externalTransactionId" : "aaba4d4a-f34a-4e5f-91e5-ef005c8917ac",
  "orderNumber" : "122343234",
  "currency" : "NOK",
  "amount" : 1000,
  "paymentData" : {
    "data" : "f3/fcnNsSweH8j0WEFWEFWRGRWEGWRGWRGFvdkcqMpmUKVibrTEyXQU3YojRrKzf90mDdpvSkyc7APYxfwX6evc8BfA8IqdN38NAUdq6+0JhE43/Uze9ciUPSE4H4KFy6utS8o+xuzhQlD6Fw4zxJ/FFLIsxZEV9kQGnBdsyQ2/nab3iuhJOAXoVkcvmjqHDdMlGNfspCOAhb7cmNgURu1WJZqreolmpiyzSsgtQ9GHPcllDf+j4C8WRPbStYowV90ZyIxDbS2L/zlH/iHvY+jrMGusjgYPY/R4Or3If6T4VBfIWY08VCiD8Z45lgV29BNXhLBqNuVoynYMW+miW5QA7hAfuayADGncqA0/1rcc+VqEzN0B3U",
    "signature" : "MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIID5jCCA4ugAwIBAgIIaGD2mdnMpw8wCgYIKoZIzj0EAwIwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE2MDYwMzE4MTY0MFoXDTIxMDYwMjE4MTY0MFowYjEoMCYGA1UEAwwfZWNjLXNtcC1icm9rZXItc2lnbl9VQzQtU0FOREJPWDEUMBIGA1UECwwLaU9TIFN5c3RlbXMxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEgjD9q8Oc914gLFDZm0US5jfiqQHdbLPgsc1LUmeY+M9OvegaJajCHkwz3c6OKpbC9q+hkwNFxOh6RCbOlRsSlaOCAhEwggINMEUGCCsGAQUFBwEBBDkwNzA1BggrBgEFBQcwAYYpaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZWFpY2EzMDIwHQYDVR0OBBYEFAIkMAua7u1GMZekplopnkJxghxFMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUI/JJxE+T5O8n5sT2KGw/orv9LkswggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgefjfeehuefnefefniefJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZm",
    "version" : "EC_v1",
    "ephemeralPublicKey" : "MFkwEFE0FEJ3EF9HF3KSDFMOPSDFOPFSDuvUXGQfzqtQm5qDK1WFWEFWEWEFs85E5BQosHNqUxA==",
    "publicKeyHash" : "EERCobQBvtM9EJ3FMPF3J9kuBIz5f0H2C/pU=",
    "transactionId" : "331f4c6689530384845923234ad068b1eb0afdb56da9dae5"
  }
}'

12.5.3. Authorize transaction with PSD2 exemption - fallback to payment window transaction.

POST /payments/authorize/exemption
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : PaymentExemptionRequest

Responses
HTTP Code Description Schema

200

OK

PaymentExemptionResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/authorize/exemption HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 670
Host: api.aerahost.com

{
  "merchantId" : "AERA",
  "externalTransactionId" : "12345LJDF345",
  "orderNumber" : "20180404",
  "grossAmount" : 1100,
  "netAmount" : 1000,
  "taxAmount" : 100,
  "currency" : "NOK",
  "originatingSystem" : null,
  "country" : "NO",
  "identifierType" : "ADDITIONAL_ID",
  "identifierValue" : "43543lkn5564k46k",
  "paymentInstrumentIdentifierId" : "22ba6ae7b5c1444aed5b66cbec302b689c237ec7",
  "useDefaultPaymentInstrument" : false,
  "scaExemption" : {
    "exemptionType" : "LOW_VALUE_TRANSACTION"
  },
  "authorizedMerchants" : [ "MID03493", "MID04333" ],
  "language" : "no",
  "requireCvc" : true,
  "onlyCardFromWallet" : false,
  "authType" : "PRE_AUTH"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: ogstrGqA+3k+66XyxWUzXxRgyc8ree2FDLyqz7R0u6SvoNEHJzAt9ML9sZhkIb1DRb0ag4D4tEOUhfTwXxHkrtuANrKBfBpas9IyxuMpFNp0O5/qbh0JfYJHmEUCpB6Tuj0gEtTespaahfl0/uL86mcrT8fw7nWS5Xn52ZTSIGhtSisxHp0l85PDouxipHS7ib4DqVpXhiS1sZ9/YPi3ihFN3P1SrDygnfRYMNPfZpIotAIfe25Iv8ycqMcB5XG0zeYBCG+6NWTq/GTV8Ki4pNVQ6sfYL1mI0E71zMAeGkfhDrbwkOHyoY9t0Quxah/6d3FSNwcGVKgBLhNNo4RjUA==
Content-Length: 445

{
  "responseInfo" : {
    "message" : "Service succeeded",
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T15:04:36.310Z"
  },
  "result" : {
    "transactionId" : "WVBZKVRM5WTC1",
    "externalTransactionId" : "12345LJDF345",
    "paymentMethod" : "Visa",
    "processor" : "EXBANK",
    "maskedVPAN" : "****5005",
    "expirationDate" : "1121",
    "authorizationCode" : "213462",
    "merchantId" : "AERA",
    "cardType" : "C"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/authorize/exemption' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "AERA",
  "externalTransactionId" : "12345LJDF345",
  "orderNumber" : "20180404",
  "grossAmount" : 1100,
  "netAmount" : 1000,
  "taxAmount" : 100,
  "currency" : "NOK",
  "originatingSystem" : null,
  "country" : "NO",
  "identifierType" : "ADDITIONAL_ID",
  "identifierValue" : "43543lkn5564k46k",
  "paymentInstrumentIdentifierId" : "22ba6ae7b5c1444aed5b66cbec302b689c237ec7",
  "useDefaultPaymentInstrument" : false,
  "scaExemption" : {
    "exemptionType" : "LOW_VALUE_TRANSACTION"
  },
  "authorizedMerchants" : [ "MID03493", "MID04333" ],
  "language" : "no",
  "requireCvc" : true,
  "onlyCardFromWallet" : false,
  "authType" : "PRE_AUTH"
}'

12.5.4. Incremental Authorize transaction - Only valid for NGCORP scheme with EVRY.

POST /payments/authorize/increment
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : PaymentRequestIncrementalAuth

Responses
HTTP Code Description Schema

200

OK

PaymentResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

12.5.5. Wallet authorize transaction - used to perform an authorize after communicating with the customer’s wallet

POST /payments/authorize/wallet
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : WalletPaymentRequest

Responses
HTTP Code Description Schema

200

OK

PaymentResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/authorize/wallet HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 465
Host: api.aerahost.com

{
  "merchantId" : "AERA",
  "externalTransactionId" : "12345LJDF345",
  "orderNumber" : "20180404",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1100,
  "taxAmount" : 100,
  "originatingSystem" : "MobileApp",
  "country" : "NO",
  "comment" : null,
  "identifierValue" : "2345223",
  "identifierType" : "ADDITIONAL_ID",
  "delayedCharge" : false,
  "merchantInitiated" : false,
  "async" : true,
  "callbackUrl" : null,
  "authType" : "PRE_AUTH"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: gvR0Q3FsenZh1eHpxVTwULXiNBxy2yYjleYk/786Pu4m89OEMTnhlG0tBjUnSc+XD0+F0kp5eSbiyo+6reXTlfsUONvtlGqoK20K85Fn4ObduSn96x5yhPkqPqtUTlU/rnyZgvyHVe3oN7/k5c5UELoNAa4c6Xcyw+W8GmCyrbH/lQzrEUg02Mmx7np9KIe/kAS7TI3dtGtNdsMrG4ua/58N5FyK/0NptRuTjyfvkXpRhioKSxBQ5o5Ti1jfYpuVOi0zvk9hH+os0FmuP8GMYTB0bHddI2JzT0zl9oLu5HToKG0ShPLJW6seqRqlvXUqsndmqJq5kznqnbhW+90uBg==
Content-Length: 84

{
  "result" : null,
  "paymentReference" : "f5b500d0-f02a-4420-bbd5-fc1998b6859b"
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/authorize/wallet' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "AERA",
  "externalTransactionId" : "12345LJDF345",
  "orderNumber" : "20180404",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1100,
  "taxAmount" : 100,
  "originatingSystem" : "MobileApp",
  "country" : "NO",
  "comment" : null,
  "identifierValue" : "2345223",
  "identifierType" : "ADDITIONAL_ID",
  "delayedCharge" : false,
  "merchantInitiated" : false,
  "async" : true,
  "callbackUrl" : null,
  "authType" : "PRE_AUTH"
}'

12.5.6. Auth transaction (A.P.P) - used to perform an auth from Merchant without CVD.

POST /payments/authorizeApp
Parameters
Type Name Description Schema

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : PaymentRequestApp

Responses
HTTP Code Description Schema

200

OK

PaymentResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/authorizeApp HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 195
Host: api.aerahost.com

{
  "paymentReference" : "SID",
  "externalTransactionId" : "ext-trx-id",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1250,
  "taxAmount" : 250,
  "authorizedMerchants" : null
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: io9wXie5oA2T8VWOEdlFwpPDEVl1RQBUAgXVKj76FIW+OPyPSsLJkHbHUE6b45P2/xz5dQaVc35G4cWr0wQ4VGjsrjaNaKUA9wYJhHr4IIlODdJlPyN4+qthqsVNfXz16K3/PC7zEwmkiCcoE8uMvmgVfShWJI5JEnd5b0uZl9KY0G55Fx14RANwG5syirFZtn2LIQXW3YNyjpq37fCfaUlFT9glf7P5Sg9VzPUn8fY7QaEgBM3ICHAt81yLMoxCjzQaTJeZZlu1N4RlJucLuX1jhQ7z8oNpmLl6NZf/9LQyWUyT8uqicc/Hf1Pbw4B/gjebYL64nOT8NVd4IlRLjQ==
Content-Length: 455

{
  "responseInfo" : {
    "message" : "Service succeeded",
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T15:04:36.779Z"
  },
  "result" : {
    "transactionId" : "WVBZKVRM5WTC1",
    "externalTransactionId" : "ext-trx-id",
    "paymentMethod" : "Visa",
    "processor" : "EXBANK",
    "maskedVPAN" : "****5005",
    "expirationDate" : "1121",
    "authorizationCode" : "213462",
    "merchantId" : "mid_from_session",
    "cardType" : "C"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/authorizeApp' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "paymentReference" : "SID",
  "externalTransactionId" : "ext-trx-id",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1250,
  "taxAmount" : 250,
  "authorizedMerchants" : null
}'

12.5.7. BankAxept settlement request.

POST /payments/bankaxept/settlement/cutoff
Body parameter

Name : body
Flags : required
Type : SettlementRequest

Responses
HTTP Code Description Schema

200

OK

No Content
Consumes

  • application/json

Tags

  • Payments

12.5.8. BankAxept settlement details request.

POST /payments/bankaxept/settlement/details
Body parameter

Name : body
Flags : required
Type : SettlementDetailsRequest

Responses
HTTP Code Description Schema

200

OK

SettlementDetailsResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Payments

12.5.9. Cancel authorization - used to cancel an authorization

POST /payments/cancel
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CancelRequest

Responses
HTTP Code Description Schema

200

OK

CancelResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/cancel HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 340
Host: api.aerahost.com

{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : "20180404",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1100,
  "taxAmount" : 100,
  "originatingSystem" : "MobileApp",
  "country" : "NO",
  "comment" : null,
  "transactionReference" : "WVBZKVRM5WTC1"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: Pv79mC39U0f3tkJ9d0i2pGul2wG0QwIKfBFzDetgu+obGfdMu4KtUVRxu6qXC0WLQc95P8ODD4By/8IncJZPMJVuW3KSvr9kP9GwQQGON/ydJ1HrEGUNoaEsAR/tdFVx8MTluxKw9KhbUyGnm42yE0KgwMMipLLmGSby2ADsFpRLm0WT4GXBNQ2M2O0TlzTY7S44hHamIknXDs2ZlLeBzlCjtXzETkVCgPJlyK8gLb8xhXwhXfMcypn4mQrkWLj4lYjo1Eak6ofVfVY6U5TvqSsznMUQ1mCyUKOaqAWek7ARd0QDaTs8U4hxx5s7cbI13IPaKX4eXrknYgRQhfmwUQ==
Content-Length: 296

{
  "responseInfo" : {
    "message" : "Service succeeded",
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T15:04:32.978Z"
  },
  "result" : {
    "transactionId" : "HLSIDKSI6WLS6",
    "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
    "merchantId" : "M12323223"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/cancel' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : "20180404",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1100,
  "taxAmount" : 100,
  "originatingSystem" : "MobileApp",
  "country" : "NO",
  "comment" : null,
  "transactionReference" : "WVBZKVRM5WTC1"
}'

12.5.10. Capture transaction - used to perform a capture.

POST /payments/capture
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CaptureRequest

Responses
HTTP Code Description Schema

200

OK

CaptureResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/capture HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 376
Host: api.aerahost.com

{
  "merchantId" : "AERA",
  "externalTransactionId" : "29462LKS8764GHF",
  "orderNumber" : "20180404",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1100,
  "taxAmount" : 100,
  "originatingSystem" : "MobileApp",
  "country" : "NO",
  "comment" : null,
  "transactionReference" : "WVBZKVRM5WTC1",
  "cancelResidualAmount" : false,
  "delayedCapture" : false
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: cOihemA3tnoC0dMkh4vNJTkqPJZh/hIvS0SuR0Sg0C88s/gjM9zkWvRk0W6ieXz4uPQn2QImA4591T3QRjFQACO9vhChZsLalMCznLOqyBDcqq1X8paws96EIAoR9acq8c/bMR79UJepOY0GO11qNQGVxkbOFBg3nskBMZ6V2rPlRRhvt60ZkZ8qn79ldiBwQOWBDPrA10L3jLNvVHnCTsVpArE/AE2acJ7JKiBgTDGD1cHRFesEmyx0GOTjTl6HvQhvrH6yYBZbv43yfYjYvCnyM0O9Bg8oUF2IsF+QyX36l4Blehea1pfPROG8PXJoar2aWpCRx2HS+wRo0I/Obw==
Content-Length: 270

{
  "responseInfo" : {
    "message" : "Service succeeded",
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T15:04:36.644Z"
  },
  "result" : {
    "transactionId" : "HLSIDKSI6WLS6",
    "externalTransactionId" : "29462LKS8764GHF",
    "merchantId" : "AERA"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/capture' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "AERA",
  "externalTransactionId" : "29462LKS8764GHF",
  "orderNumber" : "20180404",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1100,
  "taxAmount" : 100,
  "originatingSystem" : "MobileApp",
  "country" : "NO",
  "comment" : null,
  "transactionReference" : "WVBZKVRM5WTC1",
  "cancelResidualAmount" : false,
  "delayedCapture" : false
}'

12.5.11. Collect transaction - used to perform a collect as a last resort when the authorization has expired.

POST /payments/collect
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CollectRequest

Responses
HTTP Code Description Schema

200

OK

CollectResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/collect HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 376
Host: api.aerahost.com

{
  "merchantId" : "AERA",
  "externalTransactionId" : "29462LKS8764GHF",
  "orderNumber" : "20180404",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1100,
  "taxAmount" : 100,
  "originatingSystem" : "MobileApp",
  "country" : "NO",
  "comment" : null,
  "transactionReference" : "WVBZKVRM5WTC1",
  "cancelResidualAmount" : false,
  "delayedCapture" : false
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: ixV1+CRz2ev0g+yXqJQb33rZciBx4l0AYtAJOUSsEtONvcFFNXqfjTNHfJxXYnonetRAMigyzmR5CDVt1POVpnpmok+kELJnqMpUequFjHN2H1QP2WWu+3eOVBs+D1Y7prbzUhMyPQxiICPh99BPPsW0aE+h0xETnauuC0KEu97FfIOByYjcvUg2HcPo915/KkYrq4Uw8rHE73Exgdz7TCNno/uyVn8H/GPA7pwlE8CYmHL/CfrEiDCyKGDIAUYYtFAckN6CHhjHRFqDaxhwvJhm0K0AfeB+aqhnf8jRtIVPN8rXHJ9E2CVTq3ifskz9AwRBfr5UVLuhx3b0WDxnFA==
Content-Length: 270

{
  "responseInfo" : {
    "message" : "Service succeeded",
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T15:04:36.816Z"
  },
  "result" : {
    "transactionId" : "HLSIDKSI6WLS6",
    "externalTransactionId" : "29462LKS8764GHF",
    "merchantId" : "AERA"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/collect' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "AERA",
  "externalTransactionId" : "29462LKS8764GHF",
  "orderNumber" : "20180404",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1100,
  "taxAmount" : 100,
  "originatingSystem" : "MobileApp",
  "country" : "NO",
  "comment" : null,
  "transactionReference" : "WVBZKVRM5WTC1",
  "cancelResidualAmount" : false,
  "delayedCapture" : false
}'

12.5.12. Payment method enquiry - used to find available payment methods for the given merchant.

POST /payments/enquiry/paymentMethods
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : PaymentMethodsEnquiryRequest

Responses
HTTP Code Description Schema

200

OK

PaymentMethodsEnquiryResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/enquiry/paymentMethods HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 128
Host: api.aerahost.com

{
  "merchantId" : "D000213",
  "identifier" : {
    "identifierType" : "ADDITIONAL_ID",
    "identifierValue" : "1234567"
  }
}
Example HTTP response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: VSup1aQsmxnI/vPUYLmkf5VtcZHaxyiY6Qw04gVoo1ZFN8u78t7pv21rXgRZwxyIWHw10RrDH0HhHkZE6tM3uJIiXvgUWvYBdyo0gooBDU/JkfCt38DbsV01MJf7C1ltR+KmMV4Nlpx4o/kA5bBsAGNLj/l2UksINKfRRdqfrFmaSZjWACiOv3p+W9q5Uuh9zV9KJxLEoVABF/LPcmGXW6zJYXm1i/TnZef5tuhz/kkklW+9PPCzUJruqMoutHzM0uLS5z2bvVjtRPyJ60CIc+r82Sxa0mxnn9vnTg8/jgF4MF0zgXuxAtphoqntaMg2Aznmxou39LazdPQbm2d2vA==
Example Curl request
$ curl 'https://api.aerahost.com/payments/enquiry/paymentMethods' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "D000213",
  "identifier" : {
    "identifierType" : "ADDITIONAL_ID",
    "identifierValue" : "1234567"
  }
}'

12.5.13. Search for Wallet Payment Instruments by an Identifier

POST /payments/find-payment-instruments
Parameters
Type Name Description Schema Default

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Query

includeExpired
optional

Set to 'true' to also include expired payment instruments in response

boolean

"false"
Body parameter

Name : body
Flags : required
Type : PaymentInstrumentRequest

Responses
HTTP Code Description Schema

200

OK

PaymentInstrumentResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/find-payment-instruments?includeExpired=true HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
Accept: application/vnd.payments.v1+json
Content-Length: 95
Host: api.aerahost.com

{
  "identifier" : {
    "identifierValue" : "AERA0001",
    "identifierType" : "LOYALTY"
  }
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: jeE0HEMKWan0zkyEYvPpneL3P/6JQjq4EXoKQSDnGOgEOwP5X3YAPHMtdQonqmLZpe3rIsBRRjxPAq4eF4VJ8JD85ayvSPJCBRP+m1OdmOr8oKkSbvEw4f5O2sKMOCXOTnPSQFjLGvh6uUcxFYOFzVt9B3lOf6MZAGQ37TiQ0Jp9XnLGAVeYwexQDlWlD8hVG7hzSKJkqCNj5P7IYcGjf6YHaQc9GAEqoTxzy6sJZBnRTVonQVf23FoLvqMO6j6FzyEz5bPP10RuPkaHKig1Jr0ypYP7OSU6htHsuRkA/mL5nbd1Xk6a8LRUKBk2pttIiTRN5XuIFUR4c/fhbyyZyw==
Content-Length: 697

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T15:04:36.544Z"
  },
  "consumerId" : "0e27b15f-2b13-4ab5-a2bd-d291582fa39d",
  "paymentInstruments" : [ {
    "identifierId" : "f7cc8cda9bef7ce8e09d3c69a9e06f7920948d8d",
    "identifierType" : "PAY_CARD",
    "identifierValue" : "************6543",
    "priority" : 2,
    "expirationdate" : "2024-12-31",
    "cardScheme" : "VISA",
    "defaultPaymentInstrument" : false
  }, {
    "identifierId" : "42e112bda4f155704ba1b56bf35df348d220f228",
    "identifierType" : "PAY_ACCOUNT",
    "identifierValue" : "********911",
    "priority" : 1,
    "defaultPaymentInstrument" : true,
    "provider" : "myProvider"
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/find-payment-instruments?includeExpired=true' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "identifier" : {
    "identifierValue" : "AERA0001",
    "identifierType" : "LOYALTY"
  }
}'

12.5.14. Get Application Status (Health check)

GET /payments/health
Responses
HTTP Code Description Schema

200

OK

Status
Produces

  • application/json

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
GET /payments/health HTTP/1.1
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Accept: application/json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 21

{
  "status" : "UP"
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/health' -i -X GET \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Accept: application/json'

12.5.15. Activate an Invoice

POST /payments/invoice/activate
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : ActivateInvRequest

Responses
HTTP Code Description Schema

200

OK

ActivateInvResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/invoice/activate HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 170
Host: api.aerahost.com

{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : null,
  "transactionReference" : "29462LKS8764GHF"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: p4NEki4FDMocrUIsLqcYbLIuDNkxGbYooL5nL5X9NEXaL5kdvcLhuPmaKm/0re4fUx5JPGofyhMce+6xqmSAOzYgApTcVf1Cm+eOlOvA2GOkPWgTMSUEU7Mw9wXoCr70+rvBUx0vNn8R5GRbgkmleAuT83M2s+mU7c5vJpx8RzaHayODl8b3mhzWfwFH8KiL7ny5RIp1GLf/XMWlQgxBcxQGAlc0z/wimeqWGVZNJJQYxRFMGlyY4gNNsgIEL6P96/NLTs7/+XSXCYYlQKVIBzlASmMy9OKL6ayysU3jyHrimmGzuhtjMA/OdtE/sZGlngkK/Yx3At6zV36SLXFBgg==
Content-Length: 287

{
  "result" : {
    "transactionId" : "29462LKS8764GHF",
    "externalTransactionId" : null,
    "paymentMethod" : "INVOICE",
    "processor" : "WALLEY",
    "merchantId" : "AERA",
    "paymentInstrumentType" : "71"
  },
  "invoiceUrl" : "https://innestemme",
  "invoiceStatus" : null
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/invoice/activate' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : null,
  "transactionReference" : "29462LKS8764GHF"
}'

12.5.16. Add a new Invoice

POST /payments/invoice/add
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : AddInvRequest

Responses
HTTP Code Description Schema

200

OK

AddInvResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/invoice/add HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 792
Host: api.aerahost.com

{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : null,
  "identifierValue" : "00000000000",
  "identifierType" : "SSN",
  "deliveryAddress" : {
    "firstName" : "John",
    "lastName" : "AppleSeed",
    "email" : "void@void.com",
    "addressLine1" : "GateGateVeien 3",
    "addressLine2" : null,
    "city" : "OSLO",
    "postalCode" : "1422",
    "country" : "NO",
    "mobilePhone" : null
  },
  "items" : [ {
    "itemId" : "2002-23",
    "description" : "Binford 2000 Vacuum cleaner",
    "quantity" : null,
    "quantityUnit" : null,
    "grossAmount" : 2323,
    "taxPercentage" : 25
  } ],
  "clientIp" : "1.2.3.4",
  "sendInvoice" : false,
  "requireStrongCustomerVerification" : false,
  "customerType" : "B2C"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: is4bzQuR30MM3/hgNhmmcRcgkiEwKCSMQxXeHb8EVo3p970MaJZM36taOKeJBFyTAPd/0Elvmd7Due7uohVLaw/89hupZ+HHqOmtk2qLrMMKMmIRnP4g+CHLebJhRjaEZah3Qu9/wHcH/OA+rwwK4mDHlk6DjUAm+2KuZoNXX8Y1KW2Lc0LyovZEEzKrsXj+SLvLLpCYtey1ZXCpfFqv4EViklsSNogHwXd3YuQ2xzo9HMUCWSplV0dYggjiHgh9MeHs64+rzXLz+UlSQzpepEW2AByaiVkNFKTyibHZAR5rS/TUZJQrdvlO7oHEEbs28yG2WSlyDFPeJbNBZmlzdg==
Content-Length: 254

{
  "result" : {
    "transactionId" : "29462LKS8764GHF",
    "externalTransactionId" : null,
    "paymentMethod" : "INVOICE",
    "processor" : "WALLEY",
    "merchantId" : "AERA",
    "paymentInstrumentType" : "71"
  },
  "invoiceStatus" : "ACCEPTED"
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/invoice/add' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : null,
  "identifierValue" : "00000000000",
  "identifierType" : "SSN",
  "deliveryAddress" : {
    "firstName" : "John",
    "lastName" : "AppleSeed",
    "email" : "void@void.com",
    "addressLine1" : "GateGateVeien 3",
    "addressLine2" : null,
    "city" : "OSLO",
    "postalCode" : "1422",
    "country" : "NO",
    "mobilePhone" : null
  },
  "items" : [ {
    "itemId" : "2002-23",
    "description" : "Binford 2000 Vacuum cleaner",
    "quantity" : null,
    "quantityUnit" : null,
    "grossAmount" : 2323,
    "taxPercentage" : 25
  } ],
  "clientIp" : "1.2.3.4",
  "sendInvoice" : false,
  "requireStrongCustomerVerification" : false,
  "customerType" : "B2C"
}'

12.5.17. Adjusts an Invoice

POST /payments/invoice/adjust
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : AdjustInvRequest

Responses
HTTP Code Description Schema

200

OK

AdjustInvResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/invoice/adjust HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 369
Host: api.aerahost.com

{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : null,
  "transactionReference" : "WVBZKVRM5WTC1",
  "items" : [ {
    "itemId" : "2002-23",
    "description" : "Binford 2000 Vacuum cleaner",
    "quantity" : null,
    "quantityUnit" : null,
    "grossAmount" : 2323,
    "taxPercentage" : 25
  } ]
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: J+ZD/w/zBwHjsvNDI3ezRi4FcaSIc3aiRc7ABkixpMt9t3fylAhMwRCF/HfTHClCXcDtHvSgUpg2phCKJlwD1wK4mGQx8Kf8KnBAqri9/8c831fL+cJH5vqhGXcLWlC94ESFC2sF47+H2s0JFaoRYfZmOZsyNjxVHRRbNw5C9B/PGxHxnczj0cfMlkFrQXGaxnye9UVQYsbeL6S9ktoKwn0dMAAHwEr1QvUykPZolf5bmO7G6n8KaBF12QhEEuaxO81k0297zhjWph40DAxLRK3FijwR+sIx6yJUfTdL9c0SSpB0Gr+OOhUShNqLNl0K5YOWZm6sIRU15pGBQbRZhg==
Content-Length: 222

{
  "result" : {
    "transactionId" : "29462LKS8764GHF",
    "externalTransactionId" : null,
    "paymentMethod" : "INVOICE",
    "processor" : "WALLEY",
    "merchantId" : "AERA",
    "paymentInstrumentType" : "71"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/invoice/adjust' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : null,
  "transactionReference" : "WVBZKVRM5WTC1",
  "items" : [ {
    "itemId" : "2002-23",
    "description" : "Binford 2000 Vacuum cleaner",
    "quantity" : null,
    "quantityUnit" : null,
    "grossAmount" : 2323,
    "taxPercentage" : 25
  } ]
}'

12.5.18. Cancel an Invoice

POST /payments/invoice/cancel
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CancelInvRequest

Responses
HTTP Code Description Schema

200

OK

CancelInvResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/invoice/cancel HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 168
Host: api.aerahost.com

{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : null,
  "transactionReference" : "WVBZKVRM5WTC1"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: J+ZD/w/zBwHjsvNDI3ezRi4FcaSIc3aiRc7ABkixpMt9t3fylAhMwRCF/HfTHClCXcDtHvSgUpg2phCKJlwD1wK4mGQx8Kf8KnBAqri9/8c831fL+cJH5vqhGXcLWlC94ESFC2sF47+H2s0JFaoRYfZmOZsyNjxVHRRbNw5C9B/PGxHxnczj0cfMlkFrQXGaxnye9UVQYsbeL6S9ktoKwn0dMAAHwEr1QvUykPZolf5bmO7G6n8KaBF12QhEEuaxO81k0297zhjWph40DAxLRK3FijwR+sIx6yJUfTdL9c0SSpB0Gr+OOhUShNqLNl0K5YOWZm6sIRU15pGBQbRZhg==
Content-Length: 222

{
  "result" : {
    "transactionId" : "29462LKS8764GHF",
    "externalTransactionId" : null,
    "paymentMethod" : "INVOICE",
    "processor" : "WALLEY",
    "merchantId" : "AERA",
    "paymentInstrumentType" : "71"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/invoice/cancel' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : null,
  "transactionReference" : "WVBZKVRM5WTC1"
}'

12.5.19. Credit an Invoice

POST /payments/invoice/credit
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : CreditInvRequest

Responses
HTTP Code Description Schema

200

OK

CreditInvResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/invoice/credit HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 168
Host: api.aerahost.com

{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : null,
  "transactionReference" : "WVBZKVRM5WTC1"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: J+ZD/w/zBwHjsvNDI3ezRi4FcaSIc3aiRc7ABkixpMt9t3fylAhMwRCF/HfTHClCXcDtHvSgUpg2phCKJlwD1wK4mGQx8Kf8KnBAqri9/8c831fL+cJH5vqhGXcLWlC94ESFC2sF47+H2s0JFaoRYfZmOZsyNjxVHRRbNw5C9B/PGxHxnczj0cfMlkFrQXGaxnye9UVQYsbeL6S9ktoKwn0dMAAHwEr1QvUykPZolf5bmO7G6n8KaBF12QhEEuaxO81k0297zhjWph40DAxLRK3FijwR+sIx6yJUfTdL9c0SSpB0Gr+OOhUShNqLNl0K5YOWZm6sIRU15pGBQbRZhg==
Content-Length: 222

{
  "result" : {
    "transactionId" : "29462LKS8764GHF",
    "externalTransactionId" : null,
    "paymentMethod" : "INVOICE",
    "processor" : "WALLEY",
    "merchantId" : "AERA",
    "paymentInstrumentType" : "71"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/invoice/credit' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : null,
  "transactionReference" : "WVBZKVRM5WTC1"
}'

12.5.20. Get invoice options for a given merchant

POST /payments/invoice/getInvoiceOptions
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : GetInvoiceOptionsInvRequest

Responses
HTTP Code Description Schema

200

OK

GetInvoiceOptionsInvResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

12.5.21. Partially activate an Invoice

POST /payments/invoice/partiallyActivate
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : PartiallyActivateInvRequest

Responses
HTTP Code Description Schema

200

OK

PartiallyActivateInvResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/invoice/partiallyActivate HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 369
Host: api.aerahost.com

{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : null,
  "transactionReference" : "WVBZKVRM5WTC1",
  "items" : [ {
    "itemId" : "2002-23",
    "description" : "Binford 2000 Vacuum cleaner",
    "quantity" : null,
    "quantityUnit" : null,
    "grossAmount" : 2323,
    "taxPercentage" : 25
  } ]
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: Ydd2s0DmoBzp+am6U3nNXlRcltEHizb5Mv9zBjUl8IINCZkSiqaLSr/ybDs0SEiVenN7AhQ/knPdtdYMQJumnjpN9koS1M6hp2XCKM9RydFfGEcwfIRfye7W4fUoK27cGKPCn3WK64YNr8jJ4ZdWxWwibkyq5EBycfvhyLC3lBxXp8K8hESQlXT5P/wtYDKo6kLrrRDg1XTAO9FNyqQPH4dcBABYEZ9IlkNV9klgvuYdJUGkKzJX7k5x/UVTcxyWotG1bMdaOwmpJb4NhQYK08HQ6mDgUWwGGk1dp5e6djtgmZ2liEAVznDMUAaAuWlZc3DoWnfI5pq2QYvmqPPC2A==
Content-Length: 290

{
  "result" : {
    "transactionId" : "29462LKS8764GHF",
    "externalTransactionId" : null,
    "paymentMethod" : "INVOICE",
    "processor" : "WALLEY",
    "merchantId" : "AERA",
    "paymentInstrumentType" : "71"
  },
  "invoiceUrl" : "https://innestemme",
  "newTransactionId" : null
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/invoice/partiallyActivate' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : null,
  "transactionReference" : "WVBZKVRM5WTC1",
  "items" : [ {
    "itemId" : "2002-23",
    "description" : "Binford 2000 Vacuum cleaner",
    "quantity" : null,
    "quantityUnit" : null,
    "grossAmount" : 2323,
    "taxPercentage" : 25
  } ]
}'

12.5.22. Replaces an Invoice

POST /payments/invoice/replace
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : ReplaceInvRequest

Responses
HTTP Code Description Schema

200

OK

ReplaceInvResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/invoice/replace HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 369
Host: api.aerahost.com

{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : null,
  "transactionReference" : "WVBZKVRM5WTC1",
  "items" : [ {
    "itemId" : "2002-23",
    "description" : "Binford 2000 Vacuum cleaner",
    "quantity" : null,
    "quantityUnit" : null,
    "grossAmount" : 2323,
    "taxPercentage" : 25
  } ]
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: is4bzQuR30MM3/hgNhmmcRcgkiEwKCSMQxXeHb8EVo3p970MaJZM36taOKeJBFyTAPd/0Elvmd7Due7uohVLaw/89hupZ+HHqOmtk2qLrMMKMmIRnP4g+CHLebJhRjaEZah3Qu9/wHcH/OA+rwwK4mDHlk6DjUAm+2KuZoNXX8Y1KW2Lc0LyovZEEzKrsXj+SLvLLpCYtey1ZXCpfFqv4EViklsSNogHwXd3YuQ2xzo9HMUCWSplV0dYggjiHgh9MeHs64+rzXLz+UlSQzpepEW2AByaiVkNFKTyibHZAR5rS/TUZJQrdvlO7oHEEbs28yG2WSlyDFPeJbNBZmlzdg==
Content-Length: 254

{
  "result" : {
    "transactionId" : "29462LKS8764GHF",
    "externalTransactionId" : null,
    "paymentMethod" : "INVOICE",
    "processor" : "WALLEY",
    "merchantId" : "AERA",
    "paymentInstrumentType" : "71"
  },
  "invoiceStatus" : "ACCEPTED"
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/invoice/replace' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : null,
  "transactionReference" : "WVBZKVRM5WTC1",
  "items" : [ {
    "itemId" : "2002-23",
    "description" : "Binford 2000 Vacuum cleaner",
    "quantity" : null,
    "quantityUnit" : null,
    "grossAmount" : 2323,
    "taxPercentage" : 25
  } ]
}'

12.5.23. (Re)Send an Invoice

POST /payments/invoice/send
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : SendInvRequest

Responses
HTTP Code Description Schema

200

OK

SendInvResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/invoice/send HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 231
Host: api.aerahost.com

{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : null,
  "transactionReference" : "WVBZKVRM5WTC1",
  "clientIp" : "1.2.3.4",
  "invoiceDeliveryMethod" : "EMAIL"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: fHDRdQuf95JeopwVLCL0UIm2Ntmnxor3DpgqQaC/onBQu5kHpWuZ8VXwpHaPuxInkaGVtIvE0kl+phb63MoXHV7+5CsBrs1Z3fIH3fg1wrcq89GZDi2XZim8RTgEHUdemqmZ5JTeeumvZPQgxOk1w9HW23YsHbkc2lj8eVNRYRxGLRU/aM4TnweTfm5CbVVpJERqvwgcQuuO/3+h2anOCkPkoBFwQ6pX1pw/XSXPTKrD4XHK8Je+2D+OFWe5h3xbmvTvrJrXyxIzKuNrqbPJCsLAVKgR+GLAU59w3lZmp95enW6hJNcdXMjm3qAcexcp76VWfuJjZyKCJNlWHyPRXg==
Content-Length: 261

{
  "result" : {
    "transactionId" : "29462LKS8764GHF",
    "externalTransactionId" : null,
    "paymentMethod" : "INVOICE",
    "processor" : "WALLEY",
    "merchantId" : "AERA",
    "paymentInstrumentType" : "71"
  },
  "invoiceUrl" : "https://innestemme"
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/invoice/send' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "M12323223",
  "externalTransactionId" : "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber" : null,
  "transactionReference" : "WVBZKVRM5WTC1",
  "clientIp" : "1.2.3.4",
  "invoiceDeliveryMethod" : "EMAIL"
}'

12.5.24. Set a new order number on a given invoice

POST /payments/invoice/setOrderNumber
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : SetOrderNumberRequest

Responses
HTTP Code Description Schema

200

OK

SetOrderNumberResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

12.5.25. Get invoice status

GET /payments/invoice/status/{type}/{value}
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

type
required

Type must be set to paymentreference or transactionreference

string

Path

value
required

string
Responses
HTTP Code Description Schema

200

OK

StatusInvResponse
Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

12.5.26. MIT Sale transaction. Calling this endpoint the liability shifts from the issuing bank to the merchant.

POST /payments/mit/sale
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : SaleMitRequest

Responses
HTTP Code Description Schema

200

OK

PaymentResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

12.5.27. Refund transaction - used to perform a refund

POST /payments/refund
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : RefundRequest

Responses
HTTP Code Description Schema

200

OK

RefundResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/refund HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 314
Host: api.aerahost.com

{
  "merchantId" : "AERA",
  "externalTransactionId" : "29462LKS8764GHF",
  "orderNumber" : "20180404",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1100,
  "taxAmount" : 100,
  "originatingSystem" : "MobileApp",
  "country" : "NO",
  "comment" : null,
  "transactionReference" : "WVBZKVRM5WTC1"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: rXmf3x1VBOJk4lM+kIZRTlgAFQJn5BctStn8nGi2ek3ZQUTCbDnkny8L0VGNmV+510PhZA7JJobkefPpb8ep4AVJDe1YKswJbn8IiQ/MJ8zuFdGXGiopYb+wHqckswZzCTP5wjqQuM9EMY+8iCZCKHuB4eb+xGPGKBxtLbQ6ywaSe8HzAGJtPXsDBXcCQ3yuFtx1EeIeXGBDlCTwapD7vvbOvzcuy11dzlQwerwY43Hjf9Q4Wu/X06gLYPR7+R/0IBq+rVctqwyxWk48r52W/3PZh4TVjEAFn4xsWHqYDxW1K/1bUO+Aygoz2LHyiw/RTLN2MUKar7MHKfCHJSYZ+w==
Content-Length: 270

{
  "responseInfo" : {
    "message" : "Service succeeded",
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T15:04:35.854Z"
  },
  "result" : {
    "transactionId" : "HLSIDKSI6WLS6",
    "externalTransactionId" : "29462LKS8764GHF",
    "merchantId" : "AERA"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/refund' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "AERA",
  "externalTransactionId" : "29462LKS8764GHF",
  "orderNumber" : "20180404",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1100,
  "taxAmount" : 100,
  "originatingSystem" : "MobileApp",
  "country" : "NO",
  "comment" : null,
  "transactionReference" : "WVBZKVRM5WTC1"
}'

12.5.28. Sale transaction - used to perform a sale.

POST /payments/sale
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Header

x-real-ip
optional

string
Body parameter

Name : body
Flags : required
Type : PaymentRequest

Responses
HTTP Code Description Schema

200

OK

PaymentResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/sale HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 701
Host: api.aerahost.com

{
  "merchantId" : "AERA",
  "externalTransactionId" : "12345LJDF345",
  "orderNumber" : "20180404",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1100,
  "taxAmount" : 100,
  "originatingSystem" : "MobileApp",
  "country" : "NO",
  "comment" : null,
  "customerVerificationData" : {
    "cryptogram" : "TEtKU0Y4NzIzNDVKS0xEUzg3NjQyM2prbGIrZHNha0pGR0pIZnNhZG84NzRyYWpza21uSkhGRGxranNhZGZrS0xKaDc3NjVGR0RIR1NudnNoZ2ZkWVRubWZKSGY=",
    "nonce" : "OTg3NjU0MzIxMg==",
    "signedData" : "eyJtZXJjaGFudElkIjoiQUVSQSIsIm1lcmNoYW50TmFtZSI6IkFlcmEiLCJjdXJyZW5jeSI6Ik5PSyIsImdyb3NzQW1vdW50IjoxMTAwfQ=="
  },
  "delayedCharge" : false,
  "merchantInitiated" : false,
  "authType" : "PRE_AUTH"
}
Example HTTP response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: VSup1aQsmxnI/vPUYLmkf5VtcZHaxyiY6Qw04gVoo1ZFN8u78t7pv21rXgRZwxyIWHw10RrDH0HhHkZE6tM3uJIiXvgUWvYBdyo0gooBDU/JkfCt38DbsV01MJf7C1ltR+KmMV4Nlpx4o/kA5bBsAGNLj/l2UksINKfRRdqfrFmaSZjWACiOv3p+W9q5Uuh9zV9KJxLEoVABF/LPcmGXW6zJYXm1i/TnZef5tuhz/kkklW+9PPCzUJruqMoutHzM0uLS5z2bvVjtRPyJ60CIc+r82Sxa0mxnn9vnTg8/jgF4MF0zgXuxAtphoqntaMg2Aznmxou39LazdPQbm2d2vA==
Example Curl request
$ curl 'https://api.aerahost.com/payments/sale' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "AERA",
  "externalTransactionId" : "12345LJDF345",
  "orderNumber" : "20180404",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1100,
  "taxAmount" : 100,
  "originatingSystem" : "MobileApp",
  "country" : "NO",
  "comment" : null,
  "customerVerificationData" : {
    "cryptogram" : "TEtKU0Y4NzIzNDVKS0xEUzg3NjQyM2prbGIrZHNha0pGR0pIZnNhZG84NzRyYWpza21uSkhGRGxranNhZGZrS0xKaDc3NjVGR0RIR1NudnNoZ2ZkWVRubWZKSGY=",
    "nonce" : "OTg3NjU0MzIxMg==",
    "signedData" : "eyJtZXJjaGFudElkIjoiQUVSQSIsIm1lcmNoYW50TmFtZSI6IkFlcmEiLCJjdXJyZW5jeSI6Ik5PSyIsImdyb3NzQW1vdW50IjoxMTAwfQ=="
  },
  "delayedCharge" : false,
  "merchantInitiated" : false,
  "authType" : "PRE_AUTH"
}'

12.5.29. ApplePay sale transaction - used to perform a payment after an ApplePay in app or ApplePay on web transaction

POST /payments/sale/applepay
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : ApplePayRequest

Responses
HTTP Code Description Schema

200

OK

PaymentResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/sale/applepay HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 1884
Host: api.aerahost.com

{
  "merchantId" : "AERA",
  "externalTransactionId" : "043322e5-fcb4-414d-ae4f-4d54822946e7",
  "orderNumber" : "122343234",
  "currency" : "NOK",
  "amount" : 1000,
  "paymentData" : {
    "data" : "f3/fcnNsSweH8j0WEFWEFWRGRWEGWRGWRGFvdkcqMpmUKVibrTEyXQU3YojRrKzf90mDdpvSkyc7APYxfwX6evc8BfA8IqdN38NAUdq6+0JhE43/Uze9ciUPSE4H4KFy6utS8o+xuzhQlD6Fw4zxJ/FFLIsxZEV9kQGnBdsyQ2/nab3iuhJOAXoVkcvmjqHDdMlGNfspCOAhb7cmNgURu1WJZqreolmpiyzSsgtQ9GHPcllDf+j4C8WRPbStYowV90ZyIxDbS2L/zlH/iHvY+jrMGusjgYPY/R4Or3If6T4VBfIWY08VCiD8Z45lgV29BNXhLBqNuVoynYMW+miW5QA7hAfuayADGncqA0/1rcc+VqEzN0B3U",
    "signature" : "MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIID5jCCA4ugAwIBAgIIaGD2mdnMpw8wCgYIKoZIzj0EAwIwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE2MDYwMzE4MTY0MFoXDTIxMDYwMjE4MTY0MFowYjEoMCYGA1UEAwwfZWNjLXNtcC1icm9rZXItc2lnbl9VQzQtU0FOREJPWDEUMBIGA1UECwwLaU9TIFN5c3RlbXMxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEgjD9q8Oc914gLFDZm0US5jfiqQHdbLPgsc1LUmeY+M9OvegaJajCHkwz3c6OKpbC9q+hkwNFxOh6RCbOlRsSlaOCAhEwggINMEUGCCsGAQUFBwEBBDkwNzA1BggrBgEFBQcwAYYpaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZWFpY2EzMDIwHQYDVR0OBBYEFAIkMAua7u1GMZekplopnkJxghxFMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUI/JJxE+T5O8n5sT2KGw/orv9LkswggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgefjfeehuefnefefniefJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZm",
    "version" : "EC_v1",
    "ephemeralPublicKey" : "MFkwEFE0FEJ3EF9HF3KSDFMOPSDFOPFSDuvUXGQfzqtQm5qDK1WFWEFWEWEFs85E5BQosHNqUxA==",
    "publicKeyHash" : "EERCobQBvtM9EJ3FMPF3J9kuBIz5f0H2C/pU=",
    "transactionId" : "331f4c6689530384845923234ad068b1eb0afdb56da9dae5"
  }
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: ngZuZmlZbS+tRvMq7LZJqWYExf5tNFlM0rvx9qLl4dLSZ3i1YOUYnBQsjGZM5bUa4h4mgHZ22mTnxqwLbCh6ZM3O3Gt8YY6VhBOvUggqdgqm6ZAdL+WsBUSvlbfAVqUwRfbUkf43Zuy1iaxvlKN36Nb6locq9BKJFr2oGrdpKa25pV0aymCW+/YqntFqUqxZ67k4pcFaxCOW+Bhw1HKVnLbFf+JraFEm/9CLocjVgcfieGIvDi1uD6lQzbm/xAB5wFM6SjGAJm2W3dQveJWA7wVmNCctwG0KN7/XjmYJGdajdVC54GMEfXH5PZ53poy7+1tYlQg5uifebpIGzL6+wQ==
Content-Length: 505

{
  "responseInfo" : {
    "message" : "Service succeeded",
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T15:04:35.686Z"
  },
  "result" : {
    "transactionId" : "WVBZKVRM5WTC1",
    "externalTransactionId" : "043322e5-fcb4-414d-ae4f-4d54822946e7",
    "paymentMethod" : "Visa",
    "processor" : "EXBANK",
    "maskedVPAN" : "****5005",
    "expirationDate" : "1121",
    "authorizationCode" : "213462",
    "merchantId" : "AERA",
    "cardType" : "C",
    "paymentInstrumentType" : "03"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/sale/applepay' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "AERA",
  "externalTransactionId" : "043322e5-fcb4-414d-ae4f-4d54822946e7",
  "orderNumber" : "122343234",
  "currency" : "NOK",
  "amount" : 1000,
  "paymentData" : {
    "data" : "f3/fcnNsSweH8j0WEFWEFWRGRWEGWRGWRGFvdkcqMpmUKVibrTEyXQU3YojRrKzf90mDdpvSkyc7APYxfwX6evc8BfA8IqdN38NAUdq6+0JhE43/Uze9ciUPSE4H4KFy6utS8o+xuzhQlD6Fw4zxJ/FFLIsxZEV9kQGnBdsyQ2/nab3iuhJOAXoVkcvmjqHDdMlGNfspCOAhb7cmNgURu1WJZqreolmpiyzSsgtQ9GHPcllDf+j4C8WRPbStYowV90ZyIxDbS2L/zlH/iHvY+jrMGusjgYPY/R4Or3If6T4VBfIWY08VCiD8Z45lgV29BNXhLBqNuVoynYMW+miW5QA7hAfuayADGncqA0/1rcc+VqEzN0B3U",
    "signature" : "MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIID5jCCA4ugAwIBAgIIaGD2mdnMpw8wCgYIKoZIzj0EAwIwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE2MDYwMzE4MTY0MFoXDTIxMDYwMjE4MTY0MFowYjEoMCYGA1UEAwwfZWNjLXNtcC1icm9rZXItc2lnbl9VQzQtU0FOREJPWDEUMBIGA1UECwwLaU9TIFN5c3RlbXMxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEgjD9q8Oc914gLFDZm0US5jfiqQHdbLPgsc1LUmeY+M9OvegaJajCHkwz3c6OKpbC9q+hkwNFxOh6RCbOlRsSlaOCAhEwggINMEUGCCsGAQUFBwEBBDkwNzA1BggrBgEFBQcwAYYpaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZWFpY2EzMDIwHQYDVR0OBBYEFAIkMAua7u1GMZekplopnkJxghxFMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUI/JJxE+T5O8n5sT2KGw/orv9LkswggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgefjfeehuefnefefniefJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZm",
    "version" : "EC_v1",
    "ephemeralPublicKey" : "MFkwEFE0FEJ3EF9HF3KSDFMOPSDFOPFSDuvUXGQfzqtQm5qDK1WFWEFWEWEFs85E5BQosHNqUxA==",
    "publicKeyHash" : "EERCobQBvtM9EJ3FMPF3J9kuBIz5f0H2C/pU=",
    "transactionId" : "331f4c6689530384845923234ad068b1eb0afdb56da9dae5"
  }
}'

12.5.30. PrePaid sale transaction - used to perform a payment typically with any non-PCI prepaid cards like gift cards.

POST /payments/sale/prepaid
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : PrePaidRequest

Responses
HTTP Code Description Schema

200

OK

PaymentResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

12.5.31. Wallet sale transaction - used to perform a sale after communicating with the customer’s wallet

POST /payments/sale/wallet
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
required

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : WalletPaymentRequest

Responses
HTTP Code Description Schema

200

OK

PaymentResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/sale/wallet HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 465
Host: api.aerahost.com

{
  "merchantId" : "AERA",
  "externalTransactionId" : "12345LJDF345",
  "orderNumber" : "20180404",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1100,
  "taxAmount" : 100,
  "originatingSystem" : "MobileApp",
  "country" : "NO",
  "comment" : null,
  "identifierValue" : "2345223",
  "identifierType" : "ADDITIONAL_ID",
  "delayedCharge" : false,
  "merchantInitiated" : false,
  "async" : true,
  "callbackUrl" : null,
  "authType" : "PRE_AUTH"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: vmzkE9SogTLSXD3hsF+U4fs0nrFFQpL/iBMd5rQT8DNinrMHHQ+0kwyxu14tlhwyyO04TjXst+jyCNDARpWbzIbQ3q5o0i5C2OLLmONL0TI9mIMi8KLjCvjNUIKkKXaESiFAikb5d8vK9ymuKl52JDbiN9bQoc2RY3o3hvP2m6ix8L99GRDvm4dWebLzQj9ZlpQgEgonPaSYrVdE+tv3mJbbPGUtZoVMdAKiwdVu3+uwa9ZmuZRsw/QkZ+iVV4NBAvMfiNYiEsV9S8wbisjqgrQm/xSUjVJE52Bpy9B3KNFw2g85THls/BG2pcYL+c+VxQk0ENH8eW8+Xlni0ic6bQ==
Content-Length: 84

{
  "result" : null,
  "paymentReference" : "65e7dea2-e17e-460e-a2ba-26e6b758f33f"
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/sale/wallet' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "merchantId" : "AERA",
  "externalTransactionId" : "12345LJDF345",
  "orderNumber" : "20180404",
  "currency" : "NOK",
  "netAmount" : 1000,
  "grossAmount" : 1100,
  "taxAmount" : 100,
  "originatingSystem" : "MobileApp",
  "country" : "NO",
  "comment" : null,
  "identifierValue" : "2345223",
  "identifierType" : "ADDITIONAL_ID",
  "delayedCharge" : false,
  "merchantInitiated" : false,
  "async" : true,
  "callbackUrl" : null,
  "authType" : "PRE_AUTH"
}'

12.5.32. Starts an APP Add Card Session

POST /payments/start-add-card-session
Parameters
Type Name Description Schema

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : StartAddCardSessionRequest

Responses
HTTP Code Description Schema

200

OK

StartAddCardSessionResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/start-add-card-session HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
Accept: application/vnd.payments.v1+json
Content-Length: 197
Host: api.aerahost.com

{
  "identifiers" : [ {
    "identifierValue" : "AERA0001",
    "identifierType" : "LOYALTY"
  } ],
  "locale" : "no",
  "customStylingUrl" : "https://my-domain.com/styling/my-custom-styling.css"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: BzXF+WW3ds826HLj4p981yrcWZB49a6zZDXUAh1OpIihAX0UZdEnqdKuiQ16ko0hWhCplDQCa2kLAApkHX+UCBUIf0/0B7/I1Y5w/tHegYWPhkxH9CeMWrIodYT1DWSxzGoBXZpL2QJqpjF3xkVgeZiH8GYSTSAIWXiC9ZpYwZMRnboAEBHzA4JP1Tzu8XhApVKdrcucbbqBZfxlxCTeprmSuEQLv17kysbRE+hge1muXcMV/uWZPzgjw+4NJpWInu9SVqDwSN8Nq6g+1WzfzIVweEs15iGqH1Y3L6xDsisYoxAT5zslqcOmOK70bG3soMxAGVrbhihd30lxRpXKPw==
Content-Length: 287

{
  "appUrl" : "https://static.api.aerahost.com/view/index.html?m=payment-overview&lang=no&sid=efb6b854-d26b-4625-8eb7-5b36c21d0711",
  "sessionId" : "efb6b854-d26b-4625-8eb7-5b36c21d0711",
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T15:04:33.027Z"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/start-add-card-session' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "identifiers" : [ {
    "identifierValue" : "AERA0001",
    "identifierType" : "LOYALTY"
  } ],
  "locale" : "no",
  "customStylingUrl" : "https://my-domain.com/styling/my-custom-styling.css"
}'

12.5.33. Starts an APP payment session

POST /payments/startSession
Parameters
Type Name Description Schema

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

Content-Type
required

The content type of the body.

string

Header

idempotency-key
optional

The Idempotency-Key header needed to create idempotent requests. Must be on UUID format.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : StartSessionRequest

Responses
HTTP Code Description Schema

200

OK

StartSessionResponse
Consumes

  • application/vnd.payments.v1+json

Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
POST /payments/startSession HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Content-Length: 496
Host: api.aerahost.com

{
  "globalLocationNumber" : "7827474759240",
  "externalTransactionId" : "123456",
  "orderNumber" : "54321",
  "currency" : "NOK",
  "netAmount" : 8000,
  "grossAmount" : 10000,
  "taxAmount" : 2000,
  "originatingSystem" : null,
  "country" : "NO",
  "comment" : null,
  "wspId" : 0,
  "appActionType" : "CARD_VERIFY",
  "merchantInitiated" : false,
  "language" : "no",
  "useDefaultPaymentInstrument" : false,
  "oneClick" : false,
  "onlyCardFromWallet" : false,
  "authType" : "PRE_AUTH"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Security-Policy: frame-src 'https://hpp2.ips-preprod.payments.goacoustic.com'
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: aRXr608zo/gvavKHd4uxtG2M2LGMUlvWIoKln+VVUDswEmtoGaHIxtwC+i9geWN5IZviHA6USG91dfwE7eUczU7066khXTpVo7f4Lvv/o5g5Nbyl51Ird+jPp4ib7SqJ+Ct6Ba9cLCz8OZXbprQcIo/dF5frn9Xw2Nyp8POtntYuTrxdUABy/08xY2FGcPMd2L8SdGwbWPQ0eTxv6DU2ZdPQV2kMFNCbapDWqpBVUscHH+Y+6cmRdauKVgkbcnbHl1ltjC5TIScazOeVAkJGgveKjjr9D/y4Ch6Z0CqNc84jh3xBQsXPagGJgUYZ24NeAvO59pye3H6EzkbRnZKa9g==
Content-Length: 191

{
  "responseInfo" : {
    "message" : "OK",
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T15:04:37.273Z"
  },
  "appUrl" : "https://localhost",
  "paymentReference" : "sessionID"
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/startSession' -i -X POST \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json' \
    -d '{
  "globalLocationNumber" : "7827474759240",
  "externalTransactionId" : "123456",
  "orderNumber" : "54321",
  "currency" : "NOK",
  "netAmount" : 8000,
  "grossAmount" : 10000,
  "taxAmount" : 2000,
  "originatingSystem" : null,
  "country" : "NO",
  "comment" : null,
  "wspId" : 0,
  "appActionType" : "CARD_VERIFY",
  "merchantInitiated" : false,
  "language" : "no",
  "useDefaultPaymentInstrument" : false,
  "oneClick" : false,
  "onlyCardFromWallet" : false,
  "authType" : "PRE_AUTH"
}'

12.5.34. Get extended payment status

GET /payments/status/extended/{type}/{value}
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

type
required

Type must currently be set to paymentReference or transactionId

string

Path

value
required

string
Responses
HTTP Code Description Schema

200

OK

StatusResponse
Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

12.5.35. Get payment status

GET /payments/status/{type}/{value}
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

type
required

Type must currently be set to paymentReference or transactionId

string

Path

value
required

string
Responses
HTTP Code Description Schema

200

OK

StatusResponse
Produces

  • application/vnd.payments.v1+json

Tags

  • Payments

Example HTTP request
GET /payments/status/paymentReference/testid HTTP/1.1
Content-Type: application/vnd.payments.v1+json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37
Accept: application/vnd.payments.v1+json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/vnd.payments.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: E1qZhaay3/AIUWJpzxHgTL0VWPR2+qTnQKXteAqfOqzq2BZbnpDhxY0Y3llirdi/dZTW52f0b9jgsfoEaYfIGUaMCdkU6H35Sv43gdBpKXeLnzKZJgwCAAGNmDMhyHu/mliFCiNDOfyIodfJ8dIOQf95hrCwBGbtFZDkWm1XYbFwXRRAyC35yibeQh7Znxqm5zM7y2biL2gTsph3KBlpXe2eY/vBJ4rCi5Y+el4fCLh+LIEOAvhOzWN9YB8brSL1xWnX1IgNSS/rW1PNhxs69BtK92k9HNXBv4zETKXkfFKSltjbytpMD3akFq6Soqdepjb47M/uYOJDkCFbG0OIUA==
Content-Length: 390

{
  "responseInfo" : {
    "message" : "Service succeeded",
    "responseCode" : "0",
    "timeStamp" : "2025-08-15T15:04:30.853Z"
  },
  "statusList" : [ {
    "transactionId" : "dsadsdas",
    "paymentReference" : "ddsapnfdnoifew",
    "transactionType" : "Capture",
    "responseCode" : "0",
    "message" : "Service succeeded",
    "paymentInstrumentType" : "dsjodsihdsbiefhife"
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/payments/status/paymentReference/testid' -i -X GET \
    -H 'Content-Type: application/vnd.payments.v1+json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'idempotency-key: 77786638-fec6-4da1-bdbd-bb180d3f5d37' \
    -H 'Accept: application/vnd.payments.v1+json'

12.5.36. Deletes an Identifier (Payment Instrument), regardsless if default payment instrument, by its ConsumerId and IdentifierId.

DELETE /payments/{consumerId}/identifiers/{identifierId}
Parameters
Type Name Description Schema

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

consumerId
required

string (uuid)

Path

identifierId
required

string
Responses
HTTP Code Description Schema

204

No Content

No Content
Tags

  • Payments

Example HTTP request
DELETE /payments/0e27b15f-2b13-4ab5-a2bd-d291582fa39d/identifiers/49149bab50e0a73dbe8340cc05575ed7aea7f1aa HTTP/1.1
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU
Accept: application/vnd.payments.v1+json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 204 No Content
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Example Curl request
$ curl 'https://api.aerahost.com/payments/0e27b15f-2b13-4ab5-a2bd-d291582fa39d/identifiers/49149bab50e0a73dbe8340cc05575ed7aea7f1aa' -i -X DELETE \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiXSwiaXNzIjoiYWVyYS50ZXN0LXJlc291cmNlIiwiYXVkIjoiYWVyYS50ZXN0LXJlc291cmNlIiwibmJmIjoxNTI0NzI4MTg5LCJpYXQiOjE1MjQ3MjgxODksImV4cCI6OTk4MzQxMTkwMywianRpIjoiMmQ2NWI0YTktOWE5Ni00OWFmLWIyN2ItZTVhMzkzYjMwZjc1In0.pwDOT1D5ojEc1g8f2OU28XWCqltOLGox06n-y93DFrJ4dS56GZFermwdJ-9LESR4_8aRYFwymhNutwEFTxB2HgMXxF86NyzMglQw2FMQ25tQk5hajJWnesw9d_xGCXfkV1-pHkFCQwNcH1g6flysvYVsk55_Ty5WGvGlzQPwGmU' \
    -H 'Accept: application/vnd.payments.v1+json'

12.6. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

12.6.1. ActivateInvRequest

Name Description Schema

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The global location number (13 characters).
Required unless merchantId is set.
Length : 13

string

merchantId
optional

The merchant ID as provided (1-36 characters).
Required unless globalLocationNumber is set.
Length : 1 - 36

string

orderNumber
optional

The order number.
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

paymentReference
optional

The payment reference from startSessionResponse. Required unless transactionReference is set.

string (uuid)

transactionReference
optional

The reference to the transactionId returned when adding an invoice. Required unless paymentReference is set.
Length : 10 - 40

string

12.6.2. ActivateInvResponse

Name Description Schema

invoiceStatus
required

InvoiceStatus

invoiceUrl
required

The url to the invoice

string

responseInfo
optional

ResponseInfo

result
required

InvResult

12.6.3. AddInvRequest

Name Description Schema

b2bInvoiceData
optional

B2BInvoiceData

clientIp
required

Customers IP Address
Minimum length : 1

string

customerType
required

Indicates if this is a business invoice or a customer invoice.

enum (B2B, B2C)

deliveryAddress
optional

Address

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The global location number (13 characters).
Required unless merchantId is set.
Length : 13

string

identifierType
required

The type of the Identifier

enum (PAY_CARD, PAY_ACCOUNT, EMAIL, MOBILE_NUMBER, ADDITIONAL_ID, WALLET_REF, ACCOUNT_NUMBER, LOYALTY, SSN, SSN_ALIAS, PID, FREJA_EID, ID_DOCUMENT_SN, HASH)

identifierValue
required

The value of the Identifier
Length : 1 - 255

string

invoiceAddress
optional

Address

items
required

Items

< Item > array

merchantId
optional

The merchant ID as provided (1-36 characters).
Required unless globalLocationNumber is set.
Length : 1 - 36

string

orderNumber
optional

The order number.
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

product
optional

Product. Default product is DI_001 which translates to an ordinary invoice.

enum (DI_001, CA_001, AN_6_001, AN_12_001, AN_24_001, AN_36_001, CAMPAIGN, IF_3_001, IF_6_001, IF_12_001)

requireStrongCustomerVerification
required

Not currently used. Can be omitted.

boolean

sendInvoice
optional

If set to true the invoice will be sent to the customer immediately and activateInvoice does not have to be called. Used for immediate delivery of goods. Default is false.

boolean

12.6.4. AddInvResponse

Name Schema

invoiceStatus
required

InvoiceStatus

responseInfo
optional

ResponseInfo

result
required

InvResult

12.6.5. Address

InvoiceAddress - Used in B2C payments. If not set the delivery address is used as invoice address

Name Description Schema

addressLine1
required

Address Line 1
Length : 1 - 3000

string

addressLine2
optional

Address Line 2
Length : 1 - 3000

string

city
required

City
Length : 1 - 3000

string

country
required

Country - ISO 3166-1 alpha 2
Length : 2

string

email
required

eMail
Length : 1 - 3000

string

firstName
required

First Name
Length : 1 - 3000

string

lastName
required

Last Name
Length : 1 - 3000

string

mobilePhone
required

Mobile Phone
Length : 1 - 3000

string

postalCode
required

PostalCode
Length : 1 - 3000

string

12.6.6. AdjustInvRequest

Name Description Schema

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The global location number (13 characters).
Required unless merchantId is set.
Length : 13

string

items
required

Items

< Item > array

merchantId
optional

The merchant ID as provided (1-36 characters).
Required unless globalLocationNumber is set.
Length : 1 - 36

string

orderNumber
optional

The order number.
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

paymentReference
optional

The payment reference from startSessionResponse. Required unless transactionReference is set.

string (uuid)

transactionReference
optional

The reference to the transactionId returned when adding an invoice. Required unless paymentReference is set.
Length : 10 - 40

string

12.6.7. AdjustInvResponse

Name Schema

responseInfo
optional

ResponseInfo

result
required

InvResult

12.6.8. ApplePayRequest

Name Description Schema

amount
required

The amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

callbackInfo
optional

CallbackInfo

currency
required

The currency code (ISO 4217 alpha-3).
Length : 3

string

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

merchantId
required

The merchant ID as provided (1-36 characters).
Required unless globalLocationNumber is set.
Length : 1 - 36

string

orderNumber
required

The order number (1-20 characters).
For refund requests this value must match the value from the original transaction.
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

paymentData
required

PaymentData

12.6.9. B2BAddress

InvoiceAddress

Name Description Schema

addressLine1
required

Address Line 1
Length : 1 - 3000

string

addressLine2
optional

Address Line 2
Length : 1 - 3000

string

city
required

City
Length : 1 - 3000

string

companyName
required

Company name - Used in B2B payments
Length : 1 - 3000

string

country
required

Country - ISO 3166-1 alpha 2
Length : 2

string

firstName
required

First Name
Length : 1 - 3000

string

lastName
required

Last Name
Length : 1 - 3000

string

postalCode
required

PostalCode
Length : 1 - 3000

string

12.6.10. B2BInvoiceData

CustomerInvoiceData - Mandatory for B2B payments

Name Description Schema

buyerInfo
required

BuyerInfo

costCenter
required

Cost center

string

deliveryAddress
optional

B2BAddress

invoiceAddress
optional

B2BAddress

orgNo
optional

Buyer Organisation Number

string

reference
required

Reference

string

12.6.11. BuyerInfo

BuyerInfo

Name Description Schema

email
required

Buyer Email
Minimum length : 1

string

firstName
required

First Name
Length : 1 - 3000

string

lastName
required

Last Name
Length : 1 - 3000

string

mobilePhone
required

Mobile Phone
Length : 1 - 3000

string

12.6.12. CallbackInfo

Callback information

Name Description Schema

subDomain
required

Sub domain

string

12.6.13. CancelInvRequest

Name Description Schema

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The global location number (13 characters).
Required unless merchantId is set.
Length : 13

string

merchantId
optional

The merchant ID as provided (1-36 characters).
Required unless globalLocationNumber is set.
Length : 1 - 36

string

orderNumber
optional

The order number.
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

paymentReference
optional

The payment reference from startSessionResponse. Required unless transactionReference is set.

string (uuid)

transactionReference
optional

The reference to the transactionId returned when adding an invoice. Required unless paymentReference is set.
Length : 10 - 40

string

12.6.14. CancelInvResponse

Name Schema

responseInfo
optional

ResponseInfo

result
required

InvResult

12.6.15. CancelRequest

Name Description Schema

acquirerId
optional

The merchant acquirer Id (1-36 characters).
Length : 1 - 36

string

callbackInfo
optional

CallbackInfo

comment
optional

An optional comment related to why a cancel or refund i done. Used and displayed in the portal.
Length : 0 - 60

string

country
required

The country code (ISO 3166-1 alpha-2).
Length : 2

string

currency
required

The currency code (ISO 4217 alpha-3).
Length : 3

string

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

externalTransactionReference
optional

The reference to the externalTransactionId used in the original sale payment request.
Required if transactionReference/paymentReference is not available.
Length : 1 - 40

string

globalLocationNumber
optional

The merchant global location number (13 characters).
Length : 13

string

grossAmount
required

The gross amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

merchantId
optional

The merchant Id (1-36 characters).
Length : 1 - 36

string

netAmount
required

The net amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

orderNumber
required

The order number (1-20 characters).
For refund requests this value must match the value from the original transaction.
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

originatingSystem
optional

The originating system (1-20 characters).
Length : 1 - 20

string

paymentReference
optional

The payment reference from startSessionResponse linking the authorization. Used if the payment window made the Authorization

string (uuid)

taxAmount
required

The VAT/tax amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

transactionReference
optional

The reference to the transactionId returned when authorize was executed.
Length : 10 - 40

string

12.6.16. CancelResponse

Name Schema

responseInfo
optional

ResponseInfo

result
required

CancelResult

12.6.17. CancelResult

The result of the cancel transaction.

Name Description Schema

externalTransactionId
required

External ID for the transaction set in the request.
Minimum length : 1

string

merchantId
optional

The merchant ID.

string

transactionId
optional

ID for the transaction.

string

12.6.18. CaptureRequest

Name Description Schema

acquirerId
optional

The merchant acquirer Id (1-36 characters).
Length : 1 - 36

string

callbackInfo
optional

CallbackInfo

cancelResidualAmount
required

Residual reserved amount is cancelled if this flag is set to true

boolean

comment
optional

An optional comment related to why a cancel or refund i done. Used and displayed in the portal.
Length : 0 - 60

string

country
required

The country code (ISO 3166-1 alpha-2).
Length : 2

string

currency
required

The currency code (ISO 4217 alpha-3).
Length : 3

string

delayedCapture
required

If set to true, the expiration date of the authorization is ignored. The liability shifts from the issuing Bank to the Merchant.

boolean

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The merchant global location number (13 characters).
Length : 13

string

grossAmount
required

The gross amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

merchantId
optional

The merchant Id (1-36 characters).
Length : 1 - 36

string

netAmount
required

The net amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

orderNumber
required

The order number (1-20 characters).
For refund requests this value must match the value from the original transaction.
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

originatingSystem
optional

The originating system (1-20 characters).
Length : 1 - 20

string

paymentReference
optional

The payment reference from startSessionResponse linking the authorization. Used if the payment window made the Authorization

string (uuid)

taxAmount
required

The VAT/tax amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

transactionReference
optional

The reference to the transactionId returned when authorizing the payment
Length : 10 - 40

string

12.6.19. CaptureResponse

Name Schema

responseInfo
optional

ResponseInfo

result
required

CaptureResult

12.6.20. CaptureResult

The result of the capture transaction.

Name Description Schema

externalTransactionId
required

External ID for the transaction set in the request.
Minimum length : 1

string

merchantId
optional

The merchant ID.

string

transactionId
optional

ID for the transaction.

string

12.6.21. CollectRequest

Name Description Schema

acquirerId
optional

The merchant acquirer Id (1-36 characters).
Length : 1 - 36

string

callbackInfo
optional

CallbackInfo

cancelResidualAmount
optional

Residual reserved amount is cancelled if this flag is set to true

boolean

comment
optional

An optional comment related to why a cancel or refund i done. Used and displayed in the portal.
Length : 0 - 60

string

country
required

The country code (ISO 3166-1 alpha-2).
Length : 2

string

currency
required

The currency code (ISO 4217 alpha-3).
Length : 3

string

delayedCapture
optional

If set to true, the expiration date of the authorization is ignored. The liability shifts from the issuing Bank to the Merchant.

boolean

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The merchant global location number (13 characters).
Length : 13

string

grossAmount
required

The gross amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

merchantId
optional

The merchant Id (1-36 characters).
Length : 1 - 36

string

netAmount
required

The net amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

orderNumber
required

The order number (1-20 characters).
For refund requests this value must match the value from the original transaction.
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

originatingSystem
optional

The originating system (1-20 characters).
Length : 1 - 20

string

paymentReference
optional

The payment reference from startSessionResponse linking the authorization. Used if the payment window made the Authorization

string (uuid)

taxAmount
required

The VAT/tax amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

transactionReference
optional

The reference to the transactionId returned when authorizing the payment
Length : 10 - 40

string

12.6.22. CollectResponse

Name Schema

responseInfo
optional

ResponseInfo

result
required

CollectResult

12.6.23. CollectResult

The result of the collect transaction.

Name Description Schema

externalTransactionId
required

External ID for the transaction set in the request.
Minimum length : 1

string

merchantId
optional

The merchant ID.

string

transactionId
optional

ID for the transaction.

string

12.6.24. CreditInvRequest

Name Description Schema

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The global location number (13 characters).
Required unless merchantId is set.
Length : 13

string

items
optional

Items

< Item > array

merchantId
optional

The merchant ID as provided (1-36 characters).
Required unless globalLocationNumber is set.
Length : 1 - 36

string

orderNumber
optional

The order number.
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

paymentReference
optional

The payment reference from startSessionResponse. Required unless transactionReference is set.

string (uuid)

transactionReference
optional

The reference to the transactionId returned when adding an invoice. Required unless paymentReference is set.
Length : 10 - 40

string

12.6.25. CreditInvResponse

Name Schema

responseInfo
optional

ResponseInfo

result
required

InvResult

12.6.26. CustomerVerificationData

The customer verification data (CVD).

Name Description Schema

cryptogram
required

The cryptogram.
Must be base64 encoded.
Length : 1 - 3000
Pattern : "^[A-Za-z0-9+/=]*$"

string

nonce
required

The nonce.
Must be base64 encoded.
Length : 1 - 128
Pattern : "^[A-Za-z0-9+/=]*$"

string

signedData
required

The signed data.
Must be base64 encoded.
Length : 1 - 2000
Pattern : "^[A-Za-z0-9+/=]*$"

string

12.6.27. DefaultHttpStatusCode

Polymorphism : Composition

12.6.28. EncryptionKey

Identification of the encryption key. Mandatory if the identifier is encrypted

Name Description Schema

encryptionType
optional

The type of encryption used. Default value is DUKPT
Example : "RSAOAEP"

enum (DUKPT, RSAOAEP)

keyId
required

Identification of the key.
Minimum length : 1
Pattern : "^[A-Za-z0-9-_]{1,30}$"
Example : "SOME-COMPANY-TEST-V0"

string

12.6.29. GetInvoiceOptionsInvRequest

Name Description Schema

amount
optional

The amount to use when choosing between available invoice options

number

customerType
required

Customer type

enum (B2B, B2C)

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The global location number (13 characters).
Required unless merchantId is set.
Length : 13

string

merchantId
optional

The merchant ID as provided (1-36 characters).
Required unless globalLocationNumber is set.
Length : 1 - 36

string

orderNumber
optional

The order number.
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

paymentReference
optional

The payment reference from startSessionResponse. Required unless transactionReference is set.

string (uuid)

transactionReference
optional

The reference to the transactionId returned when adding an invoice. Required unless paymentReference is set.
Length : 10 - 40

string

12.6.30. GetInvoiceOptionsInvResponse

Name Description Schema

products
required

Products

< Product > array

responseInfo
optional

ResponseInfo

result
required

InvResult

12.6.31. HttpStatus

Polymorphism : Composition

12.6.32. Identifier

The Identifier. Used to validate user specific payment methods

Name Description Schema

authenticationLevel
optional

The authentication level according to the the eIDAS Regulation.

enum (ZERO_ASSURANCE, LOW_ASSURANCE, SUBSTANTIAL_ASSURANCE, HIGH_ASSURANCE)

bin
optional

A payment card’s BIN number (4-8 first digits)
Length : 4 - 8
Pattern : "^[0-9]{4,8}$"
Example : "12345678"

string

cardScheme
optional

The Card Scheme, mandatory when identifierType=PAY_CARD
Length : 0 - 25
Pattern : "^[a-zA-Z0-9\\s]*$"
Example : "VISA"

string

cardType
optional

The Card Type. Valid values:
C = Credit
D = Debit
P = Prepaid
U = Unknown
Example : "C"

enum (P, C, D, U)

defaultPaymentInstrument
optional

Indicates if the payment instrument is the default payment instrument in a wallet.

boolean

description
optional

A description for the identifier
Length : 0 - 255
Example : "My Visa Card"

string

encryptedValue
optional

Set if identifier is encrypted
Length : 0 - 512
Example : "vOXA9UnW…​BlhQ="

string

encryptionKey
optional

EncryptionKey

expirationDate
optional

Expiration date for a payment card. Format: MMYY
Length : 0 - 4
Pattern : "^(0[1-9]|1[0-2])[0-9]{2}$"
Example : "1221"

string

expirationLocalDate
optional

Expiration date for a payment method. Format: yyyy-MM-dd
Example : "2021-12-31"

string (date)

identifierId
optional

The unique id for an identifier
Length : 40
Pattern : "^[a-zA-Z0-9]+$"
Example : "f63a027e10…​0a15"

string

identifierType
required

The type of Identifier.
Example : "PAY_CARD"

enum (PAY_CARD, PAY_ACCOUNT, EMAIL, MOBILE_NUMBER, ADDITIONAL_ID, WALLET_REF, ACCOUNT_NUMBER, LOYALTY, SSN, SSN_ALIAS, PID, FREJA_EID, ID_DOCUMENT_SN, HASH)

identifierValue
required

A display safe description for the identifier. Will be masked in responses for ACCOUNT_NUMBER and PAY_CARD
Length : 0 - 255
Example : "…​7297"

string

originalIdentifierValue
optional

Original identifier description used when creating Identifier. For response only.
Length : 10 - 50
Example : "<usually not set>"

string

paymentAccountReference
optional

A Payment Account Reference (PAR) is an EMVCo standard value used to link tokenized and PAN-based transactions without PAN as the linkage mechanism. A PAR is 29 characters long. The first four characters of the PAR will contain BIN Controller Identifier. The remaining 25 characters are randomly assigned unique numbers.
Length : 29
Pattern : "^[a-zA-Z0-9]+$"

string

paymentInstrumentType
optional

The Payment Instrument Type (PIT), will be mandatory when identifierType=PAY_CARD
Length : 0 - 3
Pattern : "^[0-9]{2,3}$"
Example : "03"

string

12.6.33. InvResult

The result of the activate invoice transaction.

Name Description Schema

externalTransactionId
required

External ID for the transaction set in the request.
Minimum length : 1

string

merchantId
optional

The merchant ID.

string

paymentInstrumentType
optional

The PIT value for the payment instrument used.

string

paymentMethod
optional

The payment method used for the sale.

string

processor
optional

Payment processor.

string

transactionId
optional

ID for the transaction.

string

12.6.34. InvoicePaymentData

Invoice payment information

Name Description Schema

b2bInvoiceData
optional

B2BInvoiceData

clientIp
required

Customers IP Address
Minimum length : 1

string

customerType
required

Customer type

enum (B2B, B2C)

deliveryAddress
optional

Address

deliveryOption
optional

Indicate the delivery option - Default HOME_DELIVERY

enum (HOME_DELIVERY, PICKUP_IN_STORE)

invoiceAddress
optional

Address

items
required

Items

< Item > array

purchasePreview
optional

For Aera internal use only

< PurchasePreview > array

requireStrongCustomerVerification
optional

RequireStrongCustomerVerification - For future use

boolean

sendInvoice
optional

If set to true the invoice will be sent to the customer immediately and activateInvoice does not have to be called. Used for immediate delivery of goods.

boolean

supportedProducts
optional

Supported products

< enum (DI_001, CA_001, AN_6_001, AN_12_001, AN_24_001, AN_36_001, CAMPAIGN, IF_3_001, IF_6_001, IF_12_001) > array

12.6.35. InvoiceStatus

The status of the invoice

Type : enum (PENDING_CHECK, ACCEPTED, CANCELED, DELIVERED, EXPIRED, DECLINED, SIGNING, SCA, ACTIVATED, IN_DEBT, NOT_PAID, PARTIALLY_PAID, FULLY_PAID)

12.6.36. Item

Items

Name Description Schema

description
optional

Description of the item
Length : 0 - 50

string

grossAmount
optional

The price of the item including tax

number

itemId
optional

Identifier of the item
Length : 1 - 50

string

quantity
optional

Quantity, default 1

integer (int32)

quantityUnit
optional

Quantity unit, default "pc."
Length : 1 - 50

string

taxPercentage
optional

The tax percentage for the item

number

12.6.37. ModuleIdentifier

Set of identifiers (identifierValue and identifierType) to identify end-user.

Name Description Schema

identifierType
required

The type of the Identifier.

enum (ADDITIONAL_ID, EMAIL, LOYALTY, MOBILE_NUMBER, PID, SSN)

identifierValue
required

The value of the Identifier.
Length : 1 - 255

string

12.6.38. PartiallyActivateInvRequest

Name Description Schema

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The global location number (13 characters).
Required unless merchantId is set.
Length : 13

string

items
required

Items

< Item > array

merchantId
optional

The merchant ID as provided (1-36 characters).
Required unless globalLocationNumber is set.
Length : 1 - 36

string

orderNumber
optional

The order number.
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

paymentReference
optional

The payment reference from startSessionResponse. Required unless transactionReference is set.

string (uuid)

transactionReference
optional

The reference to the transactionId returned when adding an invoice. Required unless paymentReference is set.
Length : 10 - 40

string

12.6.39. PartiallyActivateInvResponse

Name Description Schema

invoiceUrl
required

The url to the invoice

string

newTransactionId
required

The new transaction number which must be used for future invoice actions

string

responseInfo
optional

ResponseInfo

result
required

InvResult

12.6.40. PaymentData

The elements found in Apple paymentData property of PKPaymentToken

Name Description Schema

data
required

The ApplePay data
Minimum length : 1

string

ephemeralPublicKey
required

The ApplePay ephemeral Public Key
Minimum length : 1

string

publicKeyHash
required

The ApplePay Public Key Hash
Minimum length : 1

string

signature
required

The ApplePay signature
Minimum length : 1

string

transactionData
optional

The ApplePay transaction data

string

transactionId
required

The ApplePay transaction id
Minimum length : 1

string

version
required

The ApplePay version
Minimum length : 1

string

12.6.41. PaymentExemptionRequest

Name Description Schema

acquirerId
optional

The merchant acquirer Id (1-36 characters).
Length : 1 - 36

string

authType
optional

The authorization type. Default PRE_AUTH

enum (PRE_AUTH, FINAL_AUTH, INCREMENTAL_AUTH)

authorizedMerchants
optional

List of authorized merchantIds in case of split revenue

< string > array

callbackInfo
optional

CallbackInfo

callbackUrl
optional

An optional callback URL to be used to trigger Window redirect instead of PostMessage.
Length : 0 - 255

string

country
required

The country code (ISO 3166-1 alpha-2).
Length : 2

string

currency
required

The currency code (ISO 4217 alpha-3).
Length : 3

string

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

grossAmount
required

The gross amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

identifierType
required

The type of the Identifier.

enum (PAY_CARD, PAY_ACCOUNT, EMAIL, MOBILE_NUMBER, ADDITIONAL_ID, WALLET_REF, ACCOUNT_NUMBER, LOYALTY, SSN, SSN_ALIAS, PID, FREJA_EID, ID_DOCUMENT_SN, HASH)

identifierValue
required

The value of the Identifier.
Length : 1 - 255

string

language
optional

Payment window language. Default 'no'

enum (no, en)

merchantId
required

The merchant ID as provided (1-36 characters).
Required unless globalLocationNumber is set.
Length : 1 - 36

string

netAmount
optional

The net amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

onlyCardFromWallet
optional

Setting this to true would only allow the user to pay with a card already stored in the wallet.

boolean

orderNumber
required

The order number (1-20 characters).
Length : 1 - 20

string

originatingSystem
optional

The originating system (1-20 characters).
Length : 1 - 20

string

paymentInstrumentIdentifierId
optional

The identifierId of the payment instrument to use. Required if useDefaultPaymentInstrument is not set to true.
Pattern : "^([A-Fa-f0-9+/]{40})$"

string

requireCvc
optional

Default: true. If set to false, the CVC input field is hidden.

boolean

scaExemption
required

SCAExemption

stylingOptions
optional

StylingOptions

taxAmount
optional

The VAT/tax amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

useDefaultPaymentInstrument
optional

If true the default payment instrument will be selected. Required if payment instrument id is not set.

boolean

12.6.42. PaymentExemptionResponse

Name Description Schema

appUrl
optional

The value of the APP url.
Length : 1 - 255

string

paymentReference
optional

The payment reference to use in Authorization.
Length : 1 - 36

string

responseInfo
optional

ResponseInfo

result
required

PaymentExemptionResult

12.6.43. PaymentExemptionResult

The result of the sales transaction.

Name Description Schema

acquirerMid
optional

The Acquirer MID

string

authorizationCode
optional

Applicable for card payments. The authorization code.

string

bankResponseCode
optional

The bank response code.

string

batchId
optional

The batchId from Acquirer where applicable

integer (int64)

cardType
optional

Applicable for card payments. CardType of the payment instrument used.
Values: 'C' = Credit, 'D' = Debit, 'P' = Prepaid 'U' = Unknown

string

expirationDate
optional

Applicable for card payments. Expiration date for the payment instrument used in the sale.

string

externalTransactionId
required

External ID for the transaction set in the request.
Minimum length : 1

string

maskedVPAN
optional

Masked VPAN (e.g. card number or account number) for the payment instrument used in the sale.

string

merchantId
optional

The merchant ID.

string

networkTransactionId
optional

The Network Transaction ID

string

paymentInstrumentType
optional

The PIT value for the payment instrument used.

string

paymentMethod
optional

The payment method used for the sale.

string

processor
optional

Payment processor.

string

stan
optional

The STAN from Acquirer where applicable

string

transactionId
optional

ID for the transaction.

string

12.6.44. PaymentInstrument

Prioritized list of payment instruments.

Name Description Schema

cardScheme
optional

The Card Scheme, mandatory when identifierType=PAY_CARD

string

cardType
optional

The Card Type. Valid values:
C = Credit
D = Debit
P = Prepaid
U = Unknown

enum (P, C, D, U)

defaultPaymentInstrument
required

Indicates if the payment instrument is the default payment instrument in a wallet.

boolean

description
optional

A description/name for the payment instrument.

string

expirationdate
optional

The expiration date of the payment instrument.

string (date)

identifierId
required

The unique id for an identifier

string

identifierType
required

The type of payment instrument (PAY_ACCOUNT or PAY_CARD).

string

identifierValue
required

A display safe value for the payment instrument.

string

paymentInstrumentType
optional

The Payment Instrument Type (PIT), will be mandatory when identifierType=PAY_CARD

string

priority
required

The payment instrument priority.
Highest priority is 1, and is the recommended payment instrument to use.
Priority is from 1 to N, where N is the number of payment instruments in the list.

integer (int32)

provider
optional

The provider of the identifier.
E.g. The providing bank of an account number.

string

12.6.45. PaymentInstrumentRequest

Name Schema

identifier
required

ModuleIdentifier

12.6.46. PaymentInstrumentResponse

Name Description Schema

consumerId
optional

string (uuid)

paymentInstruments
optional

Prioritized list of payment instruments.

< PaymentInstrument > array

responseInfo
optional

ResponseInfo

12.6.47. PaymentMethodsEnquiryRequest

Name Description Schema

globalLocationNumber
optional

The merchant global location number (13 characters).
Length : 13

string

identifier
optional

Identifier

merchantId
optional

The merchant Id (1-36 characters).
Length : 1 - 36

string

12.6.48. PaymentMethodsEnquiryResponse

Name Description Schema

paymentMethodList
optional

List of payment methods available to the merchant.
Example : "VISA, MASTERCARD"

< enum (VISA, MASTERCARD, AMEX, DINERS, MAESTRO, COOPCORP, IGIVEGK, IGIVEGS, IGIVEKK, IGIVEKS, IGIVEF, TRUMF, NGCORP, NGGIFT, COOPMC, INVOICE, WSP, VIPPS) > array

timeStamp
required

Time stamp. Mandatory
Example : "2021-12-21T10:23:19.279643Z"

string

12.6.49. PaymentRequest

Name Description Schema

acquirerId
optional

The merchant acquirer Id (1-36 characters).
Length : 1 - 36

string

authType
optional

The authorization type. Default PRE_AUTH

enum (PRE_AUTH, FINAL_AUTH, INCREMENTAL_AUTH)

authorizedMerchants
optional

List of authorized merchantIds in case of split revenue

< string > array

callbackInfo
optional

CallbackInfo

comment
optional

An optional comment related to why a cancel or refund i done. Used and displayed in the portal.
Length : 0 - 60

string

country
required

The country code (ISO 3166-1 alpha-2).
Length : 2

string

currency
required

The currency code (ISO 4217 alpha-3).
Length : 3

string

customerVerificationData
required

CustomerVerificationData

delayedCharge
optional

Indicates a delayed charge if set to true

boolean

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The merchant global location number (13 characters).
Length : 13

string

grossAmount
required

The gross amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

identifierType
optional

The type of the Identifier. Required unless customerVerificationData is set.

enum (PAY_CARD, PAY_ACCOUNT, EMAIL, MOBILE_NUMBER, ADDITIONAL_ID, WALLET_REF, ACCOUNT_NUMBER, LOYALTY, SSN, SSN_ALIAS, PID, FREJA_EID, ID_DOCUMENT_SN, HASH)

identifierValue
optional

The value of the Identifier. Required unless customerVerificationData is set.
Length : 1 - 255

string

merchantId
optional

The merchant Id (1-36 characters).
Length : 1 - 36

string

merchantInitiated
optional

Indicates a merchant initiated transaction

boolean

netAmount
required

The net amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

orderNumber
required

The order number (1-20 characters).
For refund requests this value must match the value from the original transaction.
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

originatingSystem
optional

The originating system (1-20 characters).
Length : 1 - 20

string

paymentInstrumentIdentifierId
optional

The identifierId of the payment instrument to use. Default payment instrument will be used if this parameter is not set.
Pattern : "^([A-Fa-f0-9+/]{40})$"

string

taxAmount
required

The VAT/tax amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

12.6.50. PaymentRequestApp

Name Description Schema

authorizedMerchants
optional

List of authorized merchantIds in case of split revenue

< string > array

currency
required

The currency code (ISO 4217 alpha-3).
Length : 3

string

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

grossAmount
required

The gross amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

netAmount
required

The net amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

paymentReference
required

The payment reference from StartSessionResponse.
Length : 1 - 36

string

taxAmount
required

The VAT/tax amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

12.6.51. PaymentRequestIncrementalAuth

Name Description Schema

acquirerId
optional

The merchant acquirer Id (1-36 characters).
Length : 1 - 36

string

authType
optional

enum (PRE_AUTH, FINAL_AUTH, INCREMENTAL_AUTH)

callbackInfo
optional

CallbackInfo

comment
optional

An optional comment related to why a cancel or refund i done. Used and displayed in the portal.
Length : 0 - 60

string

country
required

The country code (ISO 3166-1 alpha-2).
Length : 2

string

currency
required

The currency code (ISO 4217 alpha-3).
Length : 3

string

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The merchant global location number (13 characters).
Length : 13

string

grossAmount
required

The gross amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

merchantId
optional

The merchant Id (1-36 characters).
Length : 1 - 36

string

merchantInitiated
optional

boolean

netAmount
required

The net amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

orderNumber
required

The order number (1-20 characters).
For refund requests this value must match the value from the original transaction.
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

originatingSystem
optional

The originating system (1-20 characters).
Length : 1 - 20

string

paymentReference
optional

The payment reference from startSessionResponse, linking the original authorization

string (uuid)

taxAmount
required

The VAT/tax amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

transactionReference
optional

The reference to the transactionId from the original authorization
Length : 10 - 40

string

12.6.52. PaymentResponse

Name Description Schema

paymentReference
optional

Reference to the payment.

string (uuid)

responseInfo
optional

ResponseInfo

result
required

PaymentResult

12.6.53. PaymentResult

The result of the payment transaction.

Name Description Schema

acquirerMid
optional

The Acquirer MID

string

authorizationCode
optional

Applicable for card payments. The authorization code.

string

batchId
optional

The batchId from Acquirer where applicable

integer (int64)

cardType
optional

Applicable for card payments. CardType of the payment instrument used.
Values: 'C' = Credit, 'D' = Debit, 'P' = Prepaid 'U' = Unknown

string

expirationDate
optional

Applicable for card payments. Expiration date for the payment instrument used in the sale.

string

externalTransactionId
required

External ID for the transaction set in the request.
Minimum length : 1

string

maskedVPAN
optional

Masked VPAN (e.g. card number or account number) for the payment instrument used in the sale.

string

merchantId
optional

The merchant ID.

string

networkTransactionId
optional

The Network Transaction ID

string

paymentInstrumentType
optional

The PIT value for the payment instrument used.

string

paymentMethod
optional

The payment method used for the sale.

string

processor
optional

Payment processor.

string

stan
optional

The STAN from Acquirer where applicable

string

transactionId
optional

ID for the transaction.

string

12.6.54. PrePaidRequest

Name Description Schema

amount
required

The amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

callbackInfo
optional

CallbackInfo

currency
required

The currency code (ISO 4217 alpha-3).
Length : 3

string

cvc
optional

CVC number for prepaid non-PCI card.
Length : 3

string

expiry
required

Expiry date for prepaid non-PCI card.Expiration date in the format YYMMDD

string

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

merchantId
required

The merchant ID as provided (1-36 characters).
Required unless globalLocationNumber is set.
Length : 1 - 36

string

orderNumber
required

The order number (1-20 characters).
For refund requests this value must match the value from the original transaction.
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

prepaidCardNumber
required

Prepaid card number for non-PCI card.

string

12.6.55. Product

Products

Name Schema

calculation
optional

string

invoiceType
optional

integer (int32)

productCode
optional

string

productDescription
optional

string

purchasePreview
optional

PurchasePreview

12.6.56. PurchasePreview

For Aera internal use only

Name Schema

calculation
optional

string

campaignFee
optional

number

creditTime
optional

integer (int32)

dueDate
optional

string (date-time)

initialNotificationFee
optional

number

isAllowedToSendNotificationByEmail
optional

boolean

isAllowedToSendNotificationByMail
optional

boolean

lowestAmountToPay
optional

number

monthlyAmount
optional

number

originationFee
optional

number

productCode
optional

enum (DI_001, CA_001, AN_6_001, AN_12_001, AN_24_001, AN_36_001, CAMPAIGN, IF_3_001, IF_6_001, IF_12_001)

secondaryNotificationFee
optional

number

yearlyInterestRate
optional

number

12.6.57. RefundRequest

Name Description Schema

acquirerId
optional

The merchant acquirer Id (1-36 characters).
Length : 1 - 36

string

callbackInfo
optional

CallbackInfo

comment
optional

An optional comment related to why a cancel or refund i done. Used and displayed in the portal.
Length : 0 - 60

string

country
required

The country code (ISO 3166-1 alpha-2).
Length : 2

string

currency
required

The currency code (ISO 4217 alpha-3).
Length : 3

string

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

externalTransactionReference
optional

The reference to the externalTransactionId used in the original sale payment request.
Required if transactionReference is not available.
Length : 1 - 40

string

globalLocationNumber
optional

The merchant global location number (13 characters).
Length : 13

string

grossAmount
required

The gross amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

merchantId
optional

The merchant Id (1-36 characters).
Length : 1 - 36

string

netAmount
required

The net amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

orderNumber
required

The order number (1-20 characters).
For refund requests this value must match the value from the original transaction.
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

originatingSystem
optional

The originating system (1-20 characters).
Length : 1 - 20

string

taxAmount
required

The VAT/tax amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

transactionReference
optional

The reference to the transactionId returned in the sale payment response.
Required unless not available. Then use externalTransactionReference.
Length : 10 - 40

string

12.6.58. RefundResponse

Name Schema

responseInfo
optional

ResponseInfo

result
required

RefundResult

12.6.59. RefundResult

The result of the refund transaction.

Name Description Schema

externalTransactionId
required

External ID for the transaction set in the request.
Minimum length : 1

string

merchantId
optional

The merchant ID.

string

paymentInstrumentType
optional

The PIT value for the payment instrument used.

string

transactionId
optional

ID for the transaction.

string

12.6.60. ReplaceInvRequest

Name Description Schema

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The global location number (13 characters).
Required unless merchantId is set.
Length : 13

string

items
required

Items

< Item > array

merchantId
optional

The merchant ID as provided (1-36 characters).
Required unless globalLocationNumber is set.
Length : 1 - 36

string

orderNumber
optional

The order number.
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

paymentReference
optional

The payment reference from startSessionResponse. Required unless transactionReference is set.

string (uuid)

transactionReference
optional

The reference to the transactionId returned when adding an invoice. Required unless paymentReference is set.
Length : 10 - 40

string

12.6.61. ReplaceInvResponse

Name Schema

invoiceStatus
required

InvoiceStatus

responseInfo
optional

ResponseInfo

result
required

InvResult

12.6.62. ResponseInfo

Info object that can provide specific messages

Name Description Schema

externalResponseCode
optional

Additional response code from external systems.

string

message
optional

Specific response message

string

responseCode
required

Minimum length : 1

string

timeStamp
required

Timestamp. Mandatory
Minimum length : 1
Example : "2021-12-21T10:23:19.279Z"

string

12.6.63. SCAExemption

Setting this parameter the merchant asks for an SCA exemption to be used.

Name Schema

exemptionType
required

enum (LOW_VALUE_TRANSACTION)

12.6.64. SaleMitRequest

Name Description Schema

acquirerId
optional

The merchant acquirer Id (1-36 characters).
Length : 1 - 36

string

callbackInfo
optional

CallbackInfo

comment
optional

An optional comment related to why a cancel or refund i done. Used and displayed in the portal.
Length : 0 - 60

string

country
required

The country code (ISO 3166-1 alpha-2).
Length : 2

string

currency
required

The currency code (ISO 4217 alpha-3).
Length : 3

string

customerVerificationData
optional

CustomerVerificationData

delayedCharge
optional

Indicates a delayed charge if set to true. Applicable only if CVD is provided.

boolean

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The merchant global location number (13 characters).
Length : 13

string

grossAmount
required

The gross amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

identifierType
optional

The type of the Identifier. Required unless customerVerificationData is set.

enum (PAY_CARD, PAY_ACCOUNT, EMAIL, MOBILE_NUMBER, ADDITIONAL_ID, WALLET_REF, ACCOUNT_NUMBER, LOYALTY, SSN, SSN_ALIAS, PID, FREJA_EID, ID_DOCUMENT_SN, HASH)

identifierValue
optional

The value of the Identifier. Required unless customerVerificationData is set.
Length : 1 - 255

string

merchantId
optional

The merchant Id (1-36 characters).
Length : 1 - 36

string

netAmount
required

The net amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

orderNumber
required

The order number (1-20 characters).
For refund requests this value must match the value from the original transaction.
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

originatingSystem
optional

The originating system (1-20 characters).
Length : 1 - 20

string

paymentInstrumentIdentifierId
optional

The identifierId of the payment instrument to use.
Pattern : "^([A-Fa-f0-9+/]{40})$"

string

taxAmount
required

The VAT/tax amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

12.6.65. SendInvRequest

Name Description Schema

clientIp
required

Customers IP Address
Minimum length : 1

string

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The global location number (13 characters).
Required unless merchantId is set.
Length : 13

string

invoiceDeliveryMethod
required

Invoice delivery method

enum (POST, EMAIL, BOTH)

merchantId
optional

The merchant ID as provided (1-36 characters).
Required unless globalLocationNumber is set.
Length : 1 - 36

string

orderNumber
optional

The order number.
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

paymentReference
optional

The payment reference from startSessionResponse. Required unless transactionReference is set.

string (uuid)

transactionReference
optional

The reference to the transactionId returned when adding an invoice. Required unless paymentReference is set.
Length : 10 - 40

string

12.6.66. SendInvResponse

Name Description Schema

invoiceUrl
required

The url to the invoice

string

responseInfo
optional

ResponseInfo

result
required

InvResult

12.6.67. SetOrderNumberRequest

Name Description Schema

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The global location number (13 characters).
Required unless merchantId is set.
Length : 13

string

merchantId
optional

The merchant ID as provided (1-36 characters).
Required unless globalLocationNumber is set.
Length : 1 - 36

string

orderNumber
optional

The order number.
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

paymentReference
optional

The payment reference from startSessionResponse. Required unless transactionReference is set.

string (uuid)

transactionReference
optional

The reference to the transactionId returned when adding an invoice. Required unless paymentReference is set.
Length : 10 - 40

string

12.6.68. SetOrderNumberResponse

Name Schema

responseInfo
optional

ResponseInfo

12.6.69. SettlementDetailsRequest

Name Description Schema

batchId
optional

The batchId.

integer (int64)

globalLocationNumber
optional

The merchant global location number (13 characters).
Length : 13

string

merchantId
optional

The merchant Id (1-36 characters).
Length : 1 - 36

string

12.6.70. SettlementDetailsResponse

Name Schema

creditAmount
optional

integer (int64)

creditCount
optional

integer (int64)

creditReversalAmount
optional

integer (int64)

creditReversalCount
optional

integer (int64)

debitAmount
optional

integer (int64)

debitCount
optional

integer (int64)

debitReversalAmount
optional

integer (int64)

debitReversalCount
optional

integer (int64)

12.6.71. SettlementRequest

Name Description Schema

batchId
optional

The batchId.

integer (int64)

globalLocationNumber
optional

The merchant global location number (13 characters).
Length : 13

string

merchantId
optional

The merchant Id (1-36 characters).
Length : 1 - 36

string

12.6.72. StartAddCardSessionRequest

Name Description Schema

callbackUrl
optional

An optional callback URL to be used to trigger Window redirect instead of PostMessage.
Length : 0 - 255

string

customStylingUrl
optional

Custom css file sent in from a web URL which styles Identity Module after merchant preference
Length : 0 - 255
Pattern : "^?<Protocol>https?):\\/\\/(?<Domain>[\\w.:-]+)(?<Path>\\/?[\\w\\/-]*\\/)(?<Filename>[\\w\\/-]+.css?$"

string

identifiers
required

Set of identifiers (identifierValue and identifierType) to identify end-user.

< ModuleIdentifier > array

locale
optional

Locale language for displayed text. Default is "en".

enum (en, no)

stylingOptions
optional

StylingOptions

12.6.73. StartAddCardSessionResponse

Name Description Schema

appUrl
optional

The value of the APP url.
Length : 1 - 255

string

responseInfo
optional

ResponseInfo

sessionId
optional

The session id identifying the session.

string (uuid)

12.6.74. StartSessionRequest

Name Description Schema

acquirerId
optional

The merchant acquirer Id (1-36 characters).
Length : 1 - 36

string

appActionType
optional

The action to perform in payment window.

enum (CARD_AUTH, CARD_VERIFY)

authType
optional

The authorization type. Default PRE_AUTH

enum (PRE_AUTH, FINAL_AUTH, INCREMENTAL_AUTH)

authorizedMerchants
optional

List of authorized merchantIds in case of split revenue

< string > array

callbackInfo
optional

CallbackInfo

callbackUrl
optional

An optional callback URL to be used to trigger Window redirect instead of PostMessage.
Length : 0 - 255

string

comment
optional

An optional comment related to why a cancel or refund i done. Used and displayed in the portal.
Length : 0 - 60

string

country
required

The country code (ISO 3166-1 alpha-2).
Length : 2

string

currency
required

The currency code (ISO 4217 alpha-3).
Length : 3

string

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The merchant global location number (13 characters).
Length : 13

string

grossAmount
required

The gross amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

identifierType
optional

The type of the Identifier.

enum (PAY_CARD, PAY_ACCOUNT, EMAIL, MOBILE_NUMBER, ADDITIONAL_ID, WALLET_REF, ACCOUNT_NUMBER, LOYALTY, SSN, SSN_ALIAS, PID, FREJA_EID, ID_DOCUMENT_SN, HASH)

identifierValue
optional

The value of the Identifier.
Length : 1 - 255

string

invoicePaymentData
optional

InvoicePaymentData

language
optional

Payment window language. Default 'no'

enum (no, en)

merchantId
optional

The merchant Id (1-36 characters).
Length : 1 - 36

string

merchantInitiated
optional

Enables WSP payments if set to true.

boolean

netAmount
required

The net amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

oneClick
optional

This requires an activated Aera product to work, and potentially a special agreement with the Acquirer.

boolean

onlyCardFromWallet
optional

Setting this to true would only allow the user to pay with a card already stored in the wallet. Requires an Identifier as input and Card on File product activated.

boolean

orderNumber
required

The order number (1-20 characters).
For refund requests this value must match the value from the original transaction.
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

originatingSystem
optional

The originating system (1-20 characters).
Length : 1 - 20

string

paymentInstrumentIdentifierId
optional

Preset payment instrument

string

paymentMethodList
optional

List of payment methods to enable for this session. The methods available for your merchant is defined in the acquirer agreement.
Example : "VISA, MASTERCARD"

< enum (VISA, MASTERCARD, AMEX, DINERS, MAESTRO, COOPCORP, IGIVEGK, IGIVEGS, IGIVEKK, IGIVEKS, IGIVEF, TRUMF, NGCORP, NGGIFT, COOPMC, INVOICE, WSP, VIPPS) > array

scaExemption
optional

SCAExemption

stylingOptions
optional

StylingOptions

taxAmount
required

The VAT/tax amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

transactionText
optional

A transaction description. Used if supported by the selected payment method
Length : 0 - 100

string

useDefaultPaymentInstrument
optional

If true the default payment instrument will be selected. Required if payment instrument id is not set.

boolean

wspId
optional

The WSP id for WSP payment.

integer (int32)

wspRedirectUrl
optional

The WSP MPA will redirect the end user to this URL after the MPA has finished interaction with the end user
Length : 0 - 255

string

12.6.75. StartSessionResponse

Name Description Schema

appUrl
optional

The value of the APP url.
Length : 1 - 255

string

paymentReference
optional

The payment reference to use in Authorization.
Length : 1 - 36

string

responseInfo
optional

ResponseInfo

12.6.76. Status

Name Schema

description
optional

string

status
optional

string

12.6.77. StatusInvResponse

Name Schema

responseInfo
optional

ResponseInfo

status
required

InvoiceStatus

12.6.78. StatusResponse

Name Schema

responseInfo
optional

ResponseInfo

statusList
optional

< TransactionStatus > array

12.6.79. StylingOptions

Styling options for the payment window

Name Description Schema

customerStyling
optional

Customer styling applied if set to true and customer styling is defined

boolean

stylingProfile
optional

The common styling profile

enum (COMMON_HPP, CONTRAST, CONTRAST_NO_MOBILE_HEADER)

12.6.80. TransactionInfo

Name Schema

amount
optional

integer (int64)

status
optional

string

timeStamp
optional

string

transactionId
optional

string

transactionText
optional

string

12.6.81. TransactionStatus

Name Schema

amount
optional

number

authorizationCode
optional

string

bankResponseCode
optional

string

maskedPan
optional

string

message
optional

string

nativeBankResponseCode
optional

string

networkTransactionId
optional

string

paymentInstrumentType
optional

string

paymentReference
optional

string

paymentScheme
optional

string

paymentType
optional

string

responseCode
optional

string

stan
optional

string

status
optional

InvoiceStatus

transactionId
optional

string

transactionState
optional

enum (STARTED, PROCESSING, SIGNATURE_REQUESTED, SIGNATURE_RECEIVED, PAYMENT_WINDOW_LOADED, PAYMENT_WINDOW_REFRESHED_OR_KILLED, PAYMENT_METHOD_SELECTED, AUTHORIZED_SUCCESS, AUTHORIZED_FAILED, SALE_SUCCESS, SALE_FAILED, USER_CANCELLED, REJECTED, TIMEDOUT, COMPLETED, UNKNOWN, INVALID_SIGNATURE)

transactionType
optional

enum (CardAuthCap, AccountAuthCap, Refund, AccountRefund, CardAuthorize, AccountAuthorize, CardReAuthorize, CardAuthInc, Capture, Collect, AccountCapture, AccountCollect, CreatePendingPayment, GetPepStatus, CheckoutStartSession, Authorize, CardVerify, Void, AccountCancel, AddInvoice, CancelInvoice, ReplaceInvoice, ActivateInvoice, PartActivateInvoice, CreditInvoice, PartCreditInvoice, AdjustInvoice, SendInvoice, VippsAuth, VippsCancel, VippsCapture, VippsRefund, VippsVoid, SetInvoiceOrderNumber, BankAxeptCardAuthCap, BankAxeptRefund)

12.6.82. TransactionSummary

Name Schema

bankIdentificationNumber
optional

integer (int64)

capturedAmount
optional

integer (int64)

refundedAmount
optional

integer (int64)

remainingAmountToCapture
optional

integer (int64)

remainingAmountToRefund
optional

integer (int64)

12.6.83. WalletPaymentRequest

Name Description Schema

acquirerId
optional

The merchant acquirer Id (1-36 characters).
Length : 1 - 36

string

async
optional

Only asynchronous requests are supported - Default TRUE

boolean

authType
optional

The authorization type. Default PRE_AUTH

enum (PRE_AUTH, FINAL_AUTH, INCREMENTAL_AUTH)

authorizedMerchants
optional

List of authorized merchantIds in case of split revenue

< string > array

callbackInfo
optional

CallbackInfo

callbackUrl
optional

Required if async is set to true

string

comment
optional

An optional comment related to why a cancel or refund i done. Used and displayed in the portal.
Length : 0 - 60

string

country
required

The country code (ISO 3166-1 alpha-2).
Length : 2

string

currency
required

The currency code (ISO 4217 alpha-3).
Length : 3

string

delayedCharge
optional

Indicates a delayed charge if set to true

boolean

externalTransactionId
required

The external transaction ID (1-40 characters).
A unique reference set by the merchant.
Length : 1 - 40

string

globalLocationNumber
optional

The merchant global location number (13 characters).
Length : 13

string

grossAmount
required

The gross amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

identifierType
required

The type of the Identifier. Required unless customerVerificationData is set.

enum (PAY_CARD, PAY_ACCOUNT, EMAIL, MOBILE_NUMBER, ADDITIONAL_ID, WALLET_REF, ACCOUNT_NUMBER, LOYALTY, SSN, SSN_ALIAS, PID, FREJA_EID, ID_DOCUMENT_SN, HASH)

identifierValue
required

The value of the Identifier. Required unless customerVerificationData is set.
Length : 1 - 255

string

merchantId
optional

The merchant Id (1-36 characters).
Length : 1 - 36

string

merchantInitiated
optional

Indicates a merchant initiated transaction

boolean

netAmount
required

The net amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

orderNumber
required

The order number (1-20 characters).
For refund requests this value must match the value from the original transaction.
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-%]+$"

string

originatingSystem
optional

The originating system (1-20 characters).
Length : 1 - 20

string

paymentInstrumentIdentifierId
optional

The identifierId of the payment instrument to use. Default payment instrument will be used if this parameter is not set.
Pattern : "^([A-Fa-f0-9+/]{40})$"

string

taxAmount
required

The VAT/tax amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

wspRedirectUrl
optional

The WSP MPA will redirect the end user to this URL after the MPA has finished interaction with the end user
Length : 0 - 255

string

13. Wallet Service Provider Gateway (WSPGW)

Service paths and model definition for the WSPGW

13.1. What is Wallet Service Provider Gateway (WSPGW)

The WSPGW is a gateway enabling communication with configured Wallet Service Providers. A Wallet Service Provider has implemented a set of services being utilized by the WSPGW to perform for example a signed payment.
This documentation focuses mainly on how to use the Aera Payment Page and some of the more important API endpoints.

13.2. Interaction between Wallet Service Provider (WSP) and WSPGW

WSP integration with the WSPGW contains the following main steps:
1) WSP must receive an initiation request from the WSPGW at an endpoint defined during provisioning of the WSP in the WSPGW configuration. See Initiate WSP transaction
2) WSP must interact with the customer in order to collect a signature.
3) WSP must call the callback endpoint in WSPGW providing the signature for the transaction. See Callback to WSPGW
4) WSPGW will validate signature and complete requested actions.
5) WSP must receive a status request from the WSPGW at an endpoint defined during provisioning of the WSP in the WSPGW configuration. See Status of WSP initiated transaction

13.2.1. High level sequence diagram

The following diagram shows the a typical use case for where the Wallet Service Provider Gateway as part of Aera is being utlized to perform a payment transaction toward a specific Wallet Service Provider signing the payment transaction.

WSPGW APS sequence diagram
Figure 26. Wallet Service Provider Gateway sequence diagram initiated by APS

13.3. Paths

Descriptions of resources/paths in the service.

13.3.1. Callback signature result from Wallet Provider

POST /wspgw/wallet/callback
Description

Callback signature result

Parameters
Type Name Description Schema

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : WalletSignResultRequest

Responses
HTTP Code Description Schema

200

OK

WalletSignResultResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Wallet API

Example HTTP request
POST /wspgw/wallet/callback HTTP/1.1
Content-Type: application/json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiLCJ3c3Bnd1dhbGxldENhbGxiYWNrIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDMsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.YG3KFVuvu_9-5WYhtf3eW_ToEtyMf8VTUuZrsbGJ8tJNsDaqwEEXPT1M9Dj6POpvp8jjC2kEJxwObbUrqlk_F3eP-COiK5svcXiiJcGlqP5Q747A9JAGxL2DIwOUZfM7PbZDFZSzLQ3_KiTzpCrM6PUBUWUJrNt1QNOuVsU7z8M
Accept: application/json
Content-Length: 303
Host: api.aerahost.com

{
  "resultCode" : "0",
  "signTransactionId" : "d99cdd1c-c1ad-4655-8092-85ca0d1d6ee4",
  "userResponse" : "ACCEPTED",
  "signMethod" : "AERASECUREID",
  "signatureInfo" : {
    "signature" : "VGhpcyBpcyB0aGUgc2lnbmF0dXJlIGdlbmVyYXRlZCBieSBTREs="
  },
  "paymentRef" : "<Payment instrument reference>"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: iPx3Hn3wpJCvtSe23SLrXIW1Dn2HfJc+oduoeY1NpDQ9UnXDRpNJkyxxohkNfsGfzcgqKAF03wN6TzR5StSzEG49D0bmeBdi/d33cgr5inqRZHA8m43OZWDfOlIFp4sjX6DE9PZhK7OkNnfek4A9I2WimKbkGpW1Pl/eumYFfqzZZOEHrUUqMfdiO0f/w4o8uba6wKxoce0Vuhrms6faEpWMXKJH+bYz0OBWfGOsG2ZQ9UisIVa3oSyNGpFdjJPG26yU3JukMeakcN/LjgR1nborlMrP3rfuf1cByagre2mbzZtoj1DGEDSXlGuk3YljLpgrm7IRMdoYr3zoNO0CMQ==
Content-Length: 526

{
  "responseInfo" : {
    "responseCode" : "0",
    "timeStamp" : "2025-06-13T07:38:35.006Z"
  },
  "signTransactionId" : "d99cdd1c-c1ad-4655-8092-85ca0d1d6ee4",
  "responseType" : "PAYMENT",
  "walletSignatureValidationResult" : {
    "signatureValid" : true,
    "responseCode" : "0",
    "message" : "OK"
  },
  "signInfo" : {
    "parameters" : {
      "merchantName" : "The Shop"
    }
  },
  "signData" : {
    "parameters" : {
      "amount" : "2000",
      "merchantId" : "P1000",
      "currency" : "NOK"
    }
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/wspgw/wallet/callback' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiLCJ3c3Bnd1dhbGxldENhbGxiYWNrIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDMsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.YG3KFVuvu_9-5WYhtf3eW_ToEtyMf8VTUuZrsbGJ8tJNsDaqwEEXPT1M9Dj6POpvp8jjC2kEJxwObbUrqlk_F3eP-COiK5svcXiiJcGlqP5Q747A9JAGxL2DIwOUZfM7PbZDFZSzLQ3_KiTzpCrM6PUBUWUJrNt1QNOuVsU7z8M' \
    -H 'Accept: application/json' \
    -d '{
  "resultCode" : "0",
  "signTransactionId" : "d99cdd1c-c1ad-4655-8092-85ca0d1d6ee4",
  "userResponse" : "ACCEPTED",
  "signMethod" : "AERASECUREID",
  "signatureInfo" : {
    "signature" : "VGhpcyBpcyB0aGUgc2lnbmF0dXJlIGdlbmVyYXRlZCBieSBTREs="
  },
  "paymentRef" : "<Payment instrument reference>"
}'

13.3.2. Inform the wallet provider to get a user signature

POST /wspgw/wsp/initWalletSign
Description

InitWalletSign

Body parameter

Name : body
Flags : required
Type : InitWalletSignRequest

Responses
HTTP Code Description Schema

200

OK

InitWalletSignResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • wsp-in-a-small-box

Example HTTP request
POST /wspgw/wsp/initWalletSign HTTP/1.1
Content-Type: application/json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiLCJ3c3Bnd1dhbGxldENhbGxiYWNrIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDMsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.YG3KFVuvu_9-5WYhtf3eW_ToEtyMf8VTUuZrsbGJ8tJNsDaqwEEXPT1M9Dj6POpvp8jjC2kEJxwObbUrqlk_F3eP-COiK5svcXiiJcGlqP5Q747A9JAGxL2DIwOUZfM7PbZDFZSzLQ3_KiTzpCrM6PUBUWUJrNt1QNOuVsU7z8M
Accept: application/json
Content-Length: 985
Host: api.aerahost.com

{
  "user" : {
    "idType" : "WALLETID",
    "userId" : "465444751"
  },
  "operation" : "PAYMENT",
  "signInfo" : {
    "parameters" : {
      "merchantId" : "S055586",
      "currency" : "NOK",
      "grossAmount" : "10111",
      "type" : "RESERVATION",
      "merchantName" : "le merchante"
    }
  },
  "signData" : {
    "parameters" : {
      "toBeSigned" : "IJFDSBUFDU2893289HR32NOFEMØF",
      "nonce" : "MTEzMmJhOTAtjMtZDkzNWU0N2YxN2Jl"
    }
  },
  "callbackUrl" : "https://api-staging.aerahost.com/wspgw/wallet/callback",
  "paymentSchemas" : [ "VISA" ],
  "paymentInstruments" : [ {
    "identifierId" : "6fb42be08598e1ba3fef58bce46c29d5",
    "identifierType" : "PAY_CARD",
    "identifierValue" : "************6954",
    "priority" : 2,
    "expirationdate" : "2025-06-13",
    "cardScheme" : "VISA",
    "paymentInstrumentType" : "03",
    "cardType" : "P",
    "defaultPaymentInstrument" : true
  } ],
  "signTransactionId" : "d99cdd1c-c1ad-4655-8092-85ca0d1d6ee4"
}
Example HTTP response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: c/gFqFhevgGSd30+g3QjxGHpJ0W/Cr4prWGNHrC64Cn1vfzPQEEPL6b68JRT8NNZkBpvGrmgTuJpxPPkbVO4A6+uy/ZwjIEglLX0gganTvhvOOVMogd/HDezteL5qEeSVK7QXRW30XJNQ2M/xsSjK+MPAtvMYs2J2rPO9kngwSYhOpnJRVY9BigxphTE85ilmvS4pRKVcVkZ6mze+VS8pYxWege7RMYLOPN/yGcAYNWt49+B33yYCEtAvDHzgGoWjutlhEWhacg3kjcPgN0UNcJjqviD2g22aVNTcF9W20OpyND3oJui0ab5epkSQHivcDlsSVQZprArnk0S7yU6oA==
Content-Length: 90

{
  "resultCode" : "0",
  "walletTransactionId" : "d99cdd1c-c1ad-4655-8092-85ca0d1d6ee4"
}
Example Curl request
$ curl 'https://api.aerahost.com/wspgw/wsp/initWalletSign' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiLCJ3c3Bnd1dhbGxldENhbGxiYWNrIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDMsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.YG3KFVuvu_9-5WYhtf3eW_ToEtyMf8VTUuZrsbGJ8tJNsDaqwEEXPT1M9Dj6POpvp8jjC2kEJxwObbUrqlk_F3eP-COiK5svcXiiJcGlqP5Q747A9JAGxL2DIwOUZfM7PbZDFZSzLQ3_KiTzpCrM6PUBUWUJrNt1QNOuVsU7z8M' \
    -H 'Accept: application/json' \
    -d '{
  "user" : {
    "idType" : "WALLETID",
    "userId" : "465444751"
  },
  "operation" : "PAYMENT",
  "signInfo" : {
    "parameters" : {
      "merchantId" : "S055586",
      "currency" : "NOK",
      "grossAmount" : "10111",
      "type" : "RESERVATION",
      "merchantName" : "le merchante"
    }
  },
  "signData" : {
    "parameters" : {
      "toBeSigned" : "IJFDSBUFDU2893289HR32NOFEMØF",
      "nonce" : "MTEzMmJhOTAtjMtZDkzNWU0N2YxN2Jl"
    }
  },
  "callbackUrl" : "https://api-staging.aerahost.com/wspgw/wallet/callback",
  "paymentSchemas" : [ "VISA" ],
  "paymentInstruments" : [ {
    "identifierId" : "6fb42be08598e1ba3fef58bce46c29d5",
    "identifierType" : "PAY_CARD",
    "identifierValue" : "************6954",
    "priority" : 2,
    "expirationdate" : "2025-06-13",
    "cardScheme" : "VISA",
    "paymentInstrumentType" : "03",
    "cardType" : "P",
    "defaultPaymentInstrument" : true
  } ],
  "signTransactionId" : "d99cdd1c-c1ad-4655-8092-85ca0d1d6ee4"
}'

13.3.3. Inform the wallet provider about the result of the transaction

POST /wspgw/wsp/walletStatus
Description

WalletStatus

Body parameter

Name : body
Flags : required
Type : WSPStatusRequest

Responses
HTTP Code Description Schema

200

OK

No Content
Consumes

  • application/json

Tags

  • wsp-in-a-small-box

Example HTTP request
POST /wspgw/wsp/walletStatus HTTP/1.1
Content-Type: application/json;charset=UTF-8
x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiLCJ3c3Bnd1dhbGxldENhbGxiYWNrIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDMsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.YG3KFVuvu_9-5WYhtf3eW_ToEtyMf8VTUuZrsbGJ8tJNsDaqwEEXPT1M9Dj6POpvp8jjC2kEJxwObbUrqlk_F3eP-COiK5svcXiiJcGlqP5Q747A9JAGxL2DIwOUZfM7PbZDFZSzLQ3_KiTzpCrM6PUBUWUJrNt1QNOuVsU7z8M
Accept: application/json
Content-Length: 108
Host: api.aerahost.com

{
  "resultCode" : "RESERVATION_COMPLETED",
  "signTransactionId" : "d99cdd1c-c1ad-4655-8092-85ca0d1d6ee4"
}
Example HTTP response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: VSup1aQsmxnI/vPUYLmkf5VtcZHaxyiY6Qw04gVoo1ZFN8u78t7pv21rXgRZwxyIWHw10RrDH0HhHkZE6tM3uJIiXvgUWvYBdyo0gooBDU/JkfCt38DbsV01MJf7C1ltR+KmMV4Nlpx4o/kA5bBsAGNLj/l2UksINKfRRdqfrFmaSZjWACiOv3p+W9q5Uuh9zV9KJxLEoVABF/LPcmGXW6zJYXm1i/TnZef5tuhz/kkklW+9PPCzUJruqMoutHzM0uLS5z2bvVjtRPyJ60CIc+r82Sxa0mxnn9vnTg8/jgF4MF0zgXuxAtphoqntaMg2Aznmxou39LazdPQbm2d2vA==
Example Curl request
$ curl 'https://api.aerahost.com/wspgw/wsp/walletStatus' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'x-api-key: 0kljhasf9823hkjhsdf978234hkjhsfsds8GasGy' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic3ViIjoiMTIzNDU2Nzg5MCIsInNjb3BlIjpbImFsbFBheW1lbnQiLCJ3c3Bnd1dhbGxldENhbGxiYWNrIl0sImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTUyNDcyODE4OSwiaWF0IjoxNTI0NzI4MTg5LCJleHAiOjk5ODM0MTE5MDMsImp0aSI6IjJkNjViNGE5LTlhOTYtNDlhZi1iMjdiLWU1YTM5M2IzMGY3NSJ9.YG3KFVuvu_9-5WYhtf3eW_ToEtyMf8VTUuZrsbGJ8tJNsDaqwEEXPT1M9Dj6POpvp8jjC2kEJxwObbUrqlk_F3eP-COiK5svcXiiJcGlqP5Q747A9JAGxL2DIwOUZfM7PbZDFZSzLQ3_KiTzpCrM6PUBUWUJrNt1QNOuVsU7z8M' \
    -H 'Accept: application/json' \
    -d '{
  "resultCode" : "RESERVATION_COMPLETED",
  "signTransactionId" : "d99cdd1c-c1ad-4655-8092-85ca0d1d6ee4"
}'

13.4. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

13.4.1. InitWalletSignRequest

Name Description Schema

callbackUrl
optional

string

operation
required

Why signature is needed

enum (PAYMENT, ACCESS, OTHER)

paymentInstruments
optional

< PaymentInstrument > array

paymentSchemas
optional

List of payment schemas accepted by Merchant. If operation is payment this is mandatory

< enum (BANKAXEPT, VISA, MASTERCARD, AMEX, DINERS, DISCOVER, JCB, MAESTRO, CUP, COOPCORP, COOPVISA, COOPMC, TRUMF) > array

signData
required

SignData

signInfo
optional

SignInfo

signTransactionId
required

Id on the signature transaction

string

user
required

WalletUser

userTimeout
optional

integer (int32)

13.4.2. InitWalletSignResponse

Name Description Schema

errorCode
optional

Error code from Wallet Provider
Pattern : "^[0-9A-Za-z]{1,16}$"

string

errorMessage
optional

Error message from Wallet Provider

string

resultCode
optional

Result code from Wallet Provider
Pattern : "^[0-9A-Za-z]{1,16}$"

string

targetDeviceName
required

The device name of the target computerized unit

string

walletTransactionId
optional

Wallets Providers id on the sign task
Pattern : "^[0-9A-Za-z]{1,16}$"

string

13.4.3. SignData

Data to be signed

Name Description Schema

parameters
optional

Parameters that must be signed

< string, string > map

13.4.4. SignInfo

Information on the signature

Name Description Schema

parameters
required

Extra parameters

< string, string > map

13.4.5. SignatureInfo

Signature

Name Description Schema

signature
required

B64 encoded signature

string

13.4.6. WSPStatusRequest

Name Schema

redirectUrl
optional

string

responseInfo
optional

ResponseInfo

resultCode
required

enum (RESERVATION_COMPLETED, CAPTURE_COMPLETED, SALE_COMPLETED, TRANSACTION_FAILED, CANCELLED_BY_CASHIER)

signTransactionId
required

string (uuid)

13.4.7. WalletSignResultRequest

Name Description Schema

errorCode
optional

Error code from Wallet Provider

string

errorMessage
optional

Error message from Wallet Provider

string

paymentRef
optional

Reference to payment.

string

resultCode
optional

Result code from Wallet Provider
Pattern : "^[0-9A-Za-z]{1,16}$"

string

signMethod
optional

What has been used to sign the data

enum (AERASECUREID)

signTransactionId
required

Id on the signature transaction

string (uuid)

signatureInfo
optional

SignatureInfo

userResponse
optional

User response

string

13.4.8. WalletSignResultResponse

Name Description Schema

responseInfo
optional

ResponseInfo

responseType
required

What system is responseCode from

string

signData
optional

SignData

signInfo
optional

SignInfo

signTransactionId
required

Id on the signature transaction
Pattern : "^[0-9A-Za-z]{1,16}$"

string

walletSignatureValidationResult
optional

WalletSignatureValidationResult

13.4.9. WalletSignatureValidationResult

Signature verification result

Name Description Schema

message
optional

Response message

string

responseCode
required

Response code on operation performed

string

signatureValid
optional

Result of signature verification

boolean

14. APS portal backend

Service paths and model definition for the API APS Portal backend

14.1. Paths

Descriptions of resources/paths in the service.

14.1.1. Enroll merchant

POST /aps-map/portal/amap/merchant/enroll/{merchantId}
Description

Enrolls a merchant for ePayment

Parameters
Type Name Schema

Path

merchantId
required

string
Responses
HTTP Code Description Schema

200

OK

ApsMerchantResponse

400

Bad Request

ErrorResponse
Produces

  • application/json

  • application/octet-stream

Tags

  • Merchant

14.1.2. Add eCom product to a merchant

POST /aps-map/portal/amap/merchant/product
Description

Adds a product to a merchant

Body parameter

Name : body
Flags : required
Type : ProductRequest

Responses
HTTP Code Description Schema

200

OK

ProductResponse

400

Bad Request

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

  • application/octet-stream

Tags

  • Products

14.1.3. Remove eCom product from a merchant

PATCH /aps-map/portal/amap/merchant/product
Description

Removes/deactivates a product for a merchant

Body parameter

Name : body
Flags : required
Type : ProductRequest

Responses
HTTP Code Description Schema

200

OK

ProductResponse

400

Bad Request

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

  • application/octet-stream

Tags

  • Products

14.1.4. Get merchant details

GET /aps-map/portal/amap/merchant/{merchantId}
Description

Get merchant details

Parameters
Type Name Schema

Path

merchantId
required

string
Responses
HTTP Code Description Schema

200

OK

ApsMerchantResponse

400

Bad Request

ErrorResponse
Produces

  • application/json

  • application/octet-stream

Tags

  • Merchants

14.1.5. Update merchant

PATCH /aps-map/portal/amap/merchant/{merchantId}
Description

Updates a existing merchant

Parameters
Type Name Schema

Path

merchantId
required

string
Body parameter

Name : body
Flags : required
Type : ApsMerchantUpdateRequest

Responses
HTTP Code Description Schema

200

OK

CmsMerchantResponse

400

Bad Request

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

  • application/octet-stream

Tags

  • Merchants

14.1.6. Get Acquirer Info

GET /aps-map/portal/amap/paymentService/acquirerInfo/{merchantId}
Description

Get Acquirer Info

Parameters
Type Name Schema

Path

merchantId
required

string
Responses
HTTP Code Description Schema

200

OK

AcquirerUserInfoResponse

400

Bad Request

ErrorResponse
Produces

  • application/json

  • application/octet-stream

Tags

  • Services

14.1.7. Add PaymentService

POST /aps-map/portal/amap/paymentService/add/{merchantId}
Description

Add new Payment Service

Parameters
Type Name Schema

Path

merchantId
required

string
Body parameter

Name : body
Flags : required
Type : PaymentServiceRequest

Responses
HTTP Code Description Schema

201

Created

PaymentServiceResponse

400

Bad Request

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

  • application/octet-stream

Tags

  • Services

14.1.8. Get PaymentServices

GET /aps-map/portal/amap/paymentService/list/{merchantId}
Description

Get a merchants PaymentServices list

Parameters
Type Name Schema

Path

merchantId
required

string
Responses
HTTP Code Description Schema

200

OK

PaymentServiceResponse

400

Bad Request

ErrorResponse
Produces

  • application/json

  • application/octet-stream

Tags

  • Services

14.1.9. Update PaymentService status

PATCH /aps-map/portal/amap/paymentService/status
Description

Update status on a Payment Service

Body parameter

Name : body
Flags : required
Type : PaymentServiceStatusRequest

Responses
HTTP Code Description Schema

200

OK

PaymentServiceResponse

400

Bad Request

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

  • application/octet-stream

Tags

  • Services

14.1.10. Get PaymentService

GET /aps-map/portal/amap/paymentService/{serviceId}
Description

Get a PaymentServices details

Parameters
Type Name Schema

Path

serviceId
required

string
Responses
HTTP Code Description Schema

200

OK

PaymentServiceResponse

400

Bad Request

ErrorResponse
Produces

  • application/json

  • application/octet-stream

Tags

  • Services

14.1.11. Update PaymentService

PUT /aps-map/portal/amap/paymentService/{serviceId}
Description

Update a Payment Service

Parameters
Type Name Schema

Path

serviceId
required

string
Body parameter

Name : body
Flags : required
Type : PaymentServiceRequest

Responses
HTTP Code Description Schema

200

OK

PaymentServiceResponse

400

Bad Request

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

  • application/octet-stream

Tags

  • Services

14.2. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

14.2.1. Account

Account data

Name Description Schema

accountNumber
required

Settlement account number

string

acquirerId
required

AcquirerId

string

emailAddress
optional

Email address for settlement reports

string

settlementOnAccount
required

Do settlement based on account number.

boolean

settlementType
optional

SettlementType. If not set it will default to either GROSS or what is set as global customer level.

enum (GROSS, NET)

validFrom
required

The date the Account is enabled for settlement if status is active

string (date)

14.2.2. AccountDetail

Settlement account data

Name Description Schema

account
required

Account

accountStatusDetail
required

AccountStatusDetail

karValidated
required

If true, the account has been validated against Bank KAR

boolean

14.2.3. AccountStatusDetail

Account status information

Name Description Schema

created
required

Date/Time GMT account was created.

string (date-time)

message
optional

Additional status info.

string

status
required

Account status.

enum (ACTIVE, ACTIVE_REPLACED, INACTIVE, DELETED)

statusTime
required

Date/Time GMT.

string (date-time)

validTo
optional

After this date the account is no longer enabled for settlement

string (date)

14.2.4. AcquirerUserInfoResponse

Name Schema

acquirerSchemaInfos
optional

< AcquirerSchemaInfo > array

14.2.5. ApsMerchantResponse

Name Description Schema

accountDetails
optional

Settlement account data

< AccountDetail > array

assetDetails
required

Asset (product) Information.

< AssetDetail > array

changeLogs
optional

Change Log of last changes on Merchant

< ChangeLog > array

concept
optional

Concept

enrolled
optional

boolean

groupDetails
optional

A list of customerGroups with details the Customer is a part of.

< GroupDetail > array

hasClient
optional

boolean

hasDataController
optional

boolean

invoiceReveiverCustomerId
optional

Invoice receiver of this merchant. Overrides original invoiceReceiver (Legal owner)

string

merchantAttributeMap
optional

< string, string > map

merchantAttributes
optional

< MerchantAttribute > array

merchantConceptEnabled
required

Use a unique DataController and concept for this merchant. All Products will use the conceptId.

boolean

merchantDetail
required

MerchantDetail

organizationDetail
required

OrganizationDetail

productList
optional

< Product > array

14.2.6. AssetDetail

Asset (product) Information.

Name Description Schema

acquirerId
optional

Aera Payment AcquirerId

string

agreements
optional

Digital agreements required for product

< AgreementProductInfo > array

created
required

Asset creation time.

string (date-time)

invoiceReveiverCustomerId
optional

Invoice receiver of this asset. Overrides original invoiceReceiver (Legal owner) or Head office inv_receiver_override on merchant level.

string

product
required

Product

productAttributes
optional

Product attributes.

< ProductAttribute > array

productTypeNumber
optional

Product type number. This is the primary visma product number used for Invoicing

string

status
required

Asset status.

enum (ACTIVE, INACTIVE, DELETED, PENDING)

updated
required

Asset updated time.

string (date-time)

14.2.7. ChangeLog

Change Log of last changes on Merchant

Name Description Schema

changeTime
required

Date and time of change

string (date-time)

description
required

Description of change

string

userId
required

Username of user who applied change

string

vismaSyncStatus
optional

visma sync status

string

vismaSyncTime
optional

visma sync time

string (date-time)

14.2.8. Concept

DataController and concept information if created for Merchant

Name Description Schema

conceptId
required

The unique id of the concept the store has access to. If not included, the UUID will be generated by CMS

string

conceptName
required

The name of the Concept

string

dataControllerId
required

The data controller the concept belongs to.

string

14.2.9. GroupDetail

A list of customerGroups with details the Customer is a part of.

Name Description Schema

group
required

Group

groupAttributes
optional

Group attributes.

< GroupAttribute > array

id
required

CustomerGroup id.

integer (int32)

14.2.10. MerchantAttribute

Name Schema

merchantAttributeType
optional

enum (PROFILE_GROUP, PROJECT_CODE, DATA_CONTROLLER, CALLBACK_URL)

merchantAttributeValue
optional

string

14.2.11. MerchantDetail

Merchant information.

Name Description Schema

merchant
required

Merchant

merchantId
required

Unique ID of Merchant generated by Aera. Returned if Merchant is generated ok in Aera TMS.

string

merchantStatus
required

MerchantStatusDetail

14.2.12. PaymentAcquirer

Name Description Schema

acquirerMid
required

Length : 1 - 20

string

acquirerName
required

enum (NETSSDI, ELAVONEUAER, EVRY, NTSTELLER, COLLECTOR, COLLECTOR_B2C, COLLECTOR_B2B, WSP_COOPAY, WSP_AERAPAY, WSP_TRUMFPAY, VIPPS, AERA, AERA_ACCOUNT, BANKAXEPT, CSDUMMY)

paymentSchemas
optional

< PaymentSchema > array

14.2.13. PaymentOption

Name Schema

paymentOptionJson
required

string

paymentOptionType
required

enum (D3SECURE)

14.2.14. PaymentSchema

Name Schema

paymentChannels
optional

< enum (TERMINAL, ONLINE) > array

paymentOptions
optional

< PaymentOption > array

paymentSchemaName
required

enum (BANKAXEPT, VISA, MASTERCARD, AMEX, DINERS, DISCOVER, JCB, MAESTRO, CUP, AERA, AERA_ACCOUNT, COOPCORP, NETSSG, NETSKG, IGIVEGK, IGIVEGS, IGIVEKK, IGIVEKS, IGIVEF, COOPVISA, TRUMF, NETSGK, NGCORP, NGGIFT, EVRYLOYAL, NETSKK, COOPMC, UNIGK, SENTRUMSGK)

14.2.15. PaymentService

Name Description Schema

apsServiceLabel
optional

Length : 1 - 20

string

commonName
required

Length : 1 - 50

string

idLookup
optional

boolean

lastUpdateTms
optional

string

mcc
required

Length : 4

string

merchantId
optional

Length : 1 - 20

string

paymentAcquirers
optional

< PaymentAcquirer > array

paymentServiceStatusAps
optional

enum (ZERO, INITIALIZED, ORDERED, PENDING, INPROGRESS, ACTIVE, INACTIVE, SUSPENDED, CANCELED, DELETED, DELETE_PENDING, INACTIVE_PENDING, ACTIVE_PENDING, FAILED, COMPLETED, SHIPPED, ONSTOCK, DEFAULT)

paymentServiceStatusTms
optional

enum (ZERO, INITIALIZED, ORDERED, PENDING, INPROGRESS, ACTIVE, INACTIVE, SUSPENDED, CANCELED, DELETED, DELETE_PENDING, INACTIVE_PENDING, ACTIVE_PENDING, FAILED, COMPLETED, SHIPPED, ONSTOCK, DEFAULT)

reconAutoClose
optional

boolean

serviceId
optional

Length : 1 - 20

string

type
optional

string

webShopUrl
optional

string

14.2.16. PaymentServiceRequest

Name Schema

lastUpdate
optional

string (date-time)

paymentService
required

PaymentService

webShopUrl
optional

string

14.2.17. PaymentServiceResponse

Name Description Schema

merchantId
optional

Pattern : "^[a-zA-Z0-9\\-]+$"

string

paymentServiceList
required

< PaymentService > array

responseInfo
optional

ResponseInfo

14.2.18. PaymentServiceStatusRequest

Name Description Schema

paymentServiceId
required

The payment service

string

status
required

The new client connection status.

enum (ZERO, INITIALIZED, ORDERED, PENDING, INPROGRESS, ACTIVE, INACTIVE, SUSPENDED, CANCELED, DELETED, DELETE_PENDING, INACTIVE_PENDING, ACTIVE_PENDING, FAILED, COMPLETED, SHIPPED, ONSTOCK, DEFAULT)

14.2.19. ProductRequest

Name Schema

merchantId
required

string

paymentServiceId
optional

string

productType
required

enum (APP, COF, APPLE_PAY, COLLECTOR, COOPAY, TRUMFPAY, REITANPAY, AERAPAY, CARDPAYMENT, WSP_COOPAY, WSP_AERAPAY, ONE_CLICK, AERA_KONTO, VIPPS, PREPAID, BANKAXEPT, ECOM_BANKAXEPT_ACQUIRER)

14.2.20. ProductResponse

Name Schema

message
optional

string

productList
optional

< Product > array

responseInfo
optional

ResponseInfo

14.2.21. ResponseInfo

Response info

Name Description Schema

externalResponseCode
optional

Additional response code from external systems.
Length : 1 - 255

string

message
optional

Error message
Length : 1 - 512

string

responseCode
optional

Specific response code
Length : 1 - 512

string

timeStamp
required

Time stamp. Mandatory

string (date-time)

14.3. ErrorCodes

AMS Error Codes:

Error Code Description

APS81000

Default error message for communication problem towards CMS

APS81001

The total refunded amount is higher than the total collected amount

APS81002

The amount for cancel is larger than authorized amount

APS81003

Authorization has been cancelled

APS81004

The amount for refund is larger than captured amount

APS81005

/TRX/GRS: Invalid value for element

15. Terminal Management System (TMS)

Service paths and model definition for the TMS.

15.1. What is TMS

The scope of the TMS is to ensure that Aera has the information needed to allow our Customers to utilize Aera terminal services as contractually agreed.
This api documentation covers on-boarding and lifecycle management of Customers, Merchants, Terminal Payment Services and Terminals with Aera as PSP.
The TMS system consist of API´s for all functions in the system. The api functions can be grouped based on client types accessing the TMS:

  • Customer functions:

    • on-boarding customer, merchant and TerminalServices (acquirer agreement data).

    • order terminals.

    • life-cycle operations.

      • Update TerminalService

      • Delete TerminalService

      • Inactivate and Reactivate TerminalService

  • Field Service functions:

    • Activate new terminal.

    • Swap terminal (copy).

    • Delete terminal

  • Terminal configuration

    • Create terminal configuration for customer

    • Update terminal configuration (new version of existing configuration)

  • Deploy terminal configuration

    • Deploy to a set of predefined terminals

    • Deploy in bulk based on deployment group and terminal configuration name

Customer and Field service operations are described in detail in this document.
Terminal configuration and Deploy terminal configuration is not described in detail since it is operation handled by Aera for customer.

15.1.1. TMS Domain Object Definitions

Name Description

Organization

Legal owner of a Merchant.

Merchant

Physical location of a store

TerminalService

collection of Acquirer-agreements (NETSSDI,ELAVON…​) and available CardSchemes (BANKAXEPT,VISA, MASTERCARD…​) registered on a Merchant to handle terminal payments in the Aera Payment Gateway. A TerminalService can contain one or a collection of different Acquirers.

Terminal

Point of Sale

Terminal Configuration template

Contains agreed upon terminal configuration. Contains fixed configuration and dynamic configuration. Dynamic configuration are configuration values gathered from Merchant or Terminal Service when creating configuration instance for a Terminal.

Terminal Configuration

Configuration instance for a terminal.

15.2. Merchant and TerminalService

A merchant represent a physical location (store) in the TMS system. A merchant is typically on-boarded once in the system for each physical location, but it is up to the customer to decide.
Note: To ensure Merchant uniqueness, GLN number is used as unique identifier. This means that 2 Merchants with same GLN number, orgNumber and name can not be on-boarded in the TMS.

A Merchant can have 0 to many Terminal Services. A terminal service is a collection of Acquirers and CardSchemes used to handle terminal payments in the Aera Payment Gateway. One TerminalService has 0 to many terminals handling payments using the Acquiring information registered on TerminalService.

Note: Terminals added to a TerminalService will only be configured to allow Acquirers and Card schemes registered in the TerminalService. This is enforced by creating a unique Terminal configuration using the selected configuration template when ordering new terminals. The configuration adds the registered Acquirers and Card schemes in the Terminal Service as dynamic configuration in the terminal configuration.

Coarse-grained TMS component overview
Figure 27. Coarse-grained TMS component overview.

The following is input to the Merchant Onboarding process:

  • Organization data (if relevant).
    Note: Organization can be on-boarded in separate API calls.
    Note: It is important to add CustomerContact information on the Organization level. (name, email). This information is used in the merchant agreements signing process.

  • Merchant data

  • Optionally existing acquirer agreements and identifiers (TerminalService´s in Merchant on-boarding request). TerminalService´s can be on-boarded using other calls after merchant on-boarding (See: Add TerminalService ).

The following is the result of the Merchant on-boarding process:

  • Customer (organization) account created in the Aera CMS if not created before.

  • Merchant created in the TMS.

  • Signed merchant agreement ("Brukerstedsavtalen") process is started if needed. Note that one "Brukerstedsavtale" may cover several merchants.

  • Acquirer information pushed to the payment gateway (if embedded in merchant on-boarding request).

For API doc, see add merchant

15.2.1. Sequence diagram for the Merchant on-boarding with TerminalServices

The sequence diagram below show a typical merchant on-boarding with embedded terminalService (payment data) information.
In this specific scenario, Field Service handles the Terminal installation and activation using activateTerminal API call.

Actor Definitions
Name Description

Field Service

Entity handling installation and activation of terminals using API calls against TMS.

Customer Client

Customer handling Merchant onboarding API calls against TMS

Aera TMS

The Aera Terminal Management System.

Aera Real Time

Real time event system. Recieves events from the payment gateway in near real time.

Payment Gateway

The payment gateway infrastructure handling payments and routing to Acquirers.

Aera ID

The Aera ID service handling loyalty lookup

BankAxept

The BankAxept service handling BAX agreement order and migration.

Terminal Config Provisioning System

The system handling terminal config provisioning

Terminal

POS (LANE5000)
Sequence diagram for the Merchant on-boarding with TerminalServices
Figure 28. Sequence diagram for the Merchant onboarding with TerminalServices

Alternative sequences:

15.2.2. Terminal Service statuses (PaymentServiceStatus):

Status Description

INITIALIZED

Terminal service have been created using POST, but not yet activated in payment gateway

ACTIVE

Terminal service are activated in payment gateway. New terminals can be ordered and Activated

PENDING

Terminal service are active, but updated payment service data are pending upload to payment gateway.

INACTIVE_PENDING

Terminal service set to INACTIVE, but awaiting removal of data from payment gateway.

INACTIVE

Terminal service are inactive. Terminal payments will not be processed. Note: All active Terminals registered on Terminal service are also set to INACTIVE. SUSPENDED terminals will not change status. New terminals can not be activated if Terminal service are INACTIVE.

ACTIVE_PENDING

Terminal service set to ACTIVE, awaiting payment service data upload to payment gateway

DELETE_PENDING

Terminal service are deleted, but awaiting removal from payment gateway.

DELETED

Terminal service deleted.

FAILED

Terminal service have been created, but failed upload to payment gateway.

15.3. Terminal Order and Activation

When Merchant(s) and TerminalServices have been on-boarded in TMS, the next step is to Order and Activate terminals handling card payments.
This chapter describes the terminal order and activation processes.

15.3.1. Terminal order

The Merchant Call-Off process is the process that Aera uses to manage a new order for physical terminals with associated accessories. The customer will place a terminal order to create a TID (terminal ID) and order a physical terminal to be installed at merchant location.
Terminal order is an API call issued to TMS to order a new terminal from Aera TMS system. The following is input to the Terminal order API call:

  • serviceId: Reference ID to the TerminalService.

  • terminalConfigInfo: Name of terminal configuration template used (configLabel). Terminal configuration templates are a collection of predefined agreed upon configuration paramenters downloaded to terminal after activation of terminal.

  • terminalShipmentData: Info forwarded to Field Service handling activation/installation/shipment of terminals.

The following is result of the Terminal order API call:

  • terminalId: Aera generated unique id for Terminal. Will be used to activate the terminal and identify terminal in the payment gateway.

  • The Terminal Order will be sent to a third party Field Service partner if customer have an "Assisted" model. If self-service model, the Order will be sent to Central stock for further processing.

For API doc, see Order terminal

Example Terminal Order request

Note: serviceId has to be set in the post request: <URL>/tms/terminals/order/<serviceId>

15.3.2. Terminal activation

Terminal activation is the process by which a physical payment terminal is successfully activated in the TMS and Payment gateway for an Aera customer. In Assisted service models, activation is performed by a third party field service operation. In Self-service, service models, the activation is typically performed at Aera central storage before it is shipped to the store..
Terminal Activation uses an API call to link terminalId provided by Aera and the serialNumber of the terminal, set up a terminal configuration profile ready to be downloaded and installed on the terminal.
The following is input to the Terminal activation API call:

  • serviceId: Reference to the TerminalService.

  • terminalId: The terminalId created in Order Terminal API call.

  • serialNumber: SerialNumber of the terminal being installed.

The following is output of the Terminal activation API call:

  • TerminalId and serialNumber are linked in Aera TMS system.

  • Physical terminal is ready to download software and configuration.

Sequence diagram for the Merchant onboarding with TerminalServices
Figure 29. Sequence diagram for Terminal Order and Activation

15.3.3. Terminal Installation

Terminal installation is the process by which a physical payment terminal is successfully installed for an Aera customer. In "Assisted" service models, installation of physical terminals is performed by a field service technician. In Self-service, service models, the installation of physical terminals is performed by a merchant.
The sequence diagram below show the technical process when installing a new Terminal. Pre condition is either a terminal activation or terminal Swap.

Sequence diagram for Terminal configuration download and installation
Figure 30. Sequence diagram for Terminal configuration download

15.3.4. Terminal swap and returns

The scope of the Return Logistics process includes payment terminals that are being swapped, are 'dead on arrival', or that are uninstalled as part of a merchant off-boarding process.
The process varies according to whether a field technician from a service supplier (Assisted delivery models) is involved, or whether the process is done by the merchant (Self-service delivery model).
The parties responsible for carrying out specific tasks within the Return Logistics process vary depending upon which service delivery model has been chosen by the customer.
In the Assisted service models, a field service technician is responsible for returning the terminal(s) to the Aera central warehouse. In Assisted models however, customers select their own service suppliers to perform such tasks.
In Self-service models, the Merchant is responsible for returning the terminal(s) to the Aera central warehouse.
This chapter will go through the technical API calls used when replacing (swapping) terminals.

Terminal swap

A terminal swap is a two step process, involving two API calls :
* copyTerminal : Create a new Terminal in the system with all data copied from an old terminal in the system. The new terminal is an exact copy of the old, but with a new terminalId and new serialNumber. For API doc, see Copy terminal
* deleteTerminal: delete the terminal from the terminal configuration system and the payment gateway. Terminal status is set to Deactivated and returned to stock. For API doc, see Delete terminal

Sequence diagram for Terminal swap
Figure 31. Sequence diagram for Terminal copy (swap)
Sequence diagram for Terminal delete
Figure 32. Sequence diagram for Terminal delete

15.3.5. Terminal statuses (TerminalStatus):

Status Description

ORDERED

Terminal is Ordered and ready to be activated. TerminalId is created.

ACTIVE

Terminal are activated and terminal data/configuration are uploaded to payment gateway.

PENDING

Terminal are active, but terminal data are pending upload to payment gateway.

INACTIVE

Terminal service are inactive. Terminal payments will not be processed. Note: All active Terminals registered on Terminal service are also set to INACTIVE. SUSPENDED terminals will not change status. New terminals can not be activated if Terminal service are INACTIVE.

DELETE_PENDING

Terminal are deleted, but awaiting removal from payment gateway.

DELETED

Terminal deleted.

FAILED

Terminal created, but upload of terminal data/configuration to payment gateway failed.

CANCELLED

Terminal have been in status ORDERED, and CANCELLED before it was activated.

15.4. ErrorCodes

Common Error Codes:

Error Code Description

AERA20003

Invalid JSON

AERA20004

Invalid request parameter

AERA20010

The request timed out towards a dependent component

AERA20099

General error

TMS Error Codes:

Error Code Description

TMS21003

Can’t reserve terminals. Not enough terminals on stock

TMS21005

User has no access to requested/affected object

TMS21006

User has no access to requested/affected resource, missing scope

TMS21010

Config template exists

TMS21011

Config template does not exists

TMS21012

Config template in use by terminal

TMS21013

Config template is in use by active configuration deployment

TMS21014

Config template is in use by terminal order

TMS21015

Config template contains illegal properties

TMS21019

Payment service is not inactive

TMS21020

Payment service does not exists

TMS21021

Payment service is not active

TMS21022

Payment service already enrolled

TMS21023

Payment service already finalized

TMS21024

Payment service contain terminal

TMS21025

Payment service is in use by Payment order

TMS21026

Duplicate AcquirerNames in Payment service

TMS21027

Duplicate CardSchema names in Payment service

TMS21028

Empty AcquirerInfo list

TMS21029

NETSSDI not allowed in AcquirerInfo list if BankAxeptOrder are included

TMS21030

Terminal order does not exists

TMS21031

Terminal order is already completed

TMS21032

Terminal order in wrong state

TMS21033

Terminal order is not completed

TMS21035

Invalid Card scheme name

TMS21036

Payment service cant be modified with terminal service

TMS21037

PaymentSchema contains paymentOptions but does not have ONLINE channel

TMS21040

Terminal does not exists

TMS21041

Terminal serial number is unknown

TMS21042

Terminal serial is already in use

TMS21043

Unsupported terminal status

TMS21044

Only terminals in status active can be suspended

TMS21045

Only terminals in status suspend can be activated

TMS21050

Failed to communicate with CMS system

TMS21060

Deployed configuration does not exists

TMS21070

Config deployment does not exists

TMS21071

Config deployment already in final state

TMS21080

Request processed by Aevi with error

TMS21085

Request processed by IPG with error

TMS21090

Undefined error

TMS21100

Could not parse received Excel file

TMS21110

Merchant is not set up with product Loyalty, can not be configured with Id lookup

TMS21120

Task does not exists

TMS21121

Task is in final state, can’t update

TMS21122

Failed to lock task

TMS21130

Payment options does not validate

TMS21131

Payment options type is invalid

AERA10100

Customer not found

AERA10101

Customer already enrolled

AERA10102

Merchant not found

AERA10103

Merchant already enrolled

AERA10104

Merchant deleted

15.5. Paths

Descriptions of resources/paths in the service.

15.5.1. Post shipment file from Ingenico

POST /tms/aerastock
Description

Aere specific API
Add information about terminals manufactured and shipped to Aera from terminal vendor.

Body parameter

Name : body
Flags : required
Type : ShipmentFileRequest

Responses
HTTP Code Description Schema

200

OK

< string, integer (int32) > map

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Aera stock

15.5.2. Delete terminal serialnumber

DELETE /tms/aerastock/snr/{serialNumber}
Description

Delete terminal serialnumber from Aera stock

Parameters
Type Name Description Schema

Path

serialNumber
required

Terminal serial number

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Aera stock

15.5.3. Mark terminal serialnumber as found

PUT /tms/aerastock/snr/{serialNumber}/found
Description

Mark terminal serialnumber as found

Parameters
Type Name Description Schema

Path

serialNumber
required

Terminal serial number

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Aera stock

15.5.4. Mark terminal serialnumber as lost

PUT /tms/aerastock/snr/{serialNumber}/lost
Description

Mark terminal serialnumber as lost

Parameters
Type Name Description Schema

Path

serialNumber
required

Terminal serial number

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Aera stock

15.5.5. Add terminal serialnumber

POST /tms/aerastock/snr/{serialNumber}/{stockValue}
Description

Add terminal serialnumber to Aera stock

Parameters
Type Name Description Schema

Path

serialNumber
required

Terminal serial number

string

Path

stockValue
required

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Aera stock

15.5.6. Get Aevi terminal data

GET /tms/aevi/data/{terminalId}
Description

Get Aevi terminal data

Parameters
Type Name Description Schema

Path

terminalId
required

TerminalId

string
Responses
HTTP Code Description Schema

200

OK

GetTerminalDataResponseTms

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Aevi requests

15.5.7. Get Aevi terminal data with MID

GET /tms/aevi/data/{terminalId}/{paymentServiceId}
Description

Get Aevi terminal data with MID

Parameters
Type Name Description Schema

Path

paymentServiceId
required

TMS PaymentServiceId, used as MerchantId towards Aevi

string

Path

terminalId
required

TerminalId

string
Responses
HTTP Code Description Schema

200

OK

GetTerminalDataResponseTms

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Aevi requests

15.5.8. Add configuration template

POST /tms/configurations
Description

Add new terminal configuration template

Body parameter

Name : body
Flags : required
Type : TerminalConfigTemplateRequest

Responses
HTTP Code Description Schema

201

Created

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Terminal configuration

Example HTTP request
POST /tms/configurations HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 3208
Host: api.aerahost.com

{
  "configLabel" : "Kasse_USB",
  "configVersion" : "1.0",
  "deviceTypes" : [ "LANE_5000" ],
  "chains" : [ 1 ],
  "configProperties" : {
    "LANG" : [ {
      "key" : "currencyCode",
      "type" : "FIXED",
      "value" : "NOK"
    }, {
      "key" : "countryCode",
      "type" : "FIXED",
      "value" : "578"
    }, {
      "key" : "defaultMerchLang",
      "type" : "FIXED",
      "value" : "no"
    }, {
      "key" : "defaultCliLang",
      "type" : "FIXED",
      "value" : "no"
    }, {
      "key" : "supportedLang",
      "type" : "FIXED",
      "value" : "en;no;"
    } ],
    "MERCHANT" : [ {
      "key" : "emv9F15MerchCat",
      "type" : "DYNAMIC",
      "value" : "CHANGE"
    }, {
      "key" : "merchantId",
      "type" : "DYNAMIC",
      "value" : "CHANGE"
    } ],
    "TERMINAL" : [ {
      "key" : "powerSave",
      "type" : "FIXED",
      "value" : "150|14400|0|60|600"
    }, {
      "key" : "profileType",
      "type" : "FIXED",
      "value" : "USB_11.16.08H_41129053_16_UP"
    }, {
      "key" : "DCC",
      "type" : "FIXED",
      "value" : "N"
    }, {
      "key" : "tipAmount",
      "type" : "FIXED",
      "value" : "N"
    }, {
      "key" : "minAmountLimit",
      "type" : "FIXED",
      "value" : "1"
    }, {
      "key" : "maxAmountLimit",
      "type" : "FIXED",
      "value" : "99999999"
    }, {
      "key" : "forceUpdate",
      "type" : "DYNAMIC",
      "value" : "CHANGE"
    }, {
      "key" : "loyalty",
      "type" : "DYNAMIC",
      "value" : "CHANGE"
    }, {
      "key" : "keyboardBeep",
      "type" : "FIXED",
      "value" : "Y"
    }, {
      "key" : "forceOffline",
      "type" : "FIXED",
      "value" : "Y"
    }, {
      "key" : "forceOfflineCfg",
      "type" : "FIXED",
      "value" : "BAX|1000000|150000|6"
    }, {
      "key" : "startTimeOfAU",
      "type" : "FIXED",
      "value" : "1"
    }, {
      "key" : "periodOfAU",
      "type" : "FIXED",
      "value" : "1"
    }, {
      "key" : "clessActive",
      "type" : "FIXED",
      "value" : "Y"
    } ],
    "PRINT" : [ {
      "key" : "printOptions",
      "type" : "FIXED",
      "value" : "1;2;"
    }, {
      "key" : "printHeader",
      "type" : "FIXED",
      "value" : "N"
    }, {
      "key" : "printFooter",
      "type" : "FIXED",
      "value" : "N"
    } ],
    "SCHEME_BANKAXEPT" : [ {
      "key" : "floorLimitContact",
      "type" : "FIXED",
      "value" : "999999"
    }, {
      "key" : "prefferedAppContact",
      "type" : "FIXED",
      "value" : "Y"
    }, {
      "key" : "floorLimitContactless",
      "type" : "FIXED",
      "value" : "999999"
    }, {
      "key" : "cvmReqLimitContactless",
      "type" : "FIXED",
      "value" : "200"
    }, {
      "key" : "interacMTIContactless",
      "type" : "FIXED",
      "value" : "03"
    }, {
      "key" : "refundSupport",
      "type" : "FIXED",
      "value" : "N"
    }, {
      "key" : "cashbackSupport",
      "type" : "FIXED",
      "value" : "N"
    } ],
    "SCHEME_VISA" : [ {
      "key" : "floorLimitContact",
      "type" : "FIXED",
      "value" : "999999"
    }, {
      "key" : "prefferedAppContact",
      "type" : "FIXED",
      "value" : "N"
    } ]
  },
  "current" : false
}
Example HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Example Curl request
$ curl 'https://api.aerahost.com/tms/configurations' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "configLabel" : "Kasse_USB",
  "configVersion" : "1.0",
  "deviceTypes" : [ "LANE_5000" ],
  "chains" : [ 1 ],
  "configProperties" : {
    "LANG" : [ {
      "key" : "currencyCode",
      "type" : "FIXED",
      "value" : "NOK"
    }, {
      "key" : "countryCode",
      "type" : "FIXED",
      "value" : "578"
    }, {
      "key" : "defaultMerchLang",
      "type" : "FIXED",
      "value" : "no"
    }, {
      "key" : "defaultCliLang",
      "type" : "FIXED",
      "value" : "no"
    }, {
      "key" : "supportedLang",
      "type" : "FIXED",
      "value" : "en;no;"
    } ],
    "MERCHANT" : [ {
      "key" : "emv9F15MerchCat",
      "type" : "DYNAMIC",
      "value" : "CHANGE"
    }, {
      "key" : "merchantId",
      "type" : "DYNAMIC",
      "value" : "CHANGE"
    } ],
    "TERMINAL" : [ {
      "key" : "powerSave",
      "type" : "FIXED",
      "value" : "150|14400|0|60|600"
    }, {
      "key" : "profileType",
      "type" : "FIXED",
      "value" : "USB_11.16.08H_41129053_16_UP"
    }, {
      "key" : "DCC",
      "type" : "FIXED",
      "value" : "N"
    }, {
      "key" : "tipAmount",
      "type" : "FIXED",
      "value" : "N"
    }, {
      "key" : "minAmountLimit",
      "type" : "FIXED",
      "value" : "1"
    }, {
      "key" : "maxAmountLimit",
      "type" : "FIXED",
      "value" : "99999999"
    }, {
      "key" : "forceUpdate",
      "type" : "DYNAMIC",
      "value" : "CHANGE"
    }, {
      "key" : "loyalty",
      "type" : "DYNAMIC",
      "value" : "CHANGE"
    }, {
      "key" : "keyboardBeep",
      "type" : "FIXED",
      "value" : "Y"
    }, {
      "key" : "forceOffline",
      "type" : "FIXED",
      "value" : "Y"
    }, {
      "key" : "forceOfflineCfg",
      "type" : "FIXED",
      "value" : "BAX|1000000|150000|6"
    }, {
      "key" : "startTimeOfAU",
      "type" : "FIXED",
      "value" : "1"
    }, {
      "key" : "periodOfAU",
      "type" : "FIXED",
      "value" : "1"
    }, {
      "key" : "clessActive",
      "type" : "FIXED",
      "value" : "Y"
    } ],
    "PRINT" : [ {
      "key" : "printOptions",
      "type" : "FIXED",
      "value" : "1;2;"
    }, {
      "key" : "printHeader",
      "type" : "FIXED",
      "value" : "N"
    }, {
      "key" : "printFooter",
      "type" : "FIXED",
      "value" : "N"
    } ],
    "SCHEME_BANKAXEPT" : [ {
      "key" : "floorLimitContact",
      "type" : "FIXED",
      "value" : "999999"
    }, {
      "key" : "prefferedAppContact",
      "type" : "FIXED",
      "value" : "Y"
    }, {
      "key" : "floorLimitContactless",
      "type" : "FIXED",
      "value" : "999999"
    }, {
      "key" : "cvmReqLimitContactless",
      "type" : "FIXED",
      "value" : "200"
    }, {
      "key" : "interacMTIContactless",
      "type" : "FIXED",
      "value" : "03"
    }, {
      "key" : "refundSupport",
      "type" : "FIXED",
      "value" : "N"
    }, {
      "key" : "cashbackSupport",
      "type" : "FIXED",
      "value" : "N"
    } ],
    "SCHEME_VISA" : [ {
      "key" : "floorLimitContact",
      "type" : "FIXED",
      "value" : "999999"
    }, {
      "key" : "prefferedAppContact",
      "type" : "FIXED",
      "value" : "N"
    } ]
  },
  "current" : false
}'

15.5.9. Get all configuration template labels

GET /tms/configurations
Description

Get a list of all terminal configuration template labels that exists for the customer

Responses
HTTP Code Description Schema

200

OK

< string > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Terminal configuration

Example HTTP request
GET /tms/configurations HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 54

[ "OrderM5", "Tipping_CL", "JDEF", "JunitWithType21" ]
Example Curl request
$ curl 'https://api.aerahost.com/tms/configurations' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.10. Get all configuration details

GET /tms/configurations/all
Description

Get all configuration template that exists

Responses
HTTP Code Description Schema

200

OK

< ConfigTemplateInformationResponse > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Terminal configuration

15.5.11. Get all configuration template versions

GET /tms/configurations/{configLabel}
Description

Get all version that exists for a terminal configuration template label

Parameters
Type Name Description Schema

Path

configLabel
required

Label on the configuration template

string
Responses
HTTP Code Description Schema

200

OK

< ConfigTemplateInformationResponse > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Terminal configuration

Example HTTP request
GET /tms/configurations/JDEF HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 183

[ {
  "configLabel" : "JDEF",
  "configVersion" : "1.2",
  "deviceTypes" : [ "LANE_5000" ],
  "chain" : [ 1 ],
  "created" : "2024-04-15T12:42:53.766505Z",
  "status" : "INACTIVE"
} ]
Example Curl request
$ curl 'https://api.aerahost.com/tms/configurations/JDEF' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.12. Get configuration template details

GET /tms/configurations/{configLabel}/{version}
Description

Get config parameters that exists for a given terminal configuration template

Parameters
Type Name Description Schema

Path

configLabel
required

Label on the configuration template

string

Path

version
required

Version on the configuration

string
Responses
HTTP Code Description Schema

200

OK

TerminalConfigTemplateResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Terminal configuration

Example HTTP request
GET /tms/configurations/JDEF/1.2 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Disposition: inline;filename=f.txt
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 3207

{
  "configLabel" : "JDEF",
  "configVersion" : "1.2",
  "deviceTypes" : [ "LANE_5000" ],
  "chains" : [ 1 ],
  "configProperties" : {
    "MERCHANT" : [ {
      "key" : "emv9F15MerchCat",
      "type" : "DYNAMIC",
      "value" : "CHANGE"
    }, {
      "key" : "merchantId",
      "type" : "DYNAMIC",
      "value" : "CHANGE"
    } ],
    "LANG" : [ {
      "key" : "countryCode",
      "type" : "FIXED",
      "value" : "578"
    }, {
      "key" : "currencyCode",
      "type" : "FIXED",
      "value" : "NOK"
    }, {
      "key" : "defaultCliLang",
      "type" : "FIXED",
      "value" : "no"
    }, {
      "key" : "defaultMerchLang",
      "type" : "FIXED",
      "value" : "no"
    }, {
      "key" : "supportedLang",
      "type" : "FIXED",
      "value" : "en;no;"
    } ],
    "SCHEME_BANKAXEPT" : [ {
      "key" : "cashbackSupport",
      "type" : "FIXED",
      "value" : "N"
    }, {
      "key" : "cvmReqLimitContactless",
      "type" : "FIXED",
      "value" : "200"
    }, {
      "key" : "floorLimitContact",
      "type" : "FIXED",
      "value" : "999999"
    }, {
      "key" : "floorLimitContactless",
      "type" : "FIXED",
      "value" : "999999"
    }, {
      "key" : "interacMTIContactless",
      "type" : "FIXED",
      "value" : "03"
    }, {
      "key" : "prefferedAppContact",
      "type" : "FIXED",
      "value" : "Y"
    }, {
      "key" : "refundSupport",
      "type" : "FIXED",
      "value" : "N"
    } ],
    "PRINT" : [ {
      "key" : "printFooter",
      "type" : "FIXED",
      "value" : "N"
    }, {
      "key" : "printHeader",
      "type" : "FIXED",
      "value" : "N"
    }, {
      "key" : "printOptions",
      "type" : "FIXED",
      "value" : "1;2;"
    } ],
    "SCHEME_VISA" : [ {
      "key" : "floorLimitContact",
      "type" : "FIXED",
      "value" : "999999"
    }, {
      "key" : "prefferedAppContact",
      "type" : "FIXED",
      "value" : "N"
    } ],
    "TERMINAL" : [ {
      "key" : "clessActive",
      "type" : "FIXED",
      "value" : "Y"
    }, {
      "key" : "DCC",
      "type" : "FIXED",
      "value" : "N"
    }, {
      "key" : "forceOffline",
      "type" : "FIXED",
      "value" : "Y"
    }, {
      "key" : "forceOfflineCfg",
      "type" : "FIXED",
      "value" : "BAX|1000000|150000|6"
    }, {
      "key" : "forceUpdate",
      "type" : "DYNAMIC",
      "value" : "CHANGE"
    }, {
      "key" : "keyboardBeep",
      "type" : "FIXED",
      "value" : "Y"
    }, {
      "key" : "loyalty",
      "type" : "DYNAMIC",
      "value" : "CHANGE"
    }, {
      "key" : "maxAmountLimit",
      "type" : "FIXED",
      "value" : "99999999"
    }, {
      "key" : "minAmountLimit",
      "type" : "FIXED",
      "value" : "1"
    }, {
      "key" : "periodOfAU",
      "type" : "FIXED",
      "value" : "1"
    }, {
      "key" : "powerSave",
      "type" : "FIXED",
      "value" : "150|14400|0|60|600"
    }, {
      "key" : "profileType",
      "type" : "FIXED",
      "value" : "USB_11.16.08H_41129053_16_UP"
    }, {
      "key" : "startTimeOfAU",
      "type" : "FIXED",
      "value" : "1"
    }, {
      "key" : "tipAmount",
      "type" : "FIXED",
      "value" : "N"
    } ]
  },
  "status" : "INACTIVE"
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/configurations/JDEF/1.2' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.13. Delete configuration template

DELETE /tms/configurations/{configLabel}/{version}
Description

Delete a terminal configuration template. (Configuration template can not be in use by any terminals)

Parameters
Type Name Description Schema

Path

configLabel
required

Label on the configuration template

string

Path

version
required

Version on the configuration

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Terminal configuration

Example HTTP request
DELETE /tms/configurations/JDEF/1.0 HTTP/1.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Example Curl request
$ curl 'https://api.aerahost.com/tms/configurations/JDEF/1.0' -i -X DELETE \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.14. Update status on configuration template

PUT /tms/configurations/{configLabel}/{version}/{status}
Description

Update status on configuration template

Parameters
Type Name Description Schema

Path

configLabel
required

Label on the configuration template

string

Path

status
required

New status on configuration template

enum (ACTIVE, DEFAULT, INACTIVE)

Path

version
required

Version on the configuration

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Terminal configuration

15.5.15. Deploy terminal configuration by terminal id

POST /tms/deployments/manual
Description

Deploy new terminal configuration to a set of given terminal Id’s.

Body parameter

Name : body
Flags : required
Type : DeployConfigManualRequest

Responses
HTTP Code Description Schema

201

Created

string

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Terminal configuration deployment

Example HTTP request
POST /tms/deployments/manual HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 141
Host: api.aerahost.com

{
  "configLabel" : "Tipping_CL",
  "configVersion" : "1.0",
  "deployDate" : "2024-04-25",
  "terminalIdList" : [ "AE123456", "AE998877" ]
}
Example HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1

5
Example Curl request
$ curl 'https://api.aerahost.com/tms/deployments/manual' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "configLabel" : "Tipping_CL",
  "configVersion" : "1.0",
  "deployDate" : "2024-04-25",
  "terminalIdList" : [ "AE123456", "AE998877" ]
}'

15.5.16. Deploy terminal configuration by deployment tag

POST /tms/deployments/strategy
Description

Deploy new configuration to all terminals with a given deployment tag.
Optional a terminal configuration template can be used to select only terminal running that specific template.

Body parameter

Name : body
Flags : required
Type : DeployConfigStrategyRequest

Responses
HTTP Code Description Schema

201

Created

string

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Terminal configuration deployment

Example HTTP request
POST /tms/deployments/strategy HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 177
Host: api.aerahost.com

{
  "deploymentStrategy" : "NEXT_BOOT",
  "updateConfigLabel" : "Tipping_CL",
  "updateConfigVersion" : "1.0",
  "oldConfigLabel" : "Tipping_CL",
  "deployDate" : "2024-04-16"
}
Example HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1

4
Example Curl request
$ curl 'https://api.aerahost.com/tms/deployments/strategy' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "deploymentStrategy" : "NEXT_BOOT",
  "updateConfigLabel" : "Tipping_CL",
  "updateConfigVersion" : "1.0",
  "oldConfigLabel" : "Tipping_CL",
  "deployDate" : "2024-04-16"
}'

15.5.17. Deploy strategy dry run

POST /tms/deployments/strategy/preview
Description

Dry run on deploy strategy, get back terminals that will be updated (No update is performed)

Body parameter

Name : body
Flags : required
Type : DeployConfigStrategyRequest

Responses
HTTP Code Description Schema

200

OK

ConfigDeployment

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Terminal configuration deployment

15.5.18. Delete terminal

DELETE /tms/fieldservices
Description

The terminal will be deleted from payment infrastructure

Body parameter

Name : body
Flags : required
Type : FSDeleteTerminalRequest

Responses
HTTP Code Description Schema

200

OK

FSTerminalResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Field Service

Example HTTP request
DELETE /tms/fieldservices HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 90
Host: api.aerahost.com

{
  "serviceId" : "L000011",
  "terminalId" : "AE023095",
  "serialNumber" : "622490163"
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 63

{
  "serialNumber" : "622490163",
  "terminalId" : "AE023095"
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/fieldservices' -i -X DELETE \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "serviceId" : "L000011",
  "terminalId" : "AE023095",
  "serialNumber" : "622490163"
}'

15.5.19. Activate terminal

PUT /tms/fieldservices/activate
Description

Activate a ordered terminal (bind serialnumber to terminal)

Body parameter

Name : body
Flags : required
Type : FSActivateTerminalRequest

Responses
HTTP Code Description Schema

200

OK

FSTerminalResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Field Service

Example HTTP request
PUT /tms/fieldservices/activate HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 117
Host: api.aerahost.com

{
  "ecrNumber" : "Kasse01",
  "serviceId" : "L000011",
  "terminalId" : "AE757027",
  "serialNumber" : "194777439"
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 63

{
  "serialNumber" : "194777439",
  "terminalId" : "AE757027"
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/fieldservices/activate' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "ecrNumber" : "Kasse01",
  "serviceId" : "L000011",
  "terminalId" : "AE757027",
  "serialNumber" : "194777439"
}'

15.5.20. Copy terminal

PUT /tms/fieldservices/copy
Description

Copy terminal will add and activate a new terminal, configuration will be copied from existing terminal. The new terminal will get a new terminal id.

Body parameter

Name : body
Flags : required
Type : FSCopyTerminalRequest

Responses
HTTP Code Description Schema

201

Created

FSTerminalResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Field Service

Example HTTP request
PUT /tms/fieldservices/copy HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 131
Host: api.aerahost.com

{
  "serviceId" : "L000011",
  "oldTerminalId" : "AE757027",
  "oldSerialNumber" : "194777439",
  "newSerialNumber" : "622490163"
}
Example HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 63

{
  "serialNumber" : "622490163",
  "terminalId" : "AE023095"
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/fieldservices/copy' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "serviceId" : "L000011",
  "oldTerminalId" : "AE757027",
  "oldSerialNumber" : "194777439",
  "newSerialNumber" : "622490163"
}'

15.5.21. Update FS order

PUT /tms/fieldservices/{orderNumber}
Description

The operation is used to confirm/update an installation order by Field service

Parameters
Type Name Description Schema

Path

orderNumber
required

Order Number

integer (int64)
Body parameter

Name : body
Flags : required
Type : FsOrderUpdate

Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Field Service

Example HTTP request
PUT /tms/fieldservices/8 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 88
Host: api.aerahost.com

{
  "status" : "PENDING",
  "vendorId" : "REF123",
  "installationDate" : "2024-04-15"
}
Example HTTP response
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Example Curl request
$ curl 'https://api.aerahost.com/tms/fieldservices/8' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "status" : "PENDING",
  "vendorId" : "REF123",
  "installationDate" : "2024-04-15"
}'

15.5.22. Get Application Status (Health check)

GET /tms/health
Responses
HTTP Code Description Schema

200

OK

Status

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Application Status

15.5.23. POST /tms/ingenicoreports

Body parameter

Name : body
Flags : required
Type : IngenicoRepairReportRequest

Responses
HTTP Code Description Schema

200

OK

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • ingenico-repair-report-controller

15.5.24. GET /tms/ingenicoreports

Responses
HTTP Code Description Schema

200

OK

< IngenicoRepairReportResponse > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • ingenico-repair-report-controller

15.5.25. GET /tms/ingenicoreports/snr/{serialNumber}

Parameters
Type Name Schema

Path

serialNumber
required

string
Responses
HTTP Code Description Schema

200

OK

< IngenicoRepairReportResponse > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • ingenico-repair-report-controller

15.5.26. Add merchant

POST /tms/merchants
Description

API call to on-board a physical store in the TMS system, and optionally TerminalServices. The API call can on-board the Organization in the same call. If Organization have been on-boarded before, the Organization data will be omitted. To ensure uniqueness when on-boarding a merchant, GLN number is used as unique identifier. This means that 2 Merchants with same GLN number can not be on-boarded in the TMS

Body parameter

Name : body
Flags : required
Type : MerchantRequest

Responses
HTTP Code Description Schema

201

Created

MerchantResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Merchant

Example HTTP request
POST /tms/merchants HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 1621
Host: api.aerahost.com

{
  "organization" : {
    "organizationNumber" : "9999912345",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Normann",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    },
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    }
  },
  "merchant" : {
    "name" : "Acme Butikk",
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    },
    "locationAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    },
    "gln" : "1231231231232",
    "chainName" : "Acme chain",
    "chainId" : "9998",
    "customerRef" : "1034",
    "companyPhone" : "99999999",
    "companyEmail" : "acme@acme.no",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Normann",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    }
  },
  "terminalServices" : [ {
    "idLookup" : false,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "acquirerInfos" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "cardSchemas" : [ "BANKAXEPT" ]
    }, {
      "acquirerName" : "ELAVONEUAER",
      "acquirerMid" : "999998",
      "cardSchemas" : [ "VISA", "MASTERCARD" ]
    } ]
  }, {
    "idLookup" : false,
    "commonName" : "Tipping",
    "mcc" : "5400",
    "acquirerInfos" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "cardSchemas" : [ "BANKAXEPT" ]
    } ]
  } ]
}
Example HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 2789

{
  "merchantId" : "DOC000001",
  "organizationDetail" : {
    "name" : "Acme Holding",
    "organizationNumber" : "9999912345",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Normann",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    },
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    }
  },
  "merchant" : {
    "name" : "Acme Butikk",
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    },
    "locationAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    },
    "gln" : "1231231231232",
    "chainName" : "Acme chain",
    "chainId" : "9998",
    "customerRef" : "1034",
    "companyPhone" : "99999999",
    "companyEmail" : "acme@acme.no",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Normann",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    }
  },
  "groupDetails" : [ {
    "id" : 3,
    "group" : {
      "name" : "Coop",
      "type" : "UMBRELLA"
    },
    "groupAttributes" : [ ]
  } ],
  "terminalServiceDetails" : [ {
    "serviceId" : "L000009",
    "idLookup" : false,
    "commonName" : "Kasse",
    "activeFrom" : "2024-04-15",
    "mcc" : "5411",
    "reconAutoClose" : true,
    "acquirerInfoDetails" : [ {
      "acquirerInfo" : {
        "acquirerName" : "NETSSDI",
        "acquirerMid" : "999999",
        "cardSchemas" : [ "BANKAXEPT" ]
      },
      "acquirerInfoStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:48.259896Z"
      }
    }, {
      "acquirerInfo" : {
        "acquirerName" : "ELAVONEUAER",
        "acquirerMid" : "999998",
        "cardSchemas" : [ "VISA", "MASTERCARD" ]
      },
      "acquirerInfoStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:48.274393Z"
      }
    } ],
    "paymentServiceStatus" : {
      "status" : "INITIALIZED",
      "timestamp" : "2024-04-15T12:42:48.247837714Z"
    }
  }, {
    "serviceId" : "L000010",
    "idLookup" : false,
    "commonName" : "Tipping",
    "activeFrom" : "2024-04-15",
    "mcc" : "5400",
    "reconAutoClose" : true,
    "acquirerInfoDetails" : [ {
      "acquirerInfo" : {
        "acquirerName" : "NETSSDI",
        "acquirerMid" : "999999",
        "cardSchemas" : [ "BANKAXEPT" ]
      },
      "acquirerInfoStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:48.359998Z"
      }
    } ],
    "paymentServiceStatus" : {
      "status" : "INITIALIZED",
      "timestamp" : "2024-04-15T12:42:48.345668759Z"
    }
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/merchants' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "organization" : {
    "organizationNumber" : "9999912345",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Normann",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    },
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    }
  },
  "merchant" : {
    "name" : "Acme Butikk",
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    },
    "locationAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    },
    "gln" : "1231231231232",
    "chainName" : "Acme chain",
    "chainId" : "9998",
    "customerRef" : "1034",
    "companyPhone" : "99999999",
    "companyEmail" : "acme@acme.no",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Normann",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    }
  },
  "terminalServices" : [ {
    "idLookup" : false,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "acquirerInfos" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "cardSchemas" : [ "BANKAXEPT" ]
    }, {
      "acquirerName" : "ELAVONEUAER",
      "acquirerMid" : "999998",
      "cardSchemas" : [ "VISA", "MASTERCARD" ]
    } ]
  }, {
    "idLookup" : false,
    "commonName" : "Tipping",
    "mcc" : "5400",
    "acquirerInfos" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "cardSchemas" : [ "BANKAXEPT" ]
    } ]
  } ]
}'

15.5.27. Search for all merchants

GET /tms/merchants/search
Description

Searching for all will return all merchant´s the user are allowed to search for. The response will return a subset of Merchant information.

Responses
HTTP Code Description Schema

200

OK

MerchantSearchResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Merchant

Example HTTP request
GET /tms/merchants/search HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 323

{
  "merchantInfo" : [ {
    "merchantId" : "DOC000001",
    "organizationNumber" : "9999912345",
    "name" : "Acme Butikk",
    "gln" : "1231231231232",
    "chainName" : "Acme chain",
    "chainId" : "9998",
    "customerRef" : "1034",
    "status" : "ACTIVE",
    "statusTime" : "2024-04-15T12:42:47.726355837Z"
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/merchants/search' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.28. Search for merchant

GET /tms/merchants/search/{searchType}/{searchValue}
Description

Search for merchants by organizationNumber, gln, chainId, chainName or customerRef. The response will return a subset of Merchant information.

Parameters
Type Name Description Schema

Path

searchType
required

What field to search on

enum (gln, chainName, chainId, customerRef, organizationNumber, groupId, productType, all)

Path

searchValue
required

What value to search for

string
Responses
HTTP Code Description Schema

200

OK

MerchantSearchResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Merchant

Example HTTP request
GET /tms/merchants/search/gln/1231231231232 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 323

{
  "merchantInfo" : [ {
    "merchantId" : "DOC000001",
    "organizationNumber" : "9999912345",
    "name" : "Acme Butikk",
    "gln" : "1231231231232",
    "chainName" : "Acme chain",
    "chainId" : "9998",
    "customerRef" : "1034",
    "status" : "ACTIVE",
    "statusTime" : "2024-04-15T12:42:47.908596533Z"
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/merchants/search/gln/1231231231232' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.29. Get Merchant

GET /tms/merchants/{merchantId}
Description

Get details on a merchant

Parameters
Type Name Schema

Path

merchantId
required

string
Responses
HTTP Code Description Schema

200

OK

MerchantResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Merchant

Example HTTP request
GET /tms/merchants/DOC000001/detail HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 2475

{
  "merchantDetail" : {
    "merchantId" : "DOC000001",
    "merchant" : {
      "name" : "Acme Butikk",
      "postalAddress" : {
        "street" : "Street 34",
        "postalArea" : "The Area",
        "postalCode" : "2020",
        "countryCode" : "NO"
      },
      "locationAddress" : {
        "street" : "Street 34",
        "postalArea" : "The Area",
        "postalCode" : "2020",
        "countryCode" : "NO"
      },
      "gln" : "1231231231232",
      "chainName" : "Acme chain",
      "chainId" : "9998",
      "customerRef" : "1034",
      "companyPhone" : "99999999",
      "companyEmail" : "acme@acme.no",
      "contact" : {
        "firstName" : "Ola",
        "lastName" : "Normann",
        "phone" : "99999999",
        "email" : "ola@acme.no"
      }
    },
    "merchantStatus" : {
      "status" : "ACTIVE",
      "timestamp" : "2024-04-15T12:42:48.090589731Z"
    }
  },
  "organizationDetail" : {
    "name" : "Acme Holding",
    "organizationNumber" : "9999912345",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Normann",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    },
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    }
  },
  "assetDetails" : [ {
    "product" : {
      "name" : "COOP Terminal payment",
      "productNumber" : "P-101",
      "productType" : "TERMINAL_PAYMENT",
      "businessService" : "TERMINAL",
      "groupId" : 3,
      "description" : "Test product for terminal payment",
      "requireSignAgreement" : false,
      "requireCustomerAmlCheck" : false,
      "requireAcquirerId" : false
    },
    "created" : "2024-04-15T12:42:48.090601074Z",
    "updated" : "2024-04-15T12:42:48.090601286Z",
    "status" : "ACTIVE"
  } ],
  "groupDetails" : [ {
    "id" : 3,
    "group" : {
      "name" : "Coop",
      "type" : "UMBRELLA"
    },
    "groupAttributes" : [ {
      "name" : "payment.projectCode",
      "value" : "COOP"
    }, {
      "name" : "payment.ipg3dsecureAcquirerBin.ELAVONEUAER.MASTERCARD",
      "value" : "123456"
    }, {
      "name" : "payment.ipg3dsecureAcquirerBin.ELAVONEUAER.VISA",
      "value" : "654321"
    }, {
      "name" : "payment.ipg3dsecureProcessorName.ELAVONEUAER.MASTERCARD",
      "value" : "PAY"
    }, {
      "name" : "payment.ipg3dsecureProcessorName.ELAVONEUAER.VISA",
      "value" : "PAY"
    } ]
  } ],
  "merchantConceptEnabled" : true
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/merchants/DOC000001/detail' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.30. Update merchant

PUT /tms/merchants/{merchantId}
Description

API call to update Merchant data in the TMS system. All data in Merchant Object will be replaced

Parameters
Type Name Schema

Path

merchantId
required

string
Body parameter

Name : body
Flags : required
Type : MerchantUpdateRequest

Responses
HTTP Code Description Schema

200

OK

MerchantResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Merchant

Example HTTP request
PUT /tms/merchants/DOC000001 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 678
Host: api.aerahost.com

{
  "merchant" : {
    "name" : "Acme butikk 2",
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    },
    "locationAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    },
    "gln" : "1231231231232",
    "chainName" : "Acme chain",
    "chainId" : "9998",
    "customerRef" : "1034",
    "companyPhone" : "99999999",
    "companyEmail" : "acme@acme.no",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Normann",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    }
  }
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1243

{
  "merchantId" : "DOC000001",
  "organizationDetail" : {
    "name" : "Acme Holding",
    "organizationNumber" : "9999912345",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Normann",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    },
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    }
  },
  "merchant" : {
    "name" : "Acme butikk 2",
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    },
    "locationAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    },
    "gln" : "1231231231232",
    "chainName" : "Acme chain",
    "chainId" : "9998",
    "customerRef" : "1034",
    "companyPhone" : "99999999",
    "companyEmail" : "acme@acme.no",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Normann",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    }
  },
  "groupDetails" : [ {
    "id" : 3,
    "group" : {
      "name" : "Coop",
      "type" : "UMBRELLA"
    },
    "groupAttributes" : [ ]
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/merchants/DOC000001' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "merchant" : {
    "name" : "Acme butikk 2",
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    },
    "locationAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    },
    "gln" : "1231231231232",
    "chainName" : "Acme chain",
    "chainId" : "9998",
    "customerRef" : "1034",
    "companyPhone" : "99999999",
    "companyEmail" : "acme@acme.no",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Normann",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    }
  }
}'

15.5.31. Get Merchant detail

GET /tms/merchants/{merchantId}/detail
Description

Get details on a merchant

Parameters
Type Name Schema

Path

merchantId
required

string
Responses
HTTP Code Description Schema

200

OK

CmsMerchantResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Merchant

15.5.32. Add Organization

POST /tms/organizations
Description

Add a new organization to the system

Body parameter

Name : body
Flags : required
Type : OrganizationRequest

Responses
HTTP Code Description Schema

201

Created

OrganizationResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Organization

Example HTTP request
POST /tms/organizations HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 358
Host: api.aerahost.com

{
  "organization" : {
    "organizationNumber" : "9999912345",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Normann",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    },
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    }
  }
}
Example HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 393

{
  "organizationDetail" : {
    "name" : "Acme Holding",
    "organizationNumber" : "9999912345",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Normann",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    },
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    }
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/organizations' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "organization" : {
    "organizationNumber" : "9999912345",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Normann",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    },
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    }
  }
}'

15.5.33. Get Organization

GET /tms/organizations/{orgNumber}
Description

Get organization details for a given organization number

Parameters
Type Name Schema

Path

orgNumber
required

string
Responses
HTTP Code Description Schema

200

OK

OrganizationResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Organization

Example HTTP request
GET /tms/organizations/9999912345 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 393

{
  "organizationDetail" : {
    "name" : "Acme Holding",
    "organizationNumber" : "9999912345",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Normann",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    },
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    }
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/organizations/9999912345' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.34. Update organization

PUT /tms/organizations/{orgNumber}
Description

API call to update Organization in the TMS system. All data in Organization Object will be replaced

Parameters
Type Name Schema

Path

orgNumber
required

string
Body parameter

Name : body
Flags : required
Type : OrganizationRequest

Responses
HTTP Code Description Schema

200

OK

OrganizationResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Organization

Example HTTP request
PUT /tms/organizations/9999912345 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 356
Host: api.aerahost.com

{
  "organization" : {
    "organizationNumber" : "9999912345",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Acme2",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    },
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    }
  }
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 391

{
  "organizationDetail" : {
    "name" : "Acme Holding",
    "organizationNumber" : "9999912345",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Acme2",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    },
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    }
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/organizations/9999912345' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "organization" : {
    "organizationNumber" : "9999912345",
    "contact" : {
      "firstName" : "Ola",
      "lastName" : "Acme2",
      "phone" : "99999999",
      "email" : "ola@acme.no"
    },
    "postalAddress" : {
      "street" : "Street 34",
      "postalArea" : "The Area",
      "postalCode" : "2020",
      "countryCode" : "NO"
    }
  }
}'

15.5.35. Get Payment Services by acquirerMid

GET /tms/pservices/acquirer/{acquirerMid}
Description

Returns a list of payment services holding the given acquirerMid

Parameters
Type Name Schema

Path

acquirerMid
required

string
Responses
HTTP Code Description Schema

200

OK

TerminalServiceListResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Payment service

15.5.36. Add Payment Service

POST /tms/pservices/add/{merchantId}
Description

Add a new payment service

Parameters
Type Name Schema

Path

merchantId
required

string
Body parameter

Name : body
Flags : required
Type : PaymentServiceRequest

Responses
HTTP Code Description Schema

201

Created

PaymentServiceResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Payment service

Example HTTP request
POST /tms/pservices/add/DOC000001 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 994
Host: api.aerahost.com

{
  "paymentService" : {
    "idLookup" : false,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "reconAutoClose" : true,
    "customerRef" : "CUST5353",
    "paymentAcquirers" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "BANKAXEPT",
        "paymentChannels" : [ "TERMINAL" ]
      } ]
    }, {
      "acquirerName" : "ELAVONEUAER",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "VISA",
        "paymentChannels" : [ "TERMINAL", "ONLINE" ],
        "paymentOptions" : [ {
          "paymentOptionType" : "D3SECURE",
          "paymentOptionJson" : "\"merchantId\":\"5298955\""
        } ]
      }, {
        "paymentSchemaName" : "MASTERCARD",
        "paymentChannels" : [ "ONLINE" ],
        "paymentOptions" : [ {
          "paymentOptionType" : "D3SECURE",
          "paymentOptionJson" : "\"merchantId\":\"5298955\""
        } ]
      } ]
    } ]
  }
}
Example HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1448

{
  "merchantId" : "DOC000001",
  "paymentService" : {
    "serviceId" : "L000017",
    "idLookup" : false,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "reconAutoClose" : true,
    "customerRef" : "CUST5353",
    "paymentAcquirers" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "BANKAXEPT",
        "paymentChannels" : [ "TERMINAL" ]
      } ],
      "paymentAcquirerStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:57.118758408Z"
      }
    }, {
      "acquirerName" : "ELAVONEUAER",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "VISA",
        "paymentChannels" : [ "TERMINAL", "ONLINE" ],
        "paymentOptions" : [ {
          "paymentOptionType" : "D3SECURE",
          "paymentOptionJson" : "{\"merchantId\":\"5298955\"}"
        } ]
      }, {
        "paymentSchemaName" : "MASTERCARD",
        "paymentChannels" : [ "ONLINE" ],
        "paymentOptions" : [ {
          "paymentOptionType" : "D3SECURE",
          "paymentOptionJson" : "{\"merchantId\":\"5298955\"}"
        } ]
      } ],
      "paymentAcquirerStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:57.126900351Z"
      }
    } ]
  },
  "paymentServiceStatus" : {
    "status" : "INITIALIZED",
    "timestamp" : "2024-04-15T12:42:57.112715481Z"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/pservices/add/DOC000001' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "paymentService" : {
    "idLookup" : false,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "reconAutoClose" : true,
    "customerRef" : "CUST5353",
    "paymentAcquirers" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "BANKAXEPT",
        "paymentChannels" : [ "TERMINAL" ]
      } ]
    }, {
      "acquirerName" : "ELAVONEUAER",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "VISA",
        "paymentChannels" : [ "TERMINAL", "ONLINE" ],
        "paymentOptions" : [ {
          "paymentOptionType" : "D3SECURE",
          "paymentOptionJson" : "\"merchantId\":\"5298955\""
        } ]
      }, {
        "paymentSchemaName" : "MASTERCARD",
        "paymentChannels" : [ "ONLINE" ],
        "paymentOptions" : [ {
          "paymentOptionType" : "D3SECURE",
          "paymentOptionJson" : "\"merchantId\":\"5298955\""
        } ]
      } ]
    } ]
  }
}'

15.5.37. Bulk update paymentService

PUT /tms/pservices/bulk
Description

Update all payment services matching criteria with changes

Body parameter

Name : body
Flags : required
Type : PaymentServiceBulkUpdateRequest

Responses
HTTP Code Description Schema

200

OK

PaymentServiceBulkUpdateResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Payment service

Example HTTP request
PUT /tms/pservices/bulk HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 351
Host: api.aerahost.com

{
  "bulkUpdateSearchType" : "ALL",
  "type" : "STANDARDKASSE",
  "reconAutoClose" : false,
  "acquirerInfoList" : [ {
    "acquirerName" : "NETSSDI",
    "paymentSchemas" : [ {
      "paymentSchemaName" : "NETSKG"
    }, {
      "paymentSchemaName" : "AMEX",
      "paymentChannels" : [ "ONLINE", "TERMINAL" ]
    } ],
    "operation" : "ADD"
  } ]
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 152

{
  "bulkUpdateSearchType" : "ALL",
  "type" : "STANDARDKASSE",
  "historyId" : 1,
  "updateStatus" : {
    "J000600" : "OK",
    "L000014" : "OK"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/pservices/bulk' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "bulkUpdateSearchType" : "ALL",
  "type" : "STANDARDKASSE",
  "reconAutoClose" : false,
  "acquirerInfoList" : [ {
    "acquirerName" : "NETSSDI",
    "paymentSchemas" : [ {
      "paymentSchemaName" : "NETSKG"
    }, {
      "paymentSchemaName" : "AMEX",
      "paymentChannels" : [ "ONLINE", "TERMINAL" ]
    } ],
    "operation" : "ADD"
  } ]
}'

15.5.38. Get bulk update list

GET /tms/pservices/bulk/list
Description

Get bulk update list

Parameters
Type Name Description Schema

Query

beginPeriod
optional

StartTime, default -90 days

string (date-time)

Query

endPeriod
optional

EndTime, default now

string (date-time)
Responses
HTTP Code Description Schema

200

OK

PaymentServiceBulkUpdateHistoriesResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Payment service

15.5.39. Get bulk update details

GET /tms/pservices/bulk/{historyId}
Description

Get bulk update details

Parameters
Type Name Schema

Path

historyId
required

integer (int64)
Responses
HTTP Code Description Schema

200

OK

PaymentServiceBulkUpdateHistoryDetailsResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Payment service

15.5.40. Get Payment Services by customer reference

GET /tms/pservices/cref/{customerRef}
Description

Get Payment Services by customer reference

Parameters
Type Name Schema

Path

customerRef
required

string
Responses
HTTP Code Description Schema

200

OK

< PaymentServiceResponse > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Payment service

Example HTTP request
GET /tms/pservices/cref/CUST5353 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 994
Host: api.aerahost.com

{
  "paymentService" : {
    "idLookup" : false,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "reconAutoClose" : true,
    "customerRef" : "CUST5353",
    "paymentAcquirers" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "BANKAXEPT",
        "paymentChannels" : [ "TERMINAL" ]
      } ]
    }, {
      "acquirerName" : "ELAVONEUAER",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "VISA",
        "paymentChannels" : [ "TERMINAL", "ONLINE" ],
        "paymentOptions" : [ {
          "paymentOptionType" : "D3SECURE",
          "paymentOptionJson" : "\"merchantId\":\"5298955\""
        } ]
      }, {
        "paymentSchemaName" : "MASTERCARD",
        "paymentChannels" : [ "ONLINE" ],
        "paymentOptions" : [ {
          "paymentOptionType" : "D3SECURE",
          "paymentOptionJson" : "\"merchantId\":\"5298955\""
        } ]
      } ]
    } ]
  }
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1443

[ {
  "merchantId" : "DOC000001",
  "paymentService" : {
    "serviceId" : "L000017",
    "idLookup" : false,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "reconAutoClose" : true,
    "customerRef" : "CUST5353",
    "paymentAcquirers" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "BANKAXEPT",
        "paymentChannels" : [ "TERMINAL" ]
      } ],
      "paymentAcquirerStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:57.118758Z"
      }
    }, {
      "acquirerName" : "ELAVONEUAER",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "VISA",
        "paymentChannels" : [ "ONLINE", "TERMINAL" ],
        "paymentOptions" : [ {
          "paymentOptionType" : "D3SECURE",
          "paymentOptionJson" : "{\"merchantId\":\"5298955\"}"
        } ]
      }, {
        "paymentSchemaName" : "MASTERCARD",
        "paymentChannels" : [ "ONLINE" ],
        "paymentOptions" : [ {
          "paymentOptionType" : "D3SECURE",
          "paymentOptionJson" : "{\"merchantId\":\"5298955\"}"
        } ]
      } ],
      "paymentAcquirerStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:57.126900Z"
      }
    } ]
  },
  "paymentServiceStatus" : {
    "status" : "INITIALIZED",
    "timestamp" : "2024-04-15T12:42:57.112715Z"
  }
} ]
Example Curl request
$ curl 'https://api.aerahost.com/tms/pservices/cref/CUST5353' -i -X GET \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "paymentService" : {
    "idLookup" : false,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "reconAutoClose" : true,
    "customerRef" : "CUST5353",
    "paymentAcquirers" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "BANKAXEPT",
        "paymentChannels" : [ "TERMINAL" ]
      } ]
    }, {
      "acquirerName" : "ELAVONEUAER",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "VISA",
        "paymentChannels" : [ "TERMINAL", "ONLINE" ],
        "paymentOptions" : [ {
          "paymentOptionType" : "D3SECURE",
          "paymentOptionJson" : "\"merchantId\":\"5298955\""
        } ]
      }, {
        "paymentSchemaName" : "MASTERCARD",
        "paymentChannels" : [ "ONLINE" ],
        "paymentOptions" : [ {
          "paymentOptionType" : "D3SECURE",
          "paymentOptionJson" : "\"merchantId\":\"5298955\""
        } ]
      } ]
    } ]
  }
}'

15.5.41. Update PaymentService customerRef

PATCH /tms/pservices/customerRef/{customerRef}/{serviceId}
Description

Return details on the payment service and terminals using this payment service

Parameters
Type Name Schema

Path

customerRef
required

string

Path

serviceId
required

string
Responses
HTTP Code Description Schema

200

OK

PaymentServiceResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Payment service

Example HTTP request
PATCH /tms/pservices/customerRef/11221122/L000014 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1469

{
  "merchantId" : "DOC000001",
  "paymentService" : {
    "serviceId" : "L000014",
    "idLookup" : false,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "reconAutoClose" : true,
    "customerRef" : "11221122",
    "type" : "STANDARDKASSE",
    "paymentAcquirers" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "BANKAXEPT",
        "paymentChannels" : [ "TERMINAL" ]
      } ],
      "paymentAcquirerStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:55.946883Z"
      }
    }, {
      "acquirerName" : "ELAVONEUAER",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "VISA",
        "paymentChannels" : [ "ONLINE", "TERMINAL" ],
        "paymentOptions" : [ {
          "paymentOptionType" : "D3SECURE",
          "paymentOptionJson" : "{\"merchantId\":\"5298955\"}"
        } ]
      }, {
        "paymentSchemaName" : "MASTERCARD",
        "paymentChannels" : [ "ONLINE" ],
        "paymentOptions" : [ {
          "paymentOptionType" : "D3SECURE",
          "paymentOptionJson" : "{\"merchantId\":\"5298955\"}"
        } ]
      } ],
      "paymentAcquirerStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:55.975780Z"
      }
    } ]
  },
  "paymentServiceStatus" : {
    "status" : "INITIALIZED",
    "timestamp" : "2024-04-15T12:42:55.928566Z"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/pservices/customerRef/11221122/L000014' -i -X PATCH \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.42. Get Payment Services by merchantId

GET /tms/pservices/list/{merchantId}
Description

Returns a list of payment services registered on a given merchant

Parameters
Type Name Schema

Path

merchantId
required

string
Responses
HTTP Code Description Schema

200

OK

TerminalServiceListResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Payment service

Example HTTP request
GET /tms/pservices/list/DOC000001 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 567

{
  "merchantId" : "DOC000001",
  "serviceList" : [ {
    "serviceId" : "J000098",
    "status" : "ACTIVE"
  }, {
    "serviceId" : "J000099",
    "status" : "INITIALIZED"
  }, {
    "serviceId" : "J000400",
    "status" : "INACTIVE"
  }, {
    "serviceId" : "J000401",
    "status" : "ACTIVE"
  }, {
    "serviceId" : "L000009",
    "commonName" : "Kasse",
    "status" : "ACTIVE"
  }, {
    "serviceId" : "L000010",
    "commonName" : "Tipping",
    "status" : "ACTIVE"
  }, {
    "serviceId" : "L000012",
    "commonName" : "Kasse",
    "status" : "ACTIVE"
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/pservices/list/DOC000001' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.43. Search for all payment services

GET /tms/pservices/search
Description

Search for all payment services. This search will return a subset of payment service and Merchant information.

Responses
HTTP Code Description Schema

200

OK

PaymentServiceSearchResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Payment service

15.5.44. Search for PaymentServices

GET /tms/pservices/search/{searchType}/{searchValue}
Description

Search for all payment services using by gln, chainName, chainId, customerRef or organizationNumber. This search will return a subset of subset of payment service and Merchant information.

Parameters
Type Name Description Schema

Path

searchType
required

What field to search on

enum (gln, chainName, chainId, customerRef, organizationNumber, groupId, productType, all)

Path

searchValue
required

What value to search for

string
Responses
HTTP Code Description Schema

200

OK

PaymentServiceSearchResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Payment service

15.5.45. Get Payment Service

GET /tms/pservices/{serviceId}
Description

Return details on the payment service and terminals using this payment service

Parameters
Type Name Schema

Path

serviceId
required

string
Responses
HTTP Code Description Schema

200

OK

PaymentServiceResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Payment service

Example HTTP request
GET /tms/pservices/L000012 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1407

{
  "merchantId" : "DOC000001",
  "paymentService" : {
    "serviceId" : "L000012",
    "idLookup" : false,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "reconAutoClose" : true,
    "paymentAcquirers" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "BANKAXEPT",
        "paymentChannels" : [ "TERMINAL" ]
      } ],
      "paymentAcquirerStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:54.688424Z"
      }
    }, {
      "acquirerName" : "ELAVONEUAER",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "VISA",
        "paymentChannels" : [ "ONLINE", "TERMINAL" ],
        "paymentOptions" : [ {
          "paymentOptionType" : "D3SECURE",
          "paymentOptionJson" : "{\"merchantId\":\"5298955\"}"
        } ]
      }, {
        "paymentSchemaName" : "MASTERCARD",
        "paymentChannels" : [ "ONLINE" ],
        "paymentOptions" : [ {
          "paymentOptionType" : "D3SECURE",
          "paymentOptionJson" : "{\"merchantId\":\"5298955\"}"
        } ]
      } ],
      "paymentAcquirerStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:54.700624Z"
      }
    } ]
  },
  "paymentServiceStatus" : {
    "status" : "INITIALIZED",
    "timestamp" : "2024-04-15T12:42:54.665490Z"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/pservices/L000012' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.46. Update payment service

PUT /tms/pservices/{serviceId}
Description

Updates a payment service. All existing values for the payment service will be replaced with values in this message

Parameters
Type Name Schema

Path

serviceId
required

string
Body parameter

Name : body
Flags : required
Type : PaymentServiceRequest

Responses
HTTP Code Description Schema

200

OK

PaymentServiceResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Payment service

Example HTTP request
PUT /tms/pservices/L000012 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 575
Host: api.aerahost.com

{
  "paymentService" : {
    "serviceId" : "L000012",
    "idLookup" : true,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "reconAutoClose" : true,
    "paymentAcquirers" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "VISA",
        "paymentChannels" : [ "TERMINAL" ]
      } ]
    }, {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999998",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "VISA",
        "paymentChannels" : [ "ONLINE" ]
      } ]
    } ]
  }
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 992

{
  "merchantId" : "DOC000001",
  "paymentService" : {
    "serviceId" : "L000012",
    "idLookup" : true,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "reconAutoClose" : true,
    "paymentAcquirers" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "VISA",
        "paymentChannels" : [ "TERMINAL" ]
      } ],
      "paymentAcquirerStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:55.117859364Z"
      }
    }, {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999998",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "VISA",
        "paymentChannels" : [ "ONLINE" ]
      } ],
      "paymentAcquirerStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:55.129412905Z"
      }
    } ]
  },
  "paymentServiceStatus" : {
    "status" : "PENDING",
    "timestamp" : "2024-04-15T12:42:55.084163035Z"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/pservices/L000012' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "paymentService" : {
    "serviceId" : "L000012",
    "idLookup" : true,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "reconAutoClose" : true,
    "paymentAcquirers" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "VISA",
        "paymentChannels" : [ "TERMINAL" ]
      } ]
    }, {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999998",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "VISA",
        "paymentChannels" : [ "ONLINE" ]
      } ]
    } ]
  }
}'

15.5.47. Delete payment service

DELETE /tms/pservices/{serviceId}
Description

Removes a payment service from the system.
No active terminals can be using the payment service, and no pending terminal orders using this payment service can exists

Parameters
Type Name Schema

Path

serviceId
required

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Payment service

Example HTTP request
DELETE /tms/pservices/L000012 HTTP/1.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Example Curl request
$ curl 'https://api.aerahost.com/tms/pservices/L000012' -i -X DELETE \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.48. Update paymentService status

PUT /tms/pservices/{serviceId}/{status}
Description

Activate/inactivate a PaymentService. An inactive PaymentService will disable all payments on given PaymentService.

Parameters
Type Name Schema

Path

serviceId
required

string

Path

status
required

enum (ACTIVE, INACTIVE)
Responses
HTTP Code Description Schema

200

OK

PaymentServiceResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Payment service

Example HTTP request
PUT /tms/pservices/L000012/INACTIVE HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 985

{
  "merchantId" : "DOC000001",
  "paymentService" : {
    "serviceId" : "L000012",
    "idLookup" : true,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "reconAutoClose" : true,
    "paymentAcquirers" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "VISA",
        "paymentChannels" : [ "TERMINAL" ]
      } ],
      "paymentAcquirerStatusDetail" : {
        "status" : "ACTIVE",
        "timestamp" : "2024-04-15T12:42:55.222270Z"
      }
    }, {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999998",
      "paymentSchemas" : [ {
        "paymentSchemaName" : "VISA",
        "paymentChannels" : [ "ONLINE" ]
      } ],
      "paymentAcquirerStatusDetail" : {
        "status" : "ACTIVE",
        "timestamp" : "2024-04-15T12:42:55.232430Z"
      }
    } ]
  },
  "paymentServiceStatus" : {
    "status" : "INACTIVE_PENDING",
    "timestamp" : "2024-04-15T12:42:55.389154627Z"
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/pservices/L000012/INACTIVE' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.49. Get RMA list

GET /tms/rma
Description

Get RMA list

Parameters
Type Name Description Schema

Query

beginPeriod
optional

StartTime, default -90 days

string (date-time)

Query

endPeriod
optional

EndTime, default now

string (date-time)
Responses
HTTP Code Description Schema

200

OK

< RmaListInfo > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • RMA

15.5.50. Get RMA list for all customers

GET /tms/rma/all
Description

Get RMA list for all customers

Parameters
Type Name Description Schema

Query

beginPeriod
optional

StartTime, default -90 days

string (date-time)

Query

endPeriod
optional

EndTime, default now

string (date-time)
Responses
HTTP Code Description Schema

200

OK

< RmaListInfo > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • RMA

15.5.51. Get RMA schema across all customers

GET /tms/rma/all/{rmaId}
Description

Get RMA schema across all customers

Parameters
Type Name Schema

Path

rmaId
required

integer (int64)
Responses
HTTP Code Description Schema

200

OK

RmaResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • RMA

15.5.52. Update Aera RMA Schema access all customers

PUT /tms/rma/all/{rmaId}
Description

Update RMA Schema with Aera details across all customers

Parameters
Type Name Schema

Path

rmaId
required

integer (int64)
Body parameter

Name : body
Flags : required
Type : RmaAeraRequest

Responses
HTTP Code Description Schema

200

OK

RmaResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • RMA

15.5.53. Add RMA Schema

POST /tms/rma/cust
Description

Add RMA Schema

Body parameter

Name : body
Flags : required
Type : RmaFSRequest

Responses
HTTP Code Description Schema

201

Created

RmaResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • RMA

Example HTTP request
POST /tms/rma/cust HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 286
Host: api.aerahost.com

{
  "reason" : "Display is dark",
  "comment" : "Restarted terminal, but display is still dark",
  "resetPerformed" : true,
  "resetOk" : true,
  "returnTerminal" : true,
  "replacedDueToError" : true,
  "cablesReplaced" : false,
  "terminalMoved" : false,
  "terminalId" : "AE123456"
}
Example HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 613

{
  "reason" : "Display is dark",
  "comment" : "Restarted terminal, but display is still dark",
  "resetPerformed" : true,
  "resetOk" : true,
  "returnTerminal" : true,
  "replacedDueToError" : true,
  "cablesReplaced" : false,
  "terminalMoved" : false,
  "rmaId" : 2,
  "terminalId" : "AE123456",
  "serialNumber" : "112233445566",
  "merchantId" : "DOC000001",
  "deviceType" : "LANE_5000",
  "status" : "INITIALIZED",
  "statusTime" : "2024-04-15T12:42:34.388497495Z",
  "createdBy" : "27c47cca-c1b8-4ccf-93f5-c51d7ebc5f8c",
  "created" : "2024-04-15T12:42:34.388498635Z",
  "merchantName" : "Acme Butikk"
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/rma/cust' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "reason" : "Display is dark",
  "comment" : "Restarted terminal, but display is still dark",
  "resetPerformed" : true,
  "resetOk" : true,
  "returnTerminal" : true,
  "replacedDueToError" : true,
  "cablesReplaced" : false,
  "terminalMoved" : false,
  "terminalId" : "AE123456"
}'

15.5.54. Update RMA Schema

PUT /tms/rma/cust/{rmaId}
Description

Update RMA Schema with customer details

Parameters
Type Name Schema

Path

rmaId
required

integer (int64)
Body parameter

Name : body
Flags : required
Type : RmaFieldService

Responses
HTTP Code Description Schema

200

OK

RmaResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • RMA

15.5.55. Get RMA schema

GET /tms/rma/{rmaId}
Description

Get RMA schema

Parameters
Type Name Schema

Path

rmaId
required

integer (int64)
Responses
HTTP Code Description Schema

200

OK

RmaResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • RMA

15.5.56. Update Aera RMA Schema

PUT /tms/rma/{rmaId}
Description

Update RMA Schema with Aera details

Parameters
Type Name Schema

Path

rmaId
required

integer (int64)
Body parameter

Name : body
Flags : required
Type : RmaAeraRequest

Responses
HTTP Code Description Schema

200

OK

RmaResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • RMA

15.5.57. Delete RMA Schema

DELETE /tms/rma/{rmaId}
Description

Delete RMA Schema

Parameters
Type Name Description Schema

Path

rmaId
required

Id on RMA schema

integer (int64)
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • RMA

15.5.58. Add Terminal Service

POST /tms/services
Description

A terminal service is a collection of Acquirers and CardSchemes used to handle terminal payments in the Aera Payment Gateway.

Body parameter

Name : body
Flags : required
Type : TerminalServiceCreateRequest

Responses
HTTP Code Description Schema

201

Created

TerminalServiceResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • terminal-service-controller

Example HTTP request
POST /tms/services HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 397
Host: api.aerahost.com

{
  "merchantId" : "DOC000001",
  "terminalService" : {
    "idLookup" : false,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "acquirerInfos" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "cardSchemas" : [ "BANKAXEPT" ]
    }, {
      "acquirerName" : "ELAVONEUAER",
      "acquirerMid" : "999998",
      "cardSchemas" : [ "VISA", "MASTERCARD" ]
    } ]
  }
}
Example HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 965

{
  "merchantId" : "DOC000001",
  "terminalServiceDetail" : {
    "serviceId" : "L000006",
    "idLookup" : false,
    "commonName" : "Kasse",
    "activeFrom" : "2024-04-15",
    "mcc" : "5411",
    "reconAutoClose" : true,
    "acquirerInfoDetails" : [ {
      "acquirerInfo" : {
        "acquirerName" : "NETSSDI",
        "acquirerMid" : "999999",
        "cardSchemas" : [ "BANKAXEPT" ]
      },
      "acquirerInfoStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:33.371194Z"
      }
    }, {
      "acquirerInfo" : {
        "acquirerName" : "ELAVONEUAER",
        "acquirerMid" : "999998",
        "cardSchemas" : [ "VISA", "MASTERCARD" ]
      },
      "acquirerInfoStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:33.381017Z"
      }
    } ],
    "paymentServiceStatus" : {
      "status" : "INITIALIZED",
      "timestamp" : "2024-04-15T12:42:33.362377782Z"
    }
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/services' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "merchantId" : "DOC000001",
  "terminalService" : {
    "idLookup" : false,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "acquirerInfos" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "cardSchemas" : [ "BANKAXEPT" ]
    }, {
      "acquirerName" : "ELAVONEUAER",
      "acquirerMid" : "999998",
      "cardSchemas" : [ "VISA", "MASTERCARD" ]
    } ]
  }
}'

15.5.59. Get Terminal Services by merchantId

GET /tms/services/list/{merchantId}
Description

Returns a list of terminal services registered on a given merchant

Parameters
Type Name Schema

Path

merchantId
required

string
Responses
HTTP Code Description Schema

200

OK

TerminalServiceListResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • terminal-service-controller

Example HTTP request
GET /tms/services/list/DOC000001 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 329

{
  "merchantId" : "DOC000001",
  "serviceList" : [ {
    "serviceId" : "J000098",
    "commonName" : "Kasse",
    "status" : "ACTIVE"
  }, {
    "serviceId" : "J000099",
    "status" : "INITIALIZED"
  }, {
    "serviceId" : "J000400",
    "status" : "ACTIVE"
  }, {
    "serviceId" : "J000401",
    "status" : "INACTIVE"
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/services/list/DOC000001' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.60. Get Terminal Service

GET /tms/services/{serviceId}
Description

Return details on the terminal service and terminals using this terminal service

Parameters
Type Name Schema

Path

serviceId
required

string
Responses
HTTP Code Description Schema

200

OK

TerminalServiceResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • terminal-service-controller

Example HTTP request
GET /tms/services/J000098 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1736

{
  "merchantId" : "DOC000001",
  "terminalServiceDetail" : {
    "serviceId" : "J000098",
    "idLookup" : true,
    "activeFrom" : "2024-04-15",
    "mcc" : "5411",
    "reconAutoClose" : true,
    "acquirerInfoDetails" : [ {
      "acquirerInfo" : {
        "acquirerName" : "ELAVONEUAER",
        "acquirerMid" : "999998",
        "cardSchemas" : [ "BANKAXEPT", "MASTERCARD" ]
      },
      "acquirerInfoStatusDetail" : {
        "status" : "ACTIVE",
        "timestamp" : "2024-04-15T12:42:30.564418Z"
      }
    }, {
      "acquirerInfo" : {
        "acquirerName" : "NETSSDI",
        "acquirerMid" : "999999",
        "cardSchemas" : [ ]
      },
      "acquirerInfoStatusDetail" : {
        "status" : "INACTIVE",
        "timestamp" : "2024-04-15T12:42:30.583018Z"
      }
    } ],
    "paymentServiceStatus" : {
      "status" : "ACTIVE",
      "timestamp" : "2024-04-15T12:42:30.472196Z"
    }
  },
  "terminalInfos" : [ {
    "terminalId" : "AE123456",
    "serialNumber" : "112233445566",
    "deviceType" : "LANE_5000",
    "created" : "2024-04-15T12:42:30.659043Z",
    "terminalStatusInfo" : {
      "status" : "ACTIVE",
      "timestamp" : "2024-04-15T12:42:30.659043Z"
    }
  }, {
    "terminalId" : "AE998877",
    "serialNumber" : "556677889900",
    "deviceType" : "LANE_5000",
    "created" : "2024-04-15T12:42:30.682245Z",
    "terminalStatusInfo" : {
      "status" : "ACTIVE",
      "timestamp" : "2024-04-15T12:42:30.682245Z"
    }
  }, {
    "terminalId" : "AE998899",
    "serialNumber" : "556677889999",
    "deviceType" : "LANE_5000",
    "created" : "2024-04-15T12:42:30.696463Z",
    "terminalStatusInfo" : {
      "status" : "PENDING",
      "timestamp" : "2024-04-15T12:42:30.696462Z"
    }
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/services/J000098' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.61. Update terminal service

PUT /tms/services/{serviceId}
Description

Updates a terminal service. All existing values for the terminal service will be replaced with values in this message

Parameters
Type Name Schema

Path

serviceId
required

string
Body parameter

Name : body
Flags : required
Type : TerminalServiceRequest

Responses
HTTP Code Description Schema

200

OK

TerminalServiceResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • terminal-service-controller

Example HTTP request
PUT /tms/services/J000098 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 367
Host: api.aerahost.com

{
  "terminalService" : {
    "idLookup" : false,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "acquirerInfos" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "cardSchemas" : [ "BANKAXEPT" ]
    }, {
      "acquirerName" : "ELAVONEUAER",
      "acquirerMid" : "999998",
      "cardSchemas" : [ "VISA", "MASTERCARD" ]
    } ]
  }
}
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 961

{
  "merchantId" : "DOC000001",
  "terminalServiceDetail" : {
    "serviceId" : "J000098",
    "idLookup" : false,
    "commonName" : "Kasse",
    "activeFrom" : "2024-04-15",
    "mcc" : "5411",
    "reconAutoClose" : true,
    "acquirerInfoDetails" : [ {
      "acquirerInfo" : {
        "acquirerName" : "NETSSDI",
        "acquirerMid" : "999999",
        "cardSchemas" : [ "BANKAXEPT" ]
      },
      "acquirerInfoStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:32.830072Z"
      }
    }, {
      "acquirerInfo" : {
        "acquirerName" : "ELAVONEUAER",
        "acquirerMid" : "999998",
        "cardSchemas" : [ "VISA", "MASTERCARD" ]
      },
      "acquirerInfoStatusDetail" : {
        "status" : "INITIALIZED",
        "timestamp" : "2024-04-15T12:42:32.859237Z"
      }
    } ],
    "paymentServiceStatus" : {
      "status" : "PENDING",
      "timestamp" : "2024-04-15T12:42:32.802462786Z"
    }
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/services/J000098' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "terminalService" : {
    "idLookup" : false,
    "commonName" : "Kasse",
    "mcc" : "5411",
    "acquirerInfos" : [ {
      "acquirerName" : "NETSSDI",
      "acquirerMid" : "999999",
      "cardSchemas" : [ "BANKAXEPT" ]
    }, {
      "acquirerName" : "ELAVONEUAER",
      "acquirerMid" : "999998",
      "cardSchemas" : [ "VISA", "MASTERCARD" ]
    } ]
  }
}'

15.5.62. Delete terminal service

DELETE /tms/services/{serviceId}
Description

Removes a terminal service from the system.
No active terminals can be using the terminal service, and no pending terminal orders using this terminal service can exists

Parameters
Type Name Schema

Path

serviceId
required

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • terminal-service-controller

Example HTTP request
DELETE /tms/services/J000099 HTTP/1.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 204 No Content
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Example Curl request
$ curl 'https://api.aerahost.com/tms/services/J000099' -i -X DELETE \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.63. Update terminalService status

PUT /tms/services/{serviceId}/{status}
Description

Activate/inactivate a TerminalService. An inactive TerminalService will disable payment on all terminals registered on TerminalService.

Parameters
Type Name Schema

Path

serviceId
required

string

Path

status
required

enum (ACTIVE, INACTIVE)
Responses
HTTP Code Description Schema

200

OK

TerminalServiceResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • terminal-service-controller

Example HTTP request
PUT /tms/services/J000401/INACTIVE HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 362

{
  "merchantId" : "DOC000001",
  "terminalServiceDetail" : {
    "serviceId" : "J000401",
    "idLookup" : false,
    "activeFrom" : "2024-04-15",
    "mcc" : "5400",
    "reconAutoClose" : true,
    "acquirerInfoDetails" : [ ],
    "paymentServiceStatus" : {
      "status" : "INACTIVE_PENDING",
      "timestamp" : "2024-04-15T12:42:32.027766488Z"
    }
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/services/J000401/INACTIVE' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.64. Send activate request to Aevi

POST /tms/support/aevi/activate
Description

Aera specific API

Body parameter

Name : body
Flags : required
Type : ActivateRequestTms

Responses
HTTP Code Description Schema

200

OK

ActivateResponseTms

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Support

15.5.65. Get Aevi messages

GET /tms/support/aevi/messages
Description

Aera specific API to fetch sync jobs agains Aevi

Responses
HTTP Code Description Schema

200

OK

< AeviMessage > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.66. Get Aevi messages between dates

GET /tms/support/aevi/messages/between/{fromDate}/{toDate}
Description

Aera specific API to fetch sync jobs agains Aevi

Parameters
Type Name Schema

Path

fromDate
required

string (date)

Path

toDate
required

string (date)
Responses
HTTP Code Description Schema

200

OK

< AeviMessage > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.67. Send get orders request to Aevi

POST /tms/support/aevi/orders
Description

Aera specific API

Body parameter

Name : body
Flags : required
Type : GetOrdersRequestTms

Responses
HTTP Code Description Schema

200

OK

GetOrdersResponseTms

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Support

15.5.68. Send service request to Aevi

POST /tms/support/aevi/services
Description

Aera specific API

Body parameter

Name : body
Flags : required
Type : ServiceRequestTms

Responses
HTTP Code Description Schema

200

OK

ServiceResponseTms

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Support

15.5.69. Get audit logs

GET /tms/support/audits
Description

Aera specific API

Responses
HTTP Code Description Schema

200

OK

< AuditLogDb > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.70. Get audit logs for item

GET /tms/support/audits/{objectType}/{objectId}
Description

Aera specific API

Parameters
Type Name Schema

Path

objectId
required

string

Path

objectType
required

enum (MERCHANT, PAYMENTSERVICE, TERMINAL, CONFIGPROFILE, DEPLOY, STOCK, RMASCHEMA)
Responses
HTTP Code Description Schema

200

OK

< AuditLogDb > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.71. Get BAX messages

GET /tms/support/bankaxept/messages
Description

Aera specific API to fetch sync jobs agains BankAxept

Responses
HTTP Code Description Schema

200

OK

< BankaxeptMessage > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.72. Get BAX messages between dates

GET /tms/support/bankaxept/messages/between/{fromDate}/{toDate}
Description

Aera specific API to fetch sync jobs agains BankAxept

Parameters
Type Name Schema

Path

fromDate
required

string (date)

Path

toDate
required

string (date)
Responses
HTTP Code Description Schema

200

OK

< BankaxeptMessage > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.73. Get BAX messages by merchantId

GET /tms/support/bankaxept/messages/{merchantId}
Description

Aera specific API to fetch sync jobs agains BankAxept

Parameters
Type Name Schema

Path

merchantId
required

string
Responses
HTTP Code Description Schema

200

OK

< BankaxeptMessage > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.74. Get BAX products

GET /tms/support/bankaxept/products/{orgNumber}/{baxNumber}/{settlementAccount}
Description

Aera specific API to fetch products of an existing bax number from BankAxept

Parameters
Type Name Schema

Path

baxNumber
required

string

Path

orgNumber
required

string

Path

settlementAccount
required

string
Responses
HTTP Code Description Schema

200

OK

< ProductInfoDetail > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.75. Get chains for client

GET /tms/support/chains
Description

Aera specific API

Responses
HTTP Code Description Schema

200

OK

CmsGroupListResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.76. Get controller id

GET /tms/support/cid
Description

Aera specific API

Responses
HTTP Code Description Schema

200

OK

string

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.77. Get current configuration

GET /tms/support/config/{terminalId}
Description

Aera specific API
Will get the current configuration running on the terminal

Parameters
Type Name Schema

Path

terminalId
required

string
Responses
HTTP Code Description Schema

200

OK

CurrentTerminalConfigResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.78. Get config deployments

GET /tms/support/deploy
Description

Aera specific API

Responses
HTTP Code Description Schema

200

OK

< ConfigDeploymentInfo > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.79. Get config deployment details

GET /tms/support/deploy/{configDeploymentId}
Description

Aera specific API

Parameters
Type Name Schema

Path

configDeploymentId
required

string
Responses
HTTP Code Description Schema

200

OK

ConfigDeploymentInfo

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.80. Cancel config deployment

PUT /tms/support/deploy/{configDeploymentId}
Description

Aera specific API

Parameters
Type Name Schema

Path

configDeploymentId
required

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.81. Get groups for client

GET /tms/support/groups
Description

Aera specific API

Responses
HTTP Code Description Schema

200

OK

CmsGroupListResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.82. Register sale of terminal

POST /tms/support/invoice/sale
Description

Aera specific API

Body parameter

Name : body
Flags : required
Type : RegisterSoldTerminalRequest

Responses
HTTP Code Description Schema

200

OK

RegisterSoldTerminalResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Support

15.5.83. Get sold terminals by customerId

GET /tms/support/invoice/soldterminals
Description

Aera specific API

Responses
HTTP Code Description Schema

200

OK

< SoldTerminalResponse > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.84. Get IPG messages

GET /tms/support/ipg/messages
Description

Aera specific API to fetch sync jobs agains acoustic

Responses
HTTP Code Description Schema

200

OK

< IpgMessage > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.85. Get IPG messages between dates

GET /tms/support/ipg/messages/between/{fromDate}/{toDate}
Description

Aera specific API to fetch sync jobs agains acoustic

Parameters
Type Name Schema

Path

fromDate
required

string (date)

Path

toDate
required

string (date)
Responses
HTTP Code Description Schema

200

OK

< IpgMessage > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.86. Send Get PaymentDevice to IPG

GET /tms/support/ipg/pdd/{termId}
Description

Aera specific API

Parameters
Type Name Schema

Path

termId
required

string
Responses
HTTP Code Description Schema

200

OK

string

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.87. Send Delete PaymentDevice to IPG

DELETE /tms/support/ipg/pdd/{termId}/{prj}
Description

Aera specific API

Parameters
Type Name Schema

Path

prj
required

string

Path

termId
required

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.88. Send Get PaymentRouting to IPG

GET /tms/support/ipg/rou/{prj}/{cty}/{sto}
Description

Aera specific API

Parameters
Type Name Schema

Path

cty
required

string

Path

prj
required

string

Path

sto
required

string
Responses
HTTP Code Description Schema

200

OK

PaymentRoutingMessage

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.89. Send Delete PaymentRouting to IPG

DELETE /tms/support/ipg/rou/{prj}/{cty}/{sto}
Description

Aera specific API

Parameters
Type Name Schema

Path

cty
required

string

Path

prj
required

string

Path

sto
required

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.90. Get MerchantId to ServiceId mapping

GET /tms/support/merchant/paymentservice/list
Description

Aera specific API

Responses
HTTP Code Description Schema

200

OK

< MerchantIdPaymentServiceId > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.91. Generate and send report

GET /tms/support/reports
Description

Aera specific API

Parameters
Type Name Schema

Query

monthsBack
optional

integer (int32)

Query

reportType
required

enum (AUDIT, BAX, CUSTOM_TERMINAL, INVOICE, RMA, TERMINAL_RETURN, TERMINAL_ERROR)

Query

toEmails
optional

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.92. Generate and send Audit report

GET /tms/support/reports/audit
Description

Aera specific API

Parameters
Type Name Schema

Query

monthsBack
optional

integer (int32)

Query

toEmails
optional

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.93. Generate and send BAX report

GET /tms/support/reports/bax
Description

Aera specific API

Parameters
Type Name Schema

Query

toEmails
optional

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.94. Generate and send Rma report

GET /tms/support/reports/rma
Description

Aera specific API

Parameters
Type Name Schema

Query

monthsBack
optional

integer (int32)

Query

toEmails
optional

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.95. Generate and send Terminal Error report

GET /tms/support/reports/terminalerror
Description

Aera specific API

Parameters
Type Name Schema

Query

toEmails
optional

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.96. Generate and send Terminal Return report

GET /tms/support/reports/terminalreturn
Description

Aera specific API

Parameters
Type Name Schema

Query

toEmails
optional

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.97. Get shipmentInfo query

POST /tms/support/shipment/search
Description

Aera specific API

Body parameter

Name : body
Flags : required
Type : ShipmentQueryRequest

Responses
HTTP Code Description Schema

200

OK

< ShipmentInfoResponse > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Support

15.5.98. Get Aera stock balance

GET /tms/support/stock/balance
Description

Aera specific API

Responses
HTTP Code Description Schema

200

OK

< FsStockBalance > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.99. Get terminal history

GET /tms/support/terminal/history/{serialNumber}
Description

Aera specific API

Parameters
Type Name Schema

Path

serialNumber
required

string
Responses
HTTP Code Description Schema

200

OK

< TerminalHistory > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.100. Get Terminal models by groupId

GET /tms/support/terminal/models/{groupId}
Description

Get available terminal models by group

Parameters
Type Name Schema

Path

groupId
required

integer (int32)
Responses
HTTP Code Description Schema

200

OK

TerminalModelResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.101. Get back all TID in request token has access to

PATCH /tms/support/terminal/wash
Description

Aera specific API

Body parameter

Name : body
Flags : required
Type : < string > array

Responses
HTTP Code Description Schema

200

OK

< string > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Support

Example HTTP request
PATCH /tms/support/terminal/wash HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 38
Host: api.aerahost.com

[ "AE123456", "AE998877", "AA123123" ]
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 26

[ "AE123456", "AE998877" ]
Example Curl request
$ curl 'https://api.aerahost.com/tms/support/terminal/wash' -i -X PATCH \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '[ "AE123456", "AE998877", "AA123123" ]'

15.5.102. Get tasks

GET /tms/support/wf/tasks
Description

Aera specific API

Parameters
Type Name Description Schema

Query

taskStatus
optional

Filter tasks by status

enum (INITIALIZED, COMPLETED, FAILED, PENDING)
Responses
HTTP Code Description Schema

200

OK

TaskListResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.103. Update tasks

PUT /tms/support/wf/tasks/{taskId}/{status}
Description

Aera specific API

Parameters
Type Name Schema

Path

status
required

string

Path

taskId
required

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Support

15.5.104. Get Terminals by merchant

GET /tms/terminals/merchant/{merchantId}
Description

Get a list of all terminals registered on a merchant

Parameters
Type Name Schema

Path

merchantId
required

string
Responses
HTTP Code Description Schema

200

OK

TerminalShortListResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Terminal

Example HTTP request
GET /tms/terminals/merchant/DOC000001 HTTP/1.1
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 746

{
  "merchantId" : "DOC000001",
  "terminalInfo" : [ {
    "terminalId" : "AE123456",
    "deviceType" : "LANE_5000",
    "paymentServiceId" : "J000098",
    "configLabel" : "Tipping_CL",
    "configVersion" : "1.0",
    "serialnumber" : "112233445566",
    "status" : "ACTIVE"
  }, {
    "terminalId" : "AE998877",
    "deviceType" : "LANE_5000",
    "paymentServiceId" : "J000098",
    "configLabel" : "Tipping_CL",
    "configVersion" : "1.0",
    "serialnumber" : "556677889900",
    "status" : "ACTIVE"
  }, {
    "terminalId" : "AE998899",
    "deviceType" : "LANE_5000",
    "paymentServiceId" : "J000098",
    "configLabel" : "Tipping_CL",
    "configVersion" : "1.0",
    "serialnumber" : "556677889999",
    "status" : "PENDING"
  } ]
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/terminals/merchant/DOC000001' -i -X GET \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.105. Order terminal

POST /tms/terminals/order/{serviceId}
Description

API call to order a new Terminal with optional accessories. When terminal is ordered a terminalId will be created by the TMS and returned in the response. If the customer uses a third party Field Service partner, the order information (including terminalId, configLabel and serviceId) will be sent to the Field service partner, and this information will be used to activate the physical terminal at the merchant location.

Parameters
Type Name Description Schema

Path

serviceId
required

Terminal service to be used by the new terminal

string
Body parameter

Name : body
Flags : required
Type : TerminalRequest

Responses
HTTP Code Description Schema

201

Created

TerminalResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Terminal

Example HTTP request
POST /tms/terminals/order/L000095 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Content-Length: 306
Host: api.aerahost.com

{
  "terminal" : {
    "deviceType" : "LANE_5000",
    "terminalConfigInfo" : {
      "configLabel" : "Tipping_CL",
      "configDeploymentTag" : 1
    }
  },
  "terminalShipmentData" : {
    "requestedDeliveryDate" : "2024-04-15",
    "shipmentMethod" : "TECHNICIAN",
    "orderUrgency" : "NEXT_DAY"
  }
}
Example HTTP response
HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 429

{
  "terminalData" : {
    "terminalId" : "AE426060",
    "serviceId" : "L000095",
    "deviceType" : "LANE_5000",
    "terminalConfigInfo" : {
      "configLabel" : "Tipping_CL",
      "configDeploymentTag" : 1
    },
    "createdDate" : "2024-04-15",
    "rentType" : "MONTHLY",
    "acceptedCards" : [ ],
    "terminalStatusInfo" : {
      "status" : "ORDERED",
      "timestamp" : "2024-04-15T12:42:46.121891982Z"
    }
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/terminals/order/L000095' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw' \
    -d '{
  "terminal" : {
    "deviceType" : "LANE_5000",
    "terminalConfigInfo" : {
      "configLabel" : "Tipping_CL",
      "configDeploymentTag" : 1
    }
  },
  "terminalShipmentData" : {
    "requestedDeliveryDate" : "2024-04-15",
    "shipmentMethod" : "TECHNICIAN",
    "orderUrgency" : "NEXT_DAY"
  }
}'

15.5.106. Search for all Terminals

GET /tms/terminals/search
Description

Search for all terminals. This search will return a subset of Terminal/TerminalService and Merchant information for each terminal.

Responses
HTTP Code Description Schema

200

OK

TerminalSearchResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Terminal

15.5.107. Search for Terminals

GET /tms/terminals/search/{searchType}/{searchValue}
Description

Search for all terminals using by gln, chainName, chainId, customerRef or organizationNumber. This search will return a subset of Terminal/TerminalService and Merchant information for each terminal.

Parameters
Type Name Description Schema

Path

searchType
required

What field to search on

enum (gln, chainName, chainId, customerRef, organizationNumber, groupId, productType, all)

Path

searchValue
required

What value to search for

string
Responses
HTTP Code Description Schema

200

OK

TerminalSearchResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Terminal

15.5.108. Get Terminals by terminal service

GET /tms/terminals/services/{serviceId}
Description

Get a list of all terminals registered on a terminal service.

Parameters
Type Name Schema

Path

serviceId
required

string
Responses
HTTP Code Description Schema

200

OK

< TerminalDataResponse > array

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Terminal

Example HTTP request
GET /tms/terminals/services/L000095 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 489

[ {
  "terminalData" : {
    "terminalId" : "AE426060",
    "serviceId" : "L000095",
    "deviceType" : "LANE_5000",
    "terminalConfigInfo" : {
      "configLabel" : "Tipping_CL",
      "configVersion" : "100",
      "configDeploymentTag" : 1
    },
    "createdDate" : "2024-04-15",
    "configChanged" : false,
    "rentType" : "MONTHLY",
    "acceptedCards" : [ ],
    "terminalStatusInfo" : {
      "status" : "ACTIVE",
      "timestamp" : "2024-04-15T12:42:46.715106Z"
    }
  }
} ]
Example Curl request
$ curl 'https://api.aerahost.com/tms/terminals/services/L000095' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.109. Get Terminal by serialnumber

GET /tms/terminals/snr/{serialnumber}
Description

Get Terminal by serialnumber

Parameters
Type Name Schema

Path

serialnumber
required

string
Responses
HTTP Code Description Schema

200

OK

TerminalShortListResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Terminal

15.5.110. Get Terminal

GET /tms/terminals/{terminalId}
Description

Get detailed information of a Terminal identified by terminalId

Parameters
Type Name Schema

Path

terminalId
required

string
Responses
HTTP Code Description Schema

200

OK

TerminalDataResponse

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Terminal

Example HTTP request
GET /tms/terminals/AE426060 HTTP/1.1
Accept: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 485

{
  "terminalData" : {
    "terminalId" : "AE426060",
    "serviceId" : "L000095",
    "deviceType" : "LANE_5000",
    "terminalConfigInfo" : {
      "configLabel" : "Tipping_CL",
      "configVersion" : "100",
      "configDeploymentTag" : 1
    },
    "createdDate" : "2024-04-15",
    "configChanged" : false,
    "rentType" : "MONTHLY",
    "acceptedCards" : [ ],
    "terminalStatusInfo" : {
      "status" : "ACTIVE",
      "timestamp" : "2024-04-15T12:42:46.715106Z"
    }
  }
}
Example Curl request
$ curl 'https://api.aerahost.com/tms/terminals/AE426060' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6ImNsaWVudF9jcmVkZW50aWFscyIsInNjb3BlIjpbInRtc0FsbCIsImdldE1lcmNoYW50IiwiYWxsUGF5bWVudCIsImNtc0ludGVybmFsQWxsIiwidXBkYXRlQ2xpZW50IiwiZnNBbGwiLCJhbGxJZGVudGl0eU1vZHVsZSIsImdldERhdGFDb250cm9sbGVyIiwiZ2V0Q2xpZW50IiwiZ2V0Q29uY2VwdCIsImFsbElkZW50aXRpZXMiLCJnZXRNZXJjaGFudElkIiwiZ2V0RGF0YUNvbnRyb2xsZXJzIiwidG1zSW50ZXJuYWxBbGwiLCJwb3N0Q2xpZW50IiwiZ2V0Q29uY2VwdHNGb3JEYXRhQ29udHJvbGxlciIsImludm9pY2VXcml0ZSIsImNtc0FsbCIsImludm9pY2VSZWFkIl0sInN1YiI6IjI3YzQ3Y2NhLWMxYjgtNGNjZi05M2Y1LWM1MWQ3ZWJjNWY4YyIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6MTY3ODcxNDEwMiwiaWF0IjoxNjc4NzE0MTAyLCJleHAiOjE4OTk3MTU5NTEsImp0aSI6IjYzNDMxMDUxLTNhNzEtNDFhMS04MWFkLThjNDdjYjhkMDAxZCJ9.CyQfyupkyVCGOh9woRID8eHnXcFxYFjlHx6QDdbwgjmax-ifbX2F-PXINikurbZdT-6NLoZ8Ws3mP5V46qXUvlvhh-rV-gBR9Rz6a0qnqPltnsrk-uwHJhVzMDm9X2wZLfhTSfwxlerYU5zq-5kyo928WlJCs6r8Fyc8kChAcDQbsCtBqlRfJRykqOD8-_q8uaU96YAAnAug58vSu6d_ZYiT8CHZpTkS0R1ayL5OHTwWQr1B2UBr4prSWcu361uMivUQDYwGDZqzMh8R7JzAbhoT7Iv5qHBTzaSnCkif_4u3npl2h_Egr0ZzsC0r9NYZvpFL3lQ9AlJfo6fzMfDySw'

15.5.111. Update terminal

PATCH /tms/terminals/{terminalId}
Description

Update terminal

Parameters
Type Name Schema

Path

terminalId
required

string
Body parameter

Name : body
Flags : required
Type : UpdateTerminalInfo

Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Consumes

  • application/json

Produces

  • application/json

Tags

  • Terminal

15.5.112. Update terminal status

PUT /tms/terminals/{terminalId}/{status}
Description

Suspend/reinstate a terminal. A suspended terminal will be disabled in the payment gateway.

Parameters
Type Name Schema

Path

status
required

enum (ACTIVE, SUSPENDED)

Path

terminalId
required

string
Responses
HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Terminal

15.5.113. Reports

GET /tms/v1/report/terminal/{terminalId}
Parameters
Type Name Schema Default

Path

terminalId
required

string

Query

beginPeriod
optional

string (date-time)

Query

endPeriod
optional

string (date-time)

Query

maxNumHeartbeats
optional

integer (int32)

5

Query

maxNumTransactions
optional

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

TerminalReport

400

Bad Request

ErrorResponse

403

Forbidden

ErrorResponse
Produces

  • application/json

Tags

  • Reports

15.6. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

15.6.1. Account

Account data

Name Description Schema

accountNumber
required

Settlement account number

string

acquirerId
required

AcquirerId

string

emailAddress
optional

Email address for settlement reports

string

settlementOnAccount
required

Do settlement based on account number.

boolean

settlementType
optional

SettlementType. If not set it will default to either GROSS or what is set as global customer level.

enum (GROSS, NET)

validFrom
required

The date the Account is enabled for settlement if status is active

string (date)

15.6.2. AccountDetail

Settlement account data

Name Description Schema

account
required

Account

accountStatusDetail
required

AccountStatusDetail

karValidated
required

If true, the account has been validated against Bank KAR

boolean

15.6.3. AccountStatusDetail

Account status information

Name Description Schema

created
required

Date/Time GMT account was created.

string (date-time)

message
optional

Additional status info.

string

status
required

Account status.

enum (ACTIVE, ACTIVE_REPLACED, INACTIVE, DELETED)

statusTime
required

Date/Time GMT.

string (date-time)

validTo
optional

After this date the account is no longer enabled for settlement

string (date)

15.6.4. AcquirerBulkInfo

List of Acquirer and schema to be changed

Name Description Schema

acquirerName
required

The Acquirer Interface name used for payments.

enum (NETSSDI, ELAVONEUAER, EVRY, NTSTELLER, AERA, CSDUMMY)

operation
required

Operation to be performed for this schema

enum (ADD, REMOVE)

paymentSchemas
optional

A list of different payment schemas

< PaymentSchema > array

15.6.5. AcquirerInfo

List of aquirerInfo the Merchant shall use in this TerminalService. A TerminalService can only be registered with ONE Aquire MID/BAXNUMBER for each acquirer registered, and no duplicate CardSchema names in a TerminalService

Name Description Schema

acquirerMid
required

The Merchant ID/Bax number at acquirer.
Length : 1 - 20

string

acquirerName
required

The Acquirer Interface name used for payments.

enum (NETSSDI, ELAVONEUAER, EVRY, NTSTELLER, AERA, CSDUMMY)

cardSchemas
optional

A list of different card schemas.

< enum (BANKAXEPT, VISA, MASTERCARD, AMEX, DINERS, DISCOVER, JCB, MAESTRO, CUP, AERA, COOPCORP, NETSSG, NETSKG, IGIVEGK, IGIVEGS, IGIVEKK, IGIVEKS, IGIVEF, COOPVISA, TRUMF, NETSGK, NGCORP, NGGIFT, EVRYLOYAL, NETSKK, COOPMC, UNIGK, SENTRUMSGK) > array

15.6.6. AcquirerInfoDetail

List of aquirerInfo objects with status details.

Name Schema

acquirerInfo
required

AcquirerInfo

acquirerInfoStatusDetail
required

AcquirerInfoStatusDetail

15.6.7. AcquirerInfoStatusDetail

Status of acquirer agreement if known.

Name Description Schema

message
optional

Additional status info.
Length : 1 - 255

string

status
required

Acquirerinfo status.

enum (INITIALIZED, ACTIVE, INACTIVE, DELETED, FAILED)

timestamp
required

Date/Time GMT.

string (date-time)

15.6.8. AcquirerTerminalInformation

Name Schema

DEF
required

boolean

TEI
required

string

15.6.9. ActivateRequestTms

Name Schema

merchantId
optional

string

serialNumber
optional

string

terminalId
optional

string

15.6.10. ActivateResponseTms

Name Schema

resHeader
optional

ResponseHeaderTms

15.6.11. Address

Invoice address

Name Description Schema

countryCode
optional

The country code in ISO 3166-1 Alpha2 format. Default value is âNOâ.

string

houseLetter
optional

The house letter if any.

string

houseNumber
optional

The house number if any.

string

postalArea
required

The postal area name.

string

postalCode
required

The postal code.

string

street
optional

Street name or post box address line.

string

15.6.12. AeviMessage

Name Schema

aeviStatus
optional

string

id
optional

integer (int64)

info
optional

string

merchantId
optional

string

messageType
optional

string

orderId
optional

string

status
optional

integer (int32)

statusTime
optional

string (date-time)

terminalId
optional

string

tsIdLabel
optional

string

15.6.13. AffectedTerminalInfo

Name Schema

configDeploymentId
optional

integer (int64)

internalTerminalId
optional

integer (int64)

status
optional

integer (int32)

statusTime
optional

string (date-time)

terminalId
optional

string

15.6.14. AgreementContact

Contact person who shall sign agreement(s) if required

Name Description Schema

email
optional

Email address to person receiving agreement link for digital signing contract.

string

firstName
optional

A persons first name.

string

lastName
required

Name of a company or a personâs family/last name.

string

phone
optional

The contacts phone number.

string

15.6.15. AgreementProductInfo

Digital agreements required for product

Name Description Schema

signedAgreementId
optional

Aera´s internal id of signed agreement

integer (int32)

status
optional

Signing status

enum (ACTIVE, INITIALIZED, FAILED, COMPLETED, INACTIVE, PENDING)

statusTime
optional

Signing status time

string (date-time)

type
required

type of agreement.

string

15.6.16. AssetDetail

Asset (product) Information.

Name Description Schema

acquirerId
optional

Aera Payment AcquirerId

string

agreements
optional

Digital agreements required for product

< AgreementProductInfo > array

created
required

Asset creation time.

string (date-time)

invoiceReveiverCustomerId
optional

Invoice receiver of this asset. Overrides original invoiceReceiver (Legal owner) or Head office inv_receiver_override on merchant level.

string

product
required

Product

productAttributes
optional

Product attributes.

< ProductAttribute > array

productTypeNumber
optional

Product type number. This is the primary visma product number used for Invoicing

string

status
required

Asset status.

enum (ACTIVE, INACTIVE, DELETED, PENDING)

updated
required

Asset updated time.

string (date-time)

15.6.17. Attribute

Name Schema

attributeName
required

string

attributeValue
required

string

15.6.18. AuditLogDb

Name Schema

accessId
optional

string

clientId
optional

string

id
optional

integer (int64)

info
optional

string

objectId
optional

string

objectType
optional

enum (MERCHANT, PAYMENTSERVICE, TERMINAL, CONFIGPROFILE, DEPLOY, STOCK, RMASCHEMA)

operation
optional

enum (ADD, MODIFY, MODIFY_STATUS, DELETE, READ, ACTIVATE, COPY, SOLD)

remoteIp
optional

string

requestId
optional

string

status
optional

integer (int32)

timestamp
optional

string (date-time)

userId
optional

string

15.6.19. BankAxeptOrder

BankAxept specific order information. If the merchant needs to order new/migrate from old Active BAX number.
If Migration from old baxnumber:
The new Bax number created will be added to the AquirerInfo list. The âoldâ Baxnumber SHALL not be registered in the AquirerInfo list.

Name Description Schema

baxProducts
optional

A list of bankAxept products.
If set: The new BAX number will be ordered with this list of products. If existingBaxNumber is set, this list will overwrite the list copied from the existingBaxNumber.
If not set:
1. If existingBaxNumber is set, the new BAX number will inherit products from it.
2. If existingBaxNumber is not set, the new BAX number will default to these products:
Varekjøp, Cashback, Reserveløsning

< enum (Varekjøp, Cashback) > array

cardSchemas
optional

A list of different card schemas.

< enum (BANKAXEPT, VISA, MASTERCARD, AMEX, DINERS, DISCOVER, JCB, MAESTRO, CUP, AERA, COOPCORP, NETSSG, NETSKG, IGIVEGK, IGIVEGS, IGIVEKK, IGIVEKS, IGIVEF, COOPVISA, TRUMF, NETSGK, NGCORP, NGGIFT, EVRYLOYAL, NETSKK, COOPMC, UNIGK, SENTRUMSGK) > array

existingBaxNumber
optional

The Merchants BAX number from a different PSP. This is required if Aera shall obtain a new BAX number for BankAxept. The products associated with this number will be present for the new BAX Number as well.
The settlementAccountNo has to be the same as the one registered on the existingBaxNumber. Ie, the new BAX number will use the same settlement agreement as the existingBaxNumber.
Length : 6 - 11

string

settlementAccountNo
required

The settlement account number for the merchant. This is required if Aera shall obtain a new BAX number for BankAxept.
Length : 11

string

15.6.20. BankaxeptMessage

Name Schema

baxStatus
optional

string

id
optional

integer (int64)

info
optional

string

merchantId
optional

string

messageType
optional

string

orderId
optional

string

status
optional

integer (int32)

statusTime
optional

string (date-time)

tsIdLabel
optional

string

15.6.21. BusinessInfoServiceTms

Name Schema

communicationLang
optional

string

contactPersonName
optional

string

contactPersonPhone
optional

string

email
optional

string

merchantName
optional

string

postalAddress
optional

PostalAddressTms

userId
optional

string

15.6.22. CardDataDto

Name Schema

cardCategory
optional

string

cardEntryMode
optional

string

cardProduct
optional

string

15.6.23. CardRoutingData

Name Schema

ACB
optional

string

ALN
optional

string

AMI
required

string

APR
required

string

ARD
optional

string

CMI
required

string

COM
optional

string

CPR
required

string

MPY
required

string

PNA
optional

string

PWD
optional

string

REC
optional

string

S3M
optional

string

S3P
optional

string

SUS
optional

string

TEI
optional

string

15.6.24. CardSchemeTms

Name Schema

cashbackSupport
optional

string

configId
optional

string

cvmReqLimitContactless
optional

string

floorLimitContact
optional

string

floorLimitContactless
optional

string

interacMTIContactless
optional

string

prefferedAppContact
optional

string

refundSupport
optional

string

trxCashAdvance
optional

string

trxCashDeposit
optional

string

15.6.25. CardSchemesTms

Name Schema

cardScheme
optional

< CardSchemeTms > array

15.6.26. ChangeLog

Change Log of last changes on Merchant

Name Description Schema

changeTime
optional

Date and time of change

string (date-time)

description
required

Description of change

string

userId
required

Username of user who applied change

string

vismaSyncStatus
optional

visma sync status

string

vismaSyncTime
optional

visma sync time

string (date-time)

15.6.27. CmsGroupListResponse

Name Description Schema

groupDetails
required

Groups information

< GroupDetail > array

15.6.28. CmsMerchantResponse

Name Description Schema

accountDetails
optional

Settlement account data

< AccountDetail > array

assetDetails
required

Asset (product) Information.

< AssetDetail > array

changeLogs
optional

Change Log of last changes on Merchant

< ChangeLog > array

concept
optional

Concept

groupDetails
optional

A list of customerGroups with details the Customer is a part of.

< GroupDetail > array

invoiceReveiverCustomerId
optional

Invoice receiver of this merchant. Overrides original invoiceReceiver (Legal owner)

string

merchantConceptEnabled
required

Use a unique DataController and concept for this merchant. All Products will use the conceptId.

boolean

merchantDetail
required

MerchantDetail

organizationDetail
required

OrganizationDetail

15.6.29. Concept

DataController and concept information if created for Merchant

Name Description Schema

conceptId
required

The unique id of the concept the store has access to. If not included, the UUID will be generated by CMS

string

conceptName
required

The name of the Concept

string

dataControllerId
required

The data controller the concept belongs to.

string

15.6.30. ConfigDeployment

Name Schema

configDeploymentTag
optional

integer (int32)

configTemplateId
optional

integer (int64)

controllerId
optional

string

created
optional

string (date-time)

deploymentStrategy
optional

string

id
optional

integer (int64)

newTemplateName
optional

string

newTemplateVersion
optional

string

oldTemplateName
optional

string

oldTemplateVersion
optional

string

requestId
optional

string

startTime
optional

string (date-time)

status
optional

integer (int32)

statusTime
optional

string (date-time)

terminalIdList
optional

string

15.6.31. ConfigDeploymentInfo

Name Schema

configDeploymentTag
optional

integer (int32)

configTemplateId
optional

integer (int64)

created
optional

string (date-time)

deploymentStrategy
optional

string

id
optional

integer (int64)

newTemplateName
optional

string

newTemplateVersion
optional

string

oldTemplateName
optional

string

oldTemplateVersion
optional

string

startTime
optional

string (date)

status
optional

integer (int32)

statusTime
optional

string (date-time)

terminalIdList
optional

string

terminals
optional

< AffectedTerminalInfo > array

15.6.32. ConfigTemplateInformationResponse

Name Schema

chain
optional

< integer (int32) > array

configLabel
optional

string

configVersion
optional

string

created
optional

string (date-time)

deviceTypes
optional

< enum (LANE_5000, LANE_3000, MOVE_5000) > array

status
optional

enum (ACTIVE, DEFAULT, INACTIVE)

type
optional

enum (TIPPEKASSE, STANDARDKASSE, NETTHANDEL, OTHER)

15.6.33. Contact

Customer Financial/Invoice contact

Name Description Schema

email
optional

This value may be used retrieve an existing contact in Aera. If now match found, the whole contact element may be ignored.

string

firstName
optional

A persons first name.

string

lastName
required

Name of a company or a personâs family/last name.

string

mobile
optional

The contacts mobile number.

string

phone
optional

The contacts phone number.

string

15.6.34. CurrentTerminalConfigResponse

Name Description Schema

configLabel
required

Name on configurations template
Length : 0 - 255
Pattern : "^[a-zA-Z0-9_.-]*$"

string

configProperties
required

Configurations properties

< string, < DeployedPropertiesInfo > array > map

configVersion
required

Version on configurations template
Length : 0 - 10
Pattern : "^[a-zA-Z0-9_.-]*$"

string

controllerId
required

Controller id
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-]{0,20}"

string

deployStatus
required

Status on deployment

enum (INITIALIZED, ACTIVE, PENDING, INACTIVE, DELETED, DELETE_PENDING, INACTIVE_PENDING, ACTIVE_PENDING, FAILED)

merchantId
required

Aera Merchant ID
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-]{0,20}"

string

serviceId
optional

Unique id identifying the PaymentService
Length : 1 - 20

string

statusTime
required

Time on last change on deployment

string (date-time)

terminalId
required

Terminal id
Length : 1 - 20
Pattern : "^[0-9A-Za-z]{6,16}$"

string

15.6.35. DeployConfigManualRequest

Name Description Schema

configLabel
required

Name on configurations template
Length : 0 - 255
Pattern : "^[a-zA-Z0-9_.-]*$"

string

configVersion
required

Version on configurations template
Length : 0 - 20
Pattern : "^[a-zA-Z0-9_.-]*$"

string

deployDate
optional

Date for when deployment should be send to Aevi, if not present it will happens immediately

string (date)

deploymentStrategy
optional

Should terminal update on next interaction

enum (FORCE_UPDATE, NEXT_BOOT)

terminalIdList
required

List of terminalIds to be updated

< string > array

15.6.36. DeployConfigStrategyRequest

Name Description Schema

configDeploymentTag
optional

Configuration template tag to be updated (terminals with this tag set will be targeted)

integer (int32)

deployDate
optional

Date for when deployment should be send to Aevi, if not present it will happens immediately

string (date)

deploymentStrategy
required

Which deployment strategy should be used for deployment

enum (FORCE_UPDATE, NEXT_BOOT)

oldConfigLabel
required

Name on existing configurations template (only terminals running this configuration will be targeted)
Length : 0 - 255
Pattern : "^[a-zA-Z0-9_.-]*$"

string

oldConfigVersion
optional

Version on existing configurations template (only terminals running this version will be targeted)
Length : 0 - 20
Pattern : "^[a-zA-Z0-9_.-]*$"

string

updateConfigLabel
required

Name on configurations template for new config
Length : 0 - 255
Pattern : "^[a-zA-Z0-9_.-]*$"

string

updateConfigVersion
required

Version on configurations template for new config
Length : 0 - 20
Pattern : "^[a-zA-Z0-9_.-]*$"

string

15.6.37. DeployedPropertiesInfo

Configurations properties

Name Schema

name
optional

string

value
optional

string

15.6.38. Device

Name Schema

attended
optional

string

businessId
optional

string

configurationVersion
optional

string

deviceCategory
optional

string

deviceModel
optional

string

deviceType
optional

string

id
optional

integer (int64)

merchantCategoryCode
optional

string

originalId
optional

string

osVersion
optional

string

serialNumber
optional

string

softwareVersion
optional

string

xpayConfiguration
optional

string

xpayVersion
optional

string

15.6.39. DeviceData

Name Schema

freeFlashMemory
optional

integer (int64)

freeRamMemory
optional

integer (int64)

id
optional

integer (int64)

signalStrength
optional

integer (int64)

totalFlashMemory
optional

integer (int64)

totalRamMemory
optional

integer (int64)

15.6.40. Entry

Name Schema

key
optional

object

value
optional

object

15.6.41. ErrorResponse

Name Description Schema

fieldErrors
optional

List of fields in API containing error if found.

< FieldValidationError > array

message
optional

additional response info.
Length : 1 - 255

string

responseCode
required

response code from Aera TMS.

enum (AERA20003, AERA20004, AERA20010, AERA20099, TMS21003, TMS21005, TMS21006, TMS21010, TMS21011, TMS21012, TMS21013, TMS21014, TMS21015, TMS21016, TMS21019, TMS21020, TMS21021, TMS21022, TMS21023, TMS21024, TMS21025, TMS21026, TMS21027, TMS21028, TMS21029, TMS21035, TMS21036, TMS21037, TMS21038, TMS21039, TMS21048, TMS21049, TMS21030, TMS21031, TMS21032, TMS21033, TMS21034, TMS21040, TMS21041, TMS21042, TMS21043, TMS21044, TMS21045, TMS21046, TMS21047, TMS21051, TMS21052, TMS21060, TMS21070, TMS21071, TMS21072, TMS21080, TMS21085, TMS21100, TMS21110, TMS21120, TMS21121, TMS21122, TMS21130, TMS21131, TMS21150, TMS21151, TMS21152, TMS21153, TMS21154, TMS21160, TMS21161, TMS21500, TMS21501, TMS21502, TMS21050, AERA10100, AERA10101, AERA10102, AERA10103, AERA10104, TMS21090)

timestamp
required

Date/Time GMT.

string (date-time)

15.6.42. FSActivateTerminalRequest

Name Description Schema

configDeploymentTag
optional

Override config deployment tag in terminal order

integer (int32)

ecrNumber
optional

The ECR number.
Length : 1 - 20

string

serialNumber
required

The Serial number of Terminal.
Length : 1 - 40
Pattern : "^[\\p{Alnum}-_]*"

string

serviceId
required

The Merchant´serviceID
Length : 1 - 20

string

terminalId
required

The terminal ID.
Length : 1 - 20
Pattern : "^[0-9A-Za-z]{6,16}$"

string

15.6.43. FSCopyTerminalRequest

Name Description Schema

newSerialNumber
required

The Serial number of new Terminal.
Length : 1 - 40
Pattern : "^[\\p{Alnum}-_]*"

string

oldSerialNumber
required

The Serial number of old Terminal.
Length : 1 - 40
Pattern : "^[\\p{Alnum}-_]*"

string

oldTerminalId
required

The terminal ID of old terminal.
Length : 1 - 20
Pattern : "^[0-9A-Za-z]{6,16}$"

string

serviceId
required

The Merchant,s serviceID.
Length : 1 - 20

string

15.6.44. FSDeleteTerminalRequest

Name Description Schema

serialNumber
optional

The Serial number of terminal to delete. Mandatory if terminal has been activated
Length : 1 - 40
Pattern : "^[\\p{Alnum}-_]*"

string

serviceId
required

The Merchant´s serviceId.
Length : 1 - 20

string

terminalId
required

The terminal ID of terminal to delete.
Length : 1 - 20
Pattern : "^[0-9A-Za-z]{6,16}$"

string

15.6.45. FSTerminalResponse

Name Description Schema

serialNumber
required

The terminal serial number.
Length : 1 - 40
Pattern : "^[\\p{Alnum}-_]*"

string

terminalId
required

Unique ID for a terminal. The terminalId is created by Aera.
Length : 1 - 80
Pattern : "^[0-9A-Za-z]{6,16}$"

string

15.6.46. FieldValidationError

List of fields in API containing error if found.

Name Description Schema

field
required

Name on error field
Length : 1 - 255

string

message
required

Error message
Length : 1 - 512

string

15.6.47. FsOrderUpdate

Name Description Schema

installationDate
optional

Time of installation

string (date)

status
required

The new status that the Order should be updated with

enum (ORDERED, PENDING, SUSPENDED, ACTIVE, CANCELLED, DELETED, DELETE_PENDING, FAILED, INACTIVE)

vendorId
optional

Unique Id in vendor-system
Length : 0 - 50
Pattern : "^[\\p{Alnum}_\\.]*"

string

15.6.48. FsStockBalance

Name Schema

Balance
optional

integer (int32)

Description
optional

string

ProductNumber
optional

string

Reserved Shipment
optional

string

StorageNumber
optional

integer (int32)

15.6.49. GatewayRoutingData

Name Schema

ALN
optional

string

ARD
optional

string

CPR
required

string

EM3
optional

string

HID
optional

string

MID
required

string

MPY
required

string

PWD
optional

string

REC
optional

boolean

RPR
required

string

SIG
optional

string

SUS
optional

string

ZCB
optional

string

15.6.50. GetOrdersRequestTms

Name Schema

orderCriteria
optional

OrderCriteriaTms

orderId
optional

string

15.6.51. GetOrdersResponseTms

Name Schema

orders
optional

< OrderTms > array

resHeader
optional

ResponseHeaderTms

15.6.52. GetTerminalDataResponseTms

Name Schema

resHeader
optional

ResponseHeaderTms

tmsTerminalInfo
optional

TmsTerminalInfoTms

15.6.53. Group

Group information

Name Description Schema

name
required

CustomerGroup Name.

string

parentGroup
optional

Parent group id if it exists.

integer (int32)

type
required

CustomerGroup type.

enum (AERA, UMBRELLA, CHAIN)

15.6.54. GroupAttribute

Group attributes.

Name Description Schema

name
required

Attribute Name.

string

value
required

Attribute number.

string

15.6.55. GroupDetail

A list of customerGroups with details the Customer is a part of.

Name Description Schema

group
required

Group

groupAttributes
optional

Group attributes.

< GroupAttribute > array

id
required

CustomerGroup id.

integer (int32)

15.6.56. HeartbeatDto

Name Schema

deviceData
optional

DeviceData

eventTime
optional

string (date-time)

15.6.57. IngenicoRepairReportRequest

Name Description Schema

b64File
required

Base64 encode file
Pattern : "\\A[a-zA-Z\\d\\/+]+={0,2}\\z"

string

fileName
optional

Name on file
Length : 0 - 255
Pattern : "^[\\p{Alnum}- ._]*"

string

fileType
required

Type of file

enum (PLAIN, EXCEL)

15.6.58. IngenicoRepairReportResponse

Name Description Schema

faultCode
required

Fault code for concluded repair
Length : 0 - 200

string

faultConfirmedStatus
optional

Fault confirmed status for billing
Length : 0 - 50

string

faultStatus
optional

string

ingenicoScanDate
required

Date when Ingenico starts audit/repair

string (date)

ingenicoShipDate
required

Date when repaired terminal is shipped back

string (date)

model
required

Device model
Length : 1 - 80

string

quantity
required

Number of terminals on the spesific RMA shipment

integer (int32)

repairCost
optional

Cost of repair

number (double)

repairReportId
required

Id on repair report
Length : 1 - 80

string

reportedFaultComment
optional

Fault reason set by warehouse
Length : 0 - 200

string

serialNumber
required

Terminal serial number
Length : 5 - 80

string

timesRepaired
optional

Times repaired

integer (int32)

warrantyEnds
required

Date when warrenty for unit ends

string (date)

warrantyStatus
required

warrenty status at the time of repair
Length : 0 - 50

string

15.6.59. IpgMessage

Name Schema

id
optional

integer (int64)

info
optional

string

ipgStatus
optional

string

merchantId
optional

string

messageType
optional

string

orderId
optional

string

status
optional

integer (int32)

statusTime
optional

string (date-time)

terminalId
optional

string

tsIdLabel
optional

string

15.6.60. Merchant

Merchant information

Name Description Schema

chainId
optional

The customers own reference to the merchants chain.

string

chainName
optional

The merchants chain name. required if a merchant belongs under a chain.

string

companyEmail
optional

The email associated with the merchant.

string

companyPhone
optional

The phone number to the merchant.

string

contact
optional

Contact

customerRef
optional

Customers own reference to the merchant.

string

gln
optional

Global Location Number. Required for some customers.

string

locationAddress
required

Address

name
required

The name of the merchant.

string

postalAddress
optional

Address

url
optional

Merchant URL.

string

15.6.61. MerchantData

Name Schema

AD1
required

string

CIT
required

string

CNM
required

string

MCC
optional

string

STA
optional

string

TEL
optional

string

TXI
optional

string

TXT
optional

string

URL
optional

string

ZIP
required

string

15.6.62. MerchantDetail

Merchant information.

Name Description Schema

merchant
required

Merchant

merchantId
required

Unique ID of Merchant generated by Aera. Returned if Merchant is generated ok in Aera TMS.

string

merchantStatus
required

MerchantStatusDetail

15.6.63. MerchantIdPaymentServiceId

Name Description Schema

merchantId
required

Merchant that own the payment service
Pattern : "^[a-zA-Z0-9\\-]{0,20}"

string

serviceId
optional

Unique id identifying the PaymentService.
Length : 1 - 20

string

15.6.64. MerchantInfo

Merchant Info

Name Description Schema

chainId
optional

The customers own reference to the merchants chain.

string

chainName
optional

The merchants chain name. required if a merchant belongs under a chain.

string

customerRef
optional

Customers own reference to the merchant.

string

gln
optional

Global Location Number. Required for some customers.

string

merchantId
required

Unique ID of Merchant generated by Aera. Returned if Merchant is generated ok in Aera TMS.

string

name
required

The name of the merchant.

string

organizationNumber
required

The organization number.

string

status
required

Merchant status.

enum (ACTIVE, INACTIVE, DELETED)

statusTime
optional

Date/Time GMT.

string (date-time)

15.6.65. MerchantRequest

Name Description Schema

merchant
required

Merchant

organization
required

Organization

terminalServices
optional

List of terminal services to be created in the Aera system.
It is optional to create terminal services in Merchant request. Client can use TerminalServiceRequest to add TerminalService later.

< TerminalService > array

15.6.66. MerchantResponse

Name Description Schema

groupDetails
optional

A list of customerGroups with details the Customer is a part of.

< GroupDetail > array

merchant
required

Merchant

merchantId
required

Unique ID of Merchant generated by Aera. Returned if Merchant is generated ok in Aera TMS. The merchantId is used as key when updating merchant information
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-]{0,20}"

string

organizationDetail
required

OrganizationDetail

terminalServiceDetails
optional

List of terminal services with details.

< TerminalServiceDetail > array

15.6.67. MerchantSearchResponse

Name Description Schema

merchantInfo
required

MerchantInfo list

< MerchantInfo > array

15.6.68. MerchantStatusDetail

Merchant status details

Name Description Schema

message
optional

Additional status info.

string

status
required

Merchant status.

enum (ACTIVE, INACTIVE, DELETED)

timestamp
required

Date/Time GMT.

string (date-time)

15.6.69. MerchantUpdateRequest

Name Schema

merchant
required

Merchant

organization
optional

Organization

15.6.70. OrderCriteriaTms

Name Schema

createDate
optional

string (date-time)

deliveryType
optional

string

hardwareType
optional

string

merchantId
optional

string

orderType
optional

string

status
optional

string

terminalId
optional

string

15.6.71. OrderTms

Name Schema

createDate
optional

string (date-time)

deliveryType
optional

string

effectiveDate
optional

string (date-time)

hardwareType
optional

string

merchantId
optional

string

orderId
optional

string

orderType
optional

string

processDate
optional

string (date-time)

serialNumber
optional

string

status
optional

string

terminalId
optional

string

15.6.72. Organization

Organization information with org number

Name Description Schema

agreementContact
optional

AgreementContact

businessAddress
optional

Address

contact
optional

Contact

organizationCode
optional

Organization code as registered in brreg.

string

organizationNumber
required

The organization number.

string

parentOrganizationNumber
optional

If a parent organization can sign contracts on behalf of this organization.

string

postalAddress
optional

Address

15.6.73. OrganizationDetail

Organization information with org number

Name Description Schema

agreementContact
optional

AgreementContact

businessAddress
optional

Address

contact
optional

Contact

customerId
optional

Aera´s internal id of customer

string

name
optional

Legal name of company if found in brreg

string

organizationCode
optional

Organization code as registered in brreg.

string

organizationNumber
required

The organization number.

string

parentOrganizationName
optional

Parent organization´s Legal name from brreg.

string

parentOrganizationNumber
optional

If a parent organization can sign contracts on behalf of this organization.

string

postalAddress
optional

Address

15.6.74. OrganizationRequest

Name Schema

invoiceInfos
optional

< PayerAccount > array

organization
required

Organization

15.6.75. OrganizationResponse

Name Description Schema

organizationDetail
required

OrganizationDetail

payerAccounts
optional

A list of different payer accounts added by customer. This information is used by AERA for invoicing

< PayerAccount > array

15.6.76. PayerAccount

Name Description Schema

commonName
optional

name of payment account if needed. Added by customer as a reference

string

contact
optional

Contact

email
optional

Email address if channel EMAIL is used

string

invoiceAddress
optional

Address

invoiceChannel
optional

Invoice Payment channel

enum (MAIL, EHF, PRINT, AUTOGIRO)

15.6.77. PaymentAcquirer

List of payment acquirer for the Merchant. A Payment Service can only be registered with ONE Aquire MID/BAXNUMBER for each acquirer registered, and no duplicate PaymentSchema names

Name Description Schema

acquirerMid
required

The Merchant ID/Bax number at acquirer
Length : 1 - 20

string

acquirerName
required

The Acquirer name used for payments

enum (NETSSDI, ELAVONEUAER, EVRY, NTSTELLER, AERA, CSDUMMY)

paymentSchemas
optional

A list of different payment schemas that shall be processed by the given Acquirer. If not present the "group" must have been configured with a payment schema template

< PaymentSchema > array

15.6.78. PaymentAcquirerStatus

List of payment acquirer for the Merchant. A Payment Service can only be registered with ONE Aquire MID/BAXNUMBER for each acquirer registered, and no duplicate PaymentSchema names

Name Description Schema

acquirerMid
required

The Merchant ID/Bax number at acquirer
Length : 1 - 20

string

acquirerName
required

The Acquirer name used for payments

enum (NETSSDI, ELAVONEUAER, EVRY, NTSTELLER, AERA, CSDUMMY)

paymentAcquirerStatusDetail
required

AcquirerInfoStatusDetail

paymentSchemas
optional

A list of different payment schemas that shall be processed by the given Acquirer. If not present the "group" must have been configured with a payment schema template

< PaymentSchema > array

15.6.79. PaymentOption

Additional options

Name Description Schema

paymentOptionJson
required

Json formatted string of options

string

paymentOptionType
required

Type of option

enum (D3SECURE)

15.6.80. PaymentRouting

Name Schema

ATI
optional

AcquirerTerminalInformation

CDR
optional

< CardRoutingData > array

CTY
required

string

CUR
required

string

GWR
optional

GatewayRoutingData

MER
required

MerchantData

PRJ
required

string

RAC
required

boolean

STO
optional

string

15.6.81. PaymentRoutingMessage

Name Schema

ROU
optional

PaymentRouting

15.6.82. PaymentSchema

A list of different payment schemas that shall be processed by the given Acquirer. If not present the "group" must have been configured with a payment schema template

Name Description Schema

paymentChannels
optional

List of payment channels the schema is valid for. Default: Terminal

< enum (TERMINAL, ONLINE) > array

paymentOptions
optional

Additional options

< PaymentOption > array

paymentSchemaName
required

Name on the payment schema

enum (BANKAXEPT, VISA, MASTERCARD, AMEX, DINERS, DISCOVER, JCB, MAESTRO, CUP, AERA, COOPCORP, NETSSG, NETSKG, IGIVEGK, IGIVEGS, IGIVEKK, IGIVEKS, IGIVEF, COOPVISA, TRUMF, NETSGK, NGCORP, NGGIFT, EVRYLOYAL, NETSKK, COOPMC, UNIGK, SENTRUMSGK)

15.6.83. PaymentService

A payment service groups together a collection of IDâs (MIDs) and payment schemes to different acquirers for the merchant.

Name Description Schema

bankAxeptOrder
optional

BankAxeptOrder

commonName
optional

Customer friendly description of payment service.
Length : 1 - 50
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

customerRef
optional

Customer reference/id to payment service
Length : 1 - 50
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

dcc
optional

Dynamic currency converter. This value can be set to override configuration profile
Length : 1 - 5
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

idLookup
optional

Enroll Payment service and payment devices (terminals) in Id service.
Default: false

boolean

mcc
required

Merchant Category Code. This value consists of four digits and is provided by the acquirer.
Length : 4

string

paymentAcquirers
required

List of payment acquirer for the Merchant. A Payment Service can only be registered with ONE Aquire MID/BAXNUMBER for each acquirer registered, and no duplicate PaymentSchema names

< PaymentAcquirer > array

reconAutoClose
optional

Reconciliation Auto Close. If not set, defaults to true

boolean

serviceId
optional

Unique id identifying the PaymentService. Should not be present when ordering a new payment service
Length : 1 - 20

string

tipAmount
optional

Tip Amount. This value can be set to override configuration profile
Length : 1 - 5
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

type
optional

Type to match configuration profile

enum (TIPPEKASSE, STANDARDKASSE, NETTHANDEL, OTHER)

15.6.84. PaymentServiceBulkUpdateHistoriesResponse

Name Description Schema

beginPeriod
optional

beginPeriod

string (date-time)

endPeriod
optional

endPeriod

string (date-time)

historyList
required

List of all bulk updates

< TsBulkHistoryObj > array

15.6.85. PaymentServiceBulkUpdateHistoryDetailsResponse

Name Description Schema

bulkUpdateHistory
required

TsBulkHistoryObj

historyDetails
required

Details on a bulk update

< TsBulkDetailsObj > array

15.6.86. PaymentServiceBulkUpdateRequest

Name Description Schema

acquirerInfoList
optional

List of Acquirer and schema to be changed

< AcquirerBulkInfo > array

bulkUpdateSearchType
required

Search type to find merchants to update

enum (ALL, ORGANIZATIONNUMBER, GROUP)

bulkUpdateSearchValue
optional

Search value to find merchants to update
Length : 1 - 45
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

idLookup
optional

Enroll Payment service and payment devices (terminals) in Id service.
Default: false

boolean

reconAutoClose
optional

Reconciliation Auto Close. If not set, defaults to true

boolean

type
required

Type of payment service

enum (TIPPEKASSE, STANDARDKASSE, NETTHANDEL, OTHER)

15.6.87. PaymentServiceBulkUpdateResponse

Name Description Schema

bulkUpdateSearchType
required

Search type to find merchants to update

enum (ALL, ORGANIZATIONNUMBER, GROUP)

bulkUpdateSearchValue
required

Search value to find merchants to update
Length : 1 - 45
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

historyId
required

Id on history element for this bulk update

integer (int64)

type
required

Type of payment service

enum (TIPPEKASSE, STANDARDKASSE, NETTHANDEL, OTHER)

updateStatus
required

Status on each payment service

< string, string > map

15.6.88. PaymentServiceRequest

Name Description Schema

lastUpdate
optional

Status time from getPaymentService, used to avoid that 2 clients updates at the same time (only to be used in update request)

string (date-time)

paymentService
required

PaymentService

15.6.89. PaymentServiceResponse

Name Description Schema

merchantId
required

Merchant that own the payment service
Pattern : "^[a-zA-Z0-9\\-]{0,20}"

string

paymentService
required

PaymentServiceWithStatus

paymentServiceStatus
required

TerminalServiceStatusDetail

terminalInfos
optional

List of terminals using the Payment Service

< TerminalInfo > array

15.6.90. PaymentServiceSearchData

List of paymentServices

Name Schema

merchantInfo
required

MerchantInfo

paymentService
required

PaymentServiceWithStatus

paymentServiceStatus
required

TerminalServiceStatusDetail

15.6.91. PaymentServiceSearchResponse

Name Description Schema

paymentServiceList
optional

List of paymentServices

< PaymentServiceSearchData > array

15.6.92. PaymentServiceWithStatus

Info on the payment service

Name Description Schema

bankAxeptOrder
optional

BankAxeptOrder

commonName
optional

Customer friendly description of payment service.
Length : 1 - 50
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

customerRef
optional

Customer reference/id to payment service
Length : 1 - 50
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

dcc
optional

Dynamic currency converter. This value can be set to override configuration profile
Length : 1 - 5
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

idLookup
optional

Enroll Payment service and payment devices (terminals) in Id service.
Default: false

boolean

mcc
required

Merchant Category Code. This value consists of four digits and is provided by the acquirer.
Length : 4

string

paymentAcquirers
required

List of payment acquirer for the Merchant. A Payment Service can only be registered with ONE Aquire MID/BAXNUMBER for each acquirer registered, and no duplicate PaymentSchema names

< PaymentAcquirerStatus > array

reconAutoClose
optional

Reconciliation Auto Close. If not set, defaults to true

boolean

serviceId
optional

Unique id identifying the PaymentService. Should not be present when ordering a new payment service
Length : 1 - 20

string

tipAmount
optional

Tip Amount. This value can be set to override configuration profile
Length : 1 - 5
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

type
optional

Type to match configuration profile

enum (TIPPEKASSE, STANDARDKASSE, NETTHANDEL, OTHER)

15.6.93. PostalAddressTms

Name Schema

city
optional

string

countryCode
optional

string

houseNumber
optional

string

name
optional

string

postalCode
optional

string

street
optional

string

15.6.94. Product

Product information.

Name Description Schema

agreementType
optional

type of agreement if product require a digital signed agreement. Will override standard product agreement mapping

string

businessService
required

Business service the productType has

string

conceptId
optional

concept UUID

string

description
optional

Product description.

string

groupId
required

Set if the product shall be enabled only for merchants belonging to the group or subgroups

integer (int32)

name
required

Product Name.

string

productNumber
required

Product number.

string

productType
required

ProductType

string

requireAcquirerId
optional

if true, status of Asset are dependent on acquirerId are set on product. Defaults to false

boolean

requireCustomerAmlCheck
optional

if true, status of Asset are dependent on a passed AML check. Defaults to false

boolean

requireSignAgreement
optional

if true, status of Asset are dependent on one or more signed agreement(s). Defaults to false

boolean

15.6.95. ProductAttribute

Product attributes.

Name Description Schema

name
required

Attribute Name.

string

value
required

Attribute number.

string

15.6.96. ProductInfoDetail

Name Schema

product
required

enum (2002, 2003, 2006, 2011)

productAttributeList
optional

< Attribute > array

15.6.97. RegisterSoldTerminalRequest

Name Schema

soldTerminals
required

< SoldTerminalRequest > array

15.6.98. RegisterSoldTerminalResponse

Name Description Schema

rentType
optional

The terminal invoicing type.

enum (MONTHLY, DAILY, SOLD)

soldTerminals
required

< SoldTerminalResponse > array

15.6.99. ResponseErrorTms

Name Schema

code
optional

integer (int32)

message
optional

string

15.6.100. ResponseHeaderTms

Name Schema

error
optional

ResponseErrorTms

orderId
optional

string

status
optional

string

15.6.101. RmaAeraRequest

Name Description Schema

aeraReason
optional

Description of error
Length : 1 - 350
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#!?+%&£^\\u00C0-\\u00FF]*"

string

analyzeError
optional

Technician error analyze
Length : 1 - 370
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#!?+%&£^\\u00C0-\\u00FF]*"

string

nff
optional

No Fault Found

boolean

receivedStockTime
optional

Time when returned terminal is received at stock

string (date-time)

returnToManufacturer
optional

Return terminal to manufacturer

boolean

rmaNumber
optional

RMA Number
Length : 4 - 50
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

15.6.102. RmaFSRequest

Name Description Schema

cablesReplaced
optional

Is cables replaced

boolean

comment
optional

Comment
Length : 1 - 1800
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#!?+%&£^\\u00C0-\\u00FF]*"

string

reason
optional

Description of error
Length : 1 - 350
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#!?+%&£^\\u00C0-\\u00FF]*"

string

replacedDueToError
optional

Is terminal replaced due to error

boolean

resetOk
optional

Was reset DIS settings successful

boolean

resetPerformed
required

Is reset DIS settings performed

boolean

returnTerminal
optional

Will terminal be returned

boolean

serialNumber
optional

Terminal serial number
Length : 5 - 80

string

terminalId
optional

Unique ID for a terminal
Length : 1 - 80
Pattern : "^[0-9A-Za-z]{6,16}$"

string

terminalMoved
optional

Is terminal moved by merchant

boolean

15.6.103. RmaFieldService

Name Description Schema

cablesReplaced
optional

Is cables replaced

boolean

comment
optional

Comment
Length : 1 - 1800
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#!?+%&£^\\u00C0-\\u00FF]*"

string

reason
optional

Description of error
Length : 1 - 350
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#!?+%&£^\\u00C0-\\u00FF]*"

string

replacedDueToError
optional

Is terminal replaced due to error

boolean

resetOk
optional

Was reset DIS settings successful

boolean

resetPerformed
required

Is reset DIS settings performed

boolean

returnTerminal
optional

Will terminal be returned

boolean

terminalMoved
optional

Is terminal moved by merchant

boolean

15.6.104. RmaListInfo

Name Description Schema

created
required

Created

string (date-time)

deviceType
required

The terminal device type.

enum (LANE_5000, LANE_3000, MOVE_5000)

merchantId
required

Unique ID of Merchant
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-]{0,20}"

string

merchantName
optional

The name of the merchant
Length : 1 - 30
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

returnTerminal
optional

Will terminal be returned

boolean

rmaId
required

Id on RMA schema

integer (int64)

rmaNumber
optional

RMA Number
Length : 4 - 50
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

serialNumber
optional

Terminal serial number
Length : 5 - 80

string

terminalId
optional

Unique ID for a terminal
Length : 1 - 80
Pattern : "^[0-9A-Za-z]{6,16}$"

string

15.6.105. RmaResponse

Name Description Schema

aeraReason
optional

Description of error
Length : 1 - 350
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

analyzeError
optional

Technician error analyze
Length : 1 - 370
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

cablesReplaced
optional

Is cables replaced

boolean

comment
optional

Comment
Length : 1 - 1800
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#!?+%&£^\\u00C0-\\u00FF]*"

string

created
required

Created

string (date-time)

createdBy
required

Created by
Length : 1 - 70

string

deviceType
required

The terminal device type.

enum (LANE_5000, LANE_3000, MOVE_5000)

merchantId
required

Unique ID of Merchant
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-]{0,20}"

string

merchantName
optional

The name of the merchant
Length : 1 - 30
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

nff
optional

No Fault Found

boolean

reason
optional

Description of error
Length : 1 - 350
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#!?+%&£^\\u00C0-\\u00FF]*"

string

receivedStockTime
optional

Time when returned terminal is received at stock

string (date-time)

replacedDueToError
optional

Is terminal replaced due to error

boolean

resetOk
optional

Was reset DIS settings successful

boolean

resetPerformed
required

Is reset DIS settings performed

boolean

returnTerminal
optional

Will terminal be returned

boolean

returnToManufacturer
optional

Return terminal to manufacturer

boolean

rmaId
required

Id on RMA schema

integer (int64)

rmaNumber
optional

RMA Number
Length : 4 - 50
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

serialNumber
optional

Terminal serial number
Length : 5 - 80

string

status
required

RMA status

enum (INITIALIZED, PENDING, COMPLETED)

statusTime
required

Last status change

string (date-time)

terminalId
optional

Unique ID for a terminal
Length : 1 - 80
Pattern : "^[0-9A-Za-z]{6,16}$"

string

terminalMoved
optional

Is terminal moved by merchant

boolean

userInfo
required

UserInfo

15.6.106. ServiceProperties

Name Schema

entry
optional

< Entry > array

15.6.107. ServiceRequestTms

Name Schema

businessInfo
optional

BusinessInfoServiceTms

businessInfoLocation
optional

BusinessInfoServiceTms

communicationLang
optional

string

effectiveDate
optional

string (date-time)

locationId
optional

string

merchantId
optional

string

orderId
optional

string

returnBox
optional

boolean

serviceType
optional

string

supplementaryData
optional

SupplementaryDataTms

terminalId
optional

string

terminalSettings
optional

TerminalSettingTms

15.6.108. ServiceResponseTms

Name Schema

resHeader
optional

ResponseHeaderTms

15.6.109. ShipmentFileRequest

Name Description Schema

b64File
required

Base64 encode file
Pattern : "\\A[a-zA-Z\\d\\/+]+={0,2}\\z"

string

fileName
optional

Name on file
Length : 0 - 255
Pattern : "^[\\p{Alnum}- ._]*"

string

fileType
required

Type of file

enum (PLAIN, EXCEL)

15.6.110. ShipmentInfoResponse

Name Schema

material
optional

string

serialNumber
optional

string

status
optional

enum (ZERO, INITIALIZED, ORDERED, PENDING, INPROGRESS, ACTIVE, INACTIVE, SUSPENDED, CANCELED, DELETED, DELETE_PENDING, INACTIVE_PENDING, ACTIVE_PENDING, FAILED, COMPLETED, COMPLETED_PARTIAL, SHIPPED, ONSTOCK, LOST, DEFAULT, ACTIVE_REPLACED, ARCHIVED)

statusTime
optional

string (date-time)

terminalId
optional

string

15.6.111. ShipmentQueryRequest

Name Description Schema

model
optional

Terminal model
Length : 0 - 50
Pattern : "^[\\p{Alnum}-]*"

string

status
optional

Status filter

enum (SHIPPED, ONSTOCK, ORDERED)

15.6.112. SoldTerminalRequest

Name Description Schema

deviceType
required

The terminal device type.

enum (LANE_5000, LANE_3000, MOVE_5000)

organisationNumber
optional

Optional field for deviant invoice receiver of sold terminal

string

serialNumber
required

The terminal serial number.

string

warrantyEnd
optional

Warenty period end. For sold terminals.

string (date)

warrantyStart
optional

Warenty period start. For sold terminals.

string (date)

15.6.113. SoldTerminalResponse

Name Description Schema

customerId
required

CustomerId sold to.

string

deviceType
optional

device type.

string

isBilled
required

Is terminal invoiced and billed to customer.

boolean

purchaseDate
optional

date of purchase.

string (date)

rentType
required

Rent type, always SOLD for sold terminals.

string

serialNumber
required

SerialNumber sold.

string

warrantyEnd
optional

End of warranty.

string (date)

warrantyStart
optional

Start of warranty.

string (date)

15.6.114. Station

Name Schema

address
optional

Address

businessId
optional

string

id
optional

integer (int64)

name
optional

string

originalId
optional

string

timezone
optional

string

15.6.115. Status

Name Schema

description
optional

string

status
optional

string

15.6.116. SupplementaryDataTms

Name Schema

any
optional

< object > array

15.6.117. TaskApi

Name Schema

body
optional

string

continueOnError
optional

boolean

createdtime
optional

string (date-time)

id
optional

integer (int64)

idReference
optional

string

queueName
optional

string

receiptHandle
optional

string

status
optional

integer (int32)

statustime
optional

string (date-time)

workflowId
optional

integer (int32)

15.6.118. TaskListResponse

Name Schema

tasks
optional

< TaskApi > array

15.6.119. Terminal

The Terminal data needed to create a new Terminal in the Aera system.

Name Description Schema

commonName
optional

Customer reference of terminal. Could be an customer generated unique id.
Length : 1 - 40
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

deviceType
required

The terminal device type.

enum (LANE_5000, LANE_3000, MOVE_5000)

rentType
optional

the terminal rent type

enum (MONTHLY, DAILY, SOLD)

terminalConfigInfo
optional

TerminalConfigInfo

15.6.120. TerminalAccessory

Terminal accessories if required.

Name Description Schema

productCode
required

Product Code of terminal accessory

string

productName
required

Product name of terminal accessory

string

quantity
required

Quantity of terminal accessory

integer (int32)

15.6.121. TerminalConfigInfo

Information about terminal configuration profile, and deployment strategy used when new configuration of Terminals shall be deployed.

Name Description Schema

configDeploymentTag
optional

Deployment of new configuration on terminals shall be a controlled process, using different deployment strategies agreed upon between customer and Aera.
If default strategy is used, Aera will deploy terminal config in waves, depending on the total number of terminals registered on a merchantId, and the configDeploymentTags set.
Example: Customer has 5 terminals registered on merchant:
1 terminal has configDeploymentTag=1
1 terminal has configDeploymentTag=2
3 terminal has configDeploymentTag=3
This will give the following strategy when deploying new configuration:
Config deployed in first wave: 1 terminal
Config deployed in second wave: 1 terminal
Config deployed in third wave: 3 terminals

If no tag is specified, all terminals registered on a merchantId will get configDeploymentTag = â1â. This means that Aera will deploy new terminal-configuration in only 1 wave.

integer (int32)

configLabel
required

A configuration name used to create and deploy the right configuration on the terminal. The label names will be agreed on by Aera and customer.
Length : 1 - 255
Pattern : "^[a-zA-Z0-9_.-]*$"

string

configVersion
optional

Optional version of the configuration name. If not given and multiple versions exists, newest will be selected
Length : 1 - 20
Pattern : "^[a-zA-Z0-9_.-]*$"

string

15.6.122. TerminalConfigProperty

Configurations properties

Name Schema

key
optional

string

type
optional

enum (FIXED, DYNAMIC, DYNAMIC_OPTIONAL)

value
optional

string

15.6.123. TerminalConfigTemplateRequest

Name Description Schema

chains
optional

List of chains configuration is valid for

< integer (int32) > array

configLabel
required

Name on configurations template
Length : 0 - 255
Pattern : "^[a-zA-Z0-9_.-]*$"

string

configProperties
required

Configurations properties

< string, < TerminalConfigProperty > array > map

configVersion
required

Version on configurations template
Length : 0 - 20
Pattern : "^[a-zA-Z0-9_.-]*$"

string

current
optional

Set if this version should be default

boolean

deviceTypes
optional

List of Device Types configuration is valid for

< enum (LANE_5000, LANE_3000, MOVE_5000) > array

type
optional

Type to match PaymentService

enum (TIPPEKASSE, STANDARDKASSE, NETTHANDEL, OTHER)

15.6.124. TerminalConfigTemplateResponse

Name Description Schema

chains
optional

List of chains configuration is valid for

< integer (int32) > array

configLabel
required

Name on configurations template
Length : 0 - 255
Pattern : "^[a-zA-Z0-9_.-]*$"

string

configProperties
required

Configurations properties

< string, < TerminalConfigProperty > array > map

configVersion
required

Version on configurations template
Length : 0 - 20
Pattern : "^[a-zA-Z0-9_.-]*$"

string

deviceTypes
optional

List of Device Types configuration is valid for

< enum (LANE_5000, LANE_3000, MOVE_5000) > array

status
required

Status on configuration template

enum (ACTIVE, DEFAULT, INACTIVE)

type
optional

Type to match PaymentService

enum (TIPPEKASSE, STANDARDKASSE, NETTHANDEL, OTHER)

15.6.125. TerminalData

All essential data registered on the terminal in the Aera system.

Name Description Schema

acceptedCards
required

A list of cards the terminal accepts based on the Aera configuration. It may be a different configuration at the Acquirer.

< enum (BANKAXEPT, VISA, MASTERCARD, AMEX, DINERS, DISCOVER, JCB, MAESTRO, CUP, AERA, COOPCORP, NETSSG, NETSKG, IGIVEGK, IGIVEGS, IGIVEKK, IGIVEKS, IGIVEF, COOPVISA, TRUMF, NETSGK, NGCORP, NGGIFT, EVRYLOYAL, NETSKK, COOPMC, UNIGK, SENTRUMSGK) > array

commonName
optional

Customer reference of terminal. Could be an customer generated unique id.
Length : 1 - 40
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

configChanged
optional

True if configuration data elements in TerminalService has changed. It is recommended to deploy configuration on Terminal if this is true to be in sync with changes in the TerminalService.

boolean

createdDate
required

The date the Terminal ID was created/Terminal was ordered.

string (date)

deviceType
required

The terminal device type.

enum (LANE_5000, LANE_3000, MOVE_5000)

lastHeartbeat
optional

Last heartbeat received from terminal

string (date-time)

lastTransaction
optional

Last transaction received from terminal

string (date-time)

rentType
optional

The terminal rent type.

enum (MONTHLY, DAILY, SOLD)

serialNumber
optional

The terminal serial number. This will be added when the terminal is installed and activated (by Field service).
Length : 1 - 80

string

serviceId
required

Merchant´s serviceId.
Length : 1 - 20

string

terminalConfigInfo
required

TerminalConfigInfo

terminalId
required

Unique ID for a terminal. The terminalId is created by Aera.
Length : 1 - 80
Pattern : "^[0-9A-Za-z]{6,16}$"

string

terminalStatusInfo
required

TerminalStatusInfo

15.6.126. TerminalDataResponse

Name Description Schema

deployHistory
optional

Contains terminal configuration history

< TerminalDeployment > array

terminalData
required

TerminalData

terminalStatistics
optional

TerminalStatistics

15.6.127. TerminalDeployment

Contains terminal configuration history

Name Description Schema

configLabel
required

A configuration name used to create and deploy the right configuration on the terminal. The label names will be agreed on by Aera and customer.
Length : 1 - 40
Pattern : "^[a-zA-Z0-9_.-]*$"

string

configVersion
required

Optional version of the configuration name. If not given and multiple versions exists, newest will be selected
Length : 1 - 10
Pattern : "^[a-zA-Z0-9_.-]*$"

string

status
required

enum (INITIALIZED, ACTIVE, PENDING, INACTIVE, DELETED, DELETE_PENDING, INACTIVE_PENDING, ACTIVE_PENDING, FAILED)

time
required

When was configuration deployed

string (date-time)

15.6.128. TerminalHistory

Name Schema

id
optional

integer (int64)

operation
optional

string

operationTime
optional

string (date-time)

serialNumber
optional

string

terminalId
optional

string

terminalServiceId
optional

integer (int64)

15.6.129. TerminalInfo

Subset of info of terminals added to terminal Service

Name Description Schema

commonName
optional

Customer reference of terminal. Could be an customer generated unique id.
Length : 1 - 40
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

created
required

The date/time the Terminal ID was created/Terminal was ordered.

string (date-time)

deviceType
required

The terminal device type.

enum (LANE_5000, LANE_3000, MOVE_5000)

serialNumber
optional

The terminal serial number. This will be added when the terminal is installed and activated (by Field service).
Length : 1 - 80

string

terminalId
required

Unique ID for a terminal. The terminalId is created by Aera.
Length : 1 - 80
Pattern : "^[0-9A-Za-z]{6,16}$"

string

terminalStatusInfo
required

TerminalStatusInfo

15.6.130. TerminalModelResponse

Name Description Schema

terminalModels
optional

Contains terminal models available order

< string > array

15.6.131. TerminalReport

Name Schema

reportGenerationElapsedTimeMillis
optional

integer (int64)

reportTimestamp
optional

string (date-time)

terminalId
optional

string

terminalReportAggregated
optional

TerminalReportAggregated

terminalReportRealtime
optional

TerminalReportRealtime

traceId
optional

string

15.6.132. TerminalReportAggregated

Name Schema

beginPeriod
optional

string (date-time)

endPeriod
optional

string (date-time)

readErrorsPeriod
optional

integer (int64)

readErrorsTotal
optional

integer (int64)

transactionCountersPeriod
optional

< TransactionCount > array

transactionCountersTotal
optional

< TransactionCount > array

15.6.133. TerminalReportRealtime

Name Schema

heartbeats
optional

< HeartbeatDto > array

terminalData
optional

TerminalData

transactions
optional

< TransactionDto > array

15.6.134. TerminalRequest

Name Description Schema

terminal
required

Terminal

terminalAccessories
optional

Terminal accessories if required.

< TerminalAccessory > array

terminalShipmentData
optional

TerminalShipmentData

15.6.135. TerminalResponse

Name Schema

terminalData
required

TerminalData

15.6.136. TerminalSearchData

A subset of data registered on the terminal in the Aera system

Name Description Schema

cardSchemas
optional

A list of different card schemes.

< enum (BANKAXEPT, VISA, MASTERCARD, AMEX, DINERS, DISCOVER, JCB, MAESTRO, CUP, AERA, COOPCORP, NETSSG, NETSKG, IGIVEGK, IGIVEGS, IGIVEKK, IGIVEKS, IGIVEF, COOPVISA, TRUMF, NETSGK, NGCORP, NGGIFT, EVRYLOYAL, NETSKK, COOPMC, UNIGK, SENTRUMSGK) > array

commonName
optional

Customer reference of terminal. Could be an customer generated unique id.
Length : 1 - 40
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

configChanged
optional

True if configuration data elements in TerminalService has changed. It is recommended to deploy configuration on Terminal if this is true to be in sync with changes in the TerminalService.

boolean

createdDate
required

The date the Terminal ID was created/Terminal was ordered.

string (date)

deviceType
required

The terminal device type.

enum (LANE_5000, LANE_3000, MOVE_5000)

lastHeartbeat
optional

Last heartbeat received from terminal

string (date-time)

lastTransaction
optional

Last transaction received from terminal

string (date-time)

merchantInfo
required

MerchantInfo

serialNumber
optional

The terminal serial number. This will be added when the terminal is installed and activated (by Field service).
Length : 1 - 80

string

serviceCommonName
optional

Customer friendly description of terminal service.
Length : 1 - 50
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

serviceId
required

Terminal service serviceId.
Length : 1 - 20

string

terminalConfigInfo
required

TerminalConfigInfo

terminalId
required

Unique ID for a terminal. The terminalId is created by Aera.
Length : 1 - 80
Pattern : "^[0-9A-Za-z]{6,16}$"

string

terminalStatusInfo
required

TerminalStatusInfo

15.6.137. TerminalSearchResponse

Name Description Schema

terminalSearchDataList
required

A subset of data registered on the terminal in the Aera system

< TerminalSearchData > array

15.6.138. TerminalService

Terminal service to be updated in the Aera system. A terminal service groups together a collection of IDâs (MIDs) and card schemes to different acquirers for the merchant.

Name Description Schema

acquirerInfos
required

List of aquirerInfo the Merchant shall use in this TerminalService. A TerminalService can only be registered with ONE Aquire MID/BAXNUMBER for each acquirer registered, and no duplicate CardSchema names in a TerminalService

< AcquirerInfo > array

activeFrom
required

The date the payment service was created, or the day the payment service is set to become active by customer. This field is only for informational purposes

string (date)

activeTo
optional

The date the payment service will become inactive.

string (date)

bankAxeptOrder
optional

BankAxeptOrder

commonName
optional

Customer friendly description of payment service.
Length : 1 - 50
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

idLookup
required

Enroll Payment service and payment devices (terminals) in Id service.

boolean

mcc
required

Merchant Category Code. This value consists of four digits and is provided by the acquirer.
Length : 4

string

reconAutoClose
optional

Reconciliation Auto Close. If not set, defaults to true

boolean

15.6.139. TerminalServiceCreateRequest

Name Description Schema

initialStatus
optional

Initial status on TerminalService when created. Defaults to ACTIVE. Can be used to set the TerminalService to INACTIVE when created in the TMS system.

enum (ACTIVE, INACTIVE)

merchantId
required

Owner of the terminal service
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-]{0,20}"

string

terminalService
required

TerminalService

15.6.140. TerminalServiceDetail

Terminal service registered on a Merchant in the Aera system

Name Description Schema

acquirerInfoDetails
required

List of aquirerInfo objects with status details.

< AcquirerInfoDetail > array

activeFrom
required

The date the payment service was created, or the day the payment service is set to become active by customer. This field is only for informational purposes

string (date)

activeTo
optional

The date the payment service will become inactive.

string (date)

commonName
optional

Customer friendly description of payment service.
Length : 1 - 50
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

idLookup
required

Enroll Payment service and payment devices (terminals) in Id service.

boolean

mcc
required

Merchant Category Code. This value consists of four digits and is provided by the acquirer.
Length : 4

string

paymentServiceStatus
required

TerminalServiceStatusDetail

reconAutoClose
required

Reconciliation Auto Close.

boolean

serviceId
required

Unique id identifying the TerminalService. This id is used when ordering terminals used to process payments.
Length : 1 - 20

string

15.6.141. TerminalServiceListResponse

Name Description Schema

merchantId
required

Unique ID of Merchant
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-]{0,20}"

string

serviceList
optional

List with short info on each terminal services

< TerminalServiceShort > array

15.6.142. TerminalServiceRequest

Name Schema

terminalService
required

TerminalService

15.6.143. TerminalServiceResponse

Name Description Schema

merchantId
required

Unique ID of Merchant generated by Aera
Pattern : "^[a-zA-Z0-9\\-]{0,20}"

string

terminalInfos
optional

Subset of info of terminals added to terminal Service

< TerminalInfo > array

terminalServiceDetail
required

TerminalServiceDetail

15.6.144. TerminalServiceShort

List with short info on each terminal services

Name Description Schema

commonName
optional

Customer friendly description of payment service.
Length : 1 - 50
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

serviceId
required

Unique id identifying the TerminalService.
Length : 1 - 20

string

status
required

TerminalService status.

enum (INITIALIZED, ACTIVE, PENDING, INACTIVE, DELETED, DELETE_PENDING, INACTIVE_PENDING, ACTIVE_PENDING, FAILED)

type
optional

Type to match configuration profile

enum (TIPPEKASSE, STANDARDKASSE, NETTHANDEL, OTHER)

15.6.145. TerminalServiceStatusDetail

TerminalService status information.

Name Description Schema

message
optional

Additional status info.
Length : 1 - 255

string

status
required

TerminalService status.

enum (INITIALIZED, ACTIVE, PENDING, INACTIVE, DELETED, DELETE_PENDING, INACTIVE_PENDING, ACTIVE_PENDING, FAILED)

timestamp
required

Date/Time GMT.

string (date-time)

15.6.146. TerminalServicesTms

Name Schema

terminalService
optional

< TerminalService > array

15.6.147. TerminalSettingTms

Name Schema

address1
optional

string

address2
optional

string

address3
optional

string

address4
optional

string

address5
optional

string

address6
optional

string

cardSchemes
optional

CardSchemesTms

cashBackLimits
optional

string

cashback
optional

string

clessActive
optional

string

closeBatchTime
optional

string

countryCode
optional

string

currencies
optional

string

currencyCode
optional

string

dcc
optional

string

defaultCliLang
optional

string

defaultMerchLang
optional

string

emv9F15MerchCat
optional

string

forceOffline
optional

string

forceOfflineCfg
optional

string

forceUpdate
optional

string

iccid
optional

string

journaling
optional

string

keyboardBeep
optional

string

loyalty
optional

string

manualCardEnter
optional

string

maxAmountLimit
optional

string

merchantCode
optional

string

merchantIDAMEX
optional

string

merchantId
optional

string

minAmountLimit
optional

string

moto
optional

string

periodOfAU
optional

string

posipAddress
optional

string

powerSave
optional

string

preAuthorization
optional

string

printFooter
optional

string

printHeader
optional

string

printOptions
optional

string

profileName
optional

string

profileType
optional

string

pwdManagerPIN
optional

string

pwdSystemPIN
optional

string

pwdTerminalPIN
optional

string

reference1Maximal
optional

string

reference1Minimal
optional

string

reference1Name
optional

string

reference1NumOnly
optional

string

reference2Maximal
optional

string

reference2Minimal
optional

string

reference2Name
optional

string

reference2NumOnly
optional

string

sfqSize
optional

integer (int64)

startTimeOfAU
optional

string

supportedLang
optional

string

terminalServices
optional

TerminalServicesTms

tipAmount
optional

string

typeOfOwnership
optional

string

15.6.148. TerminalShipmentData

Shipment information.

Name Description Schema

comment
optional

Required if shipmentMethod is OTHER

string

orderUrgency
optional

The date the terminal should be activated and ready to accept payments.

enum (SAME_DAY, NEXT_DAY)

requestedDeliveryDate
required

Expected date of delivery of terminal at merchant.

string (date)

shipmentMethod
required

Method of shipment. POSTAL, TECHNICIAN or OTHER. If other, please add a comment in comment field

enum (POSTAL, TECHNICIAN, OTHER)

15.6.149. TerminalShortInfo

Name Schema

commonName
optional

string

configLabel
optional

string

configVersion
optional

string

deviceType
optional

enum (LANE_5000, LANE_3000, MOVE_5000)

paymentServiceId
optional

string

paymentServiceName
optional

string

serialnumber
optional

string

status
optional

enum (ORDERED, PENDING, SUSPENDED, ACTIVE, CANCELLED, DELETED, DELETE_PENDING, FAILED, INACTIVE)

terminalId
optional

string

15.6.150. TerminalShortListResponse

Name Schema

merchantId
optional

string

terminalInfo
optional

< TerminalShortInfo > array

15.6.151. TerminalStatistics

Statistics collected of terminal usage if terminal is / has been online.

Type : object

15.6.152. TerminalStatusInfo

Status information of the terminal.

Name Description Schema

status
optional

Status code.

enum (ORDERED, PENDING, SUSPENDED, ACTIVE, CANCELLED, DELETED, DELETE_PENDING, FAILED, INACTIVE)

statusMessage
optional

Additional status message.
Length : 1 - 255

string

timestamp
optional

Date/Time GMT.

string (date-time)

15.6.153. TmsPropertyTms

Name Schema

propertyCode
optional

string

propertyValue
optional

string

15.6.154. TmsTerminalInfoTms

Name Schema

appVersion
optional

string

availableAppSize
optional

integer (int64)

availableAppVersion
optional

string

availableOSSize
optional

integer (int64)

availableOSVersion
optional

string

cardBrandConfiguration
optional

string

carddbId
optional

integer (int64)

carddbName
optional

string

chipCarddbId
optional

integer (int64)

chipCarddbName
optional

string

clessdbId
optional

integer (int64)

clessdbName
optional

string

confirmedAppVersion
optional

string

confirmedOSVersion
optional

string

extOrgUnitId
optional

string

orgUnitId
optional

integer (int64)

osVersion
optional

string

parentTerminalID
optional

string

sentAppVersion
optional

string

sentOSVersion
optional

string

templateId
optional

integer (int64)

templateName
optional

string

terminalId
optional

string

terminalName
optional

string

terminalParamList
optional

< TmsTerminalParamTms > array

terminalPropertyList
optional

< TmsPropertyTms > array

terminalServicesList
optional

< TmsTerminalServiceTms > array

15.6.155. TmsTerminalParamTms

Name Schema

changed
optional

string (date-time)

paramName
optional

string

paramValue
optional

string

15.6.156. TmsTerminalServiceTms

Name Schema

bankMerchantId
optional

string

bankTerminalId
optional

string

defaultService
optional

boolean

merchantCode
optional

string

refCode
optional

string

serviceCode
optional

string

serviceProperties
optional

ServiceProperties

15.6.157. TransactionCount

Name Schema

count
optional

integer (int64)

posEntryMode
optional

enum (CHIP, NFC)

15.6.158. TransactionDto

Name Schema

cardData
optional

CardDataDto

device
optional

Device

hostMerchantId
optional

string

processingMode
optional

string

result
optional

string

station
optional

Station

transactionTime
optional

string (date-time)

transactionType
optional

string

15.6.159. TsBulkDetailsObj

Details on a bulk update

Name Schema

idLabel
optional

string

merchantId
optional

string

status
optional

enum (INITIALIZED, PENDING, INPROGRESS, COMPLETED, COMPLETED_PARTIAL, FAILED)

statusText
optional

string

statusTime
optional

string (date-time)

terminalServiceId
optional

integer (int64)

15.6.160. TsBulkHistoryObj

Bulk update details

Name Schema

acquirerInfoList
optional

< AcquirerBulkInfo > array

created
optional

string (date-time)

id
optional

integer (int64)

idLookup
optional

boolean

reconAutoClose
optional

boolean

searchType
optional

string

searchValue
optional

string

status
optional

enum (INITIALIZED, PENDING, INPROGRESS, COMPLETED, COMPLETED_PARTIAL, FAILED)

statusTime
optional

string (date-time)

tsType
optional

string

15.6.161. UpdateTerminalInfo

Name Description Schema

commonName
optional

Customer reference of terminal
Length : 1 - 40
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

configDeploymentTag
optional

Configuration deployment group

integer (int32)

15.6.162. UserInfo

Info about user created RMA schema

Name Description Schema

email
optional

This value may be used retrieve an existing contact in Aera. If now match found, the whole contact element may be ignored.
Length : 1 - 100

string

mobile
optional

The user mobile number.
Length : 1 - 11
Pattern : "^[\\p{Digit}+]*"

string

name
optional

Name of user.
Length : 1 - 200
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

16. Terminal Health System (THS)

16.1. What is THS

Terminal Health System (THS) is an information system for getting near real-time information about operative terminals.

16.2. Paths

Descriptions of resources/paths in the service.

16.2.1. Get Application Status (Health check)

GET /ths/health
Responses
HTTP Code Description Schema

200

OK

Status
Produces

  • application/json

Tags

  • Application Status

16.2.2. Reports

GET /ths/v1/report/terminal/{terminalId}
Parameters
Type Name Schema Default

Path

terminalId
required

string

Query

beginPeriod
optional

string (date-time)

Query

endPeriod
optional

string (date-time)

Query

maxNumHeartbeats
optional

integer (int32)

5

Query

maxNumTransactions
optional

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

TerminalReport
Produces

  • application/json

Tags

  • Reports

Example HTTP request
GET /ths/v1/report/terminal/AE12345?beginPeriod=2019-10-01T00:00:00Z&endPeriod=2019-11-01T00:00:00Z HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic2NvcGUiOlsiUk9MRV9JTlRFUk5BTCIsIlJPTEVfQURNSU4iLCJjbXNBbGwiLCJ0bXNBbGwiLCJmc0FsbCIsInBvc3RBcnRBcHNUcmFuc2FjdGlvbiIsInBvc3RBcnRJYm1UcmFuc2FjdGlvbiIsInBvc3RBcnRBZXZpVHJhbnNhY3Rpb24iLCJwb3N0QXJ0QWV2aUV2ZW50IiwiZ2V0QXJ0SWJtVHJhbnNhY3Rpb24iLCJnZXRBcnRBZXZpVHJhbnNhY3Rpb24iXSwic3ViIjoiYXJ0LXN1cGVybG9jYWwtdXNlciIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6OTc3Njc3MjAwLCJpYXQiOjk3NzY3NzIwMCwiZXhwIjo0MTMzMzUwODAwLCJqdGkiOiI2ZWE5M2RlMy05MGNlLTRiOTgtOTcwYy1kNmExNGI0NzNiM2YifQ.PxqsyQeyB96C9y8BDZYQNJPQjl7ZDHy7BL9bKCwTg4rdpumdn0u-dyuJI_CsJJaLlg3X0dSsShP5hg_k3rN10mTbBNpTlwB6sS2UR_U_qj7ZRg-VO9NHYwghF-tPoyRuKEaoiHhrx2tao0_kb31VC3I5ZpnK2aIedPYd0SbVza3UYUGPml6vh8BFxTfgrVXjVpymKbQwtPFNwYHj-lXBaMQMPwUV8ionQFUGN2lN4vNBLF2p9LiNPNxssvgaJoLvVzuNt8A-AzjCjRG-yGMt3Ulb5Rs6MDmpKvG5NpSD_MiAOx8ukCxIH2P6C2ja2tMY9uSPCkInpZ7SX3tLuZ2pwA
Accept: application/json
Host: api.aerahost.com
Example HTTP response
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
signature: b/a1VeDQJPldj9suGPmRRvVJz2ScBgYRcqELVQbSY6CBaO36E9nhK8dF43CHTNMziPJXrXCZhMZigKS2sujEMI1KbSUOnVrOonyN3e/IY7wPtoKb6GDQDCkOH8BKsCxeAYHEu+aluoRKtCXUhxeabqBEQ96kIv0DcY39pJEC5SsptqRLdzIMej8hJFWxmb6D3Yp0CavDwsY5LppmMoBycBMyDkc1+48Geie3JFLE/wgQSIhWqTL+7+yEFRx8C+B8xA5DATZbgLW7FqLjJ6xTEDl8Zn/drgoAMkJhrSoRQ8roPU55iggxX5GNTswf5XClR5PcrySJ6+5fqd/Sn/9bPA==
Content-Length: 4331

{
  "reportTimestamp" : "2024-05-02T17:06:58.031913173Z",
  "terminalId" : "AE12345",
  "terminalReportAggregated" : {
    "beginPeriod" : "2019-10-01T00:00:00Z",
    "endPeriod" : "2019-11-01T00:00:00Z",
    "readErrorsPeriod" : 1,
    "readErrorsTotal" : 10,
    "transactionCountersPeriod" : [ {
      "count" : 50,
      "posEntryMode" : "NFC"
    }, {
      "count" : 5,
      "posEntryMode" : "CHIP"
    } ],
    "transactionCountersTotal" : [ {
      "count" : 500,
      "posEntryMode" : "NFC"
    }, {
      "count" : 50,
      "posEntryMode" : "CHIP"
    } ]
  },
  "terminalReportRealtime" : {
    "terminalData" : {
      "terminalId" : "AE12345",
      "serialNumber" : "54321",
      "commonName" : "The terminal",
      "serviceId" : "M00000",
      "deviceType" : "LANE_5000",
      "lastHeartbeat" : "2024-05-02T17:06:57.950643792Z",
      "lastTransaction" : "2024-05-02T17:06:57.950648792Z",
      "terminalConfigInfo" : {
        "configLabel" : "Profil_StdKasse",
        "configVersion" : "001_13238_112001A",
        "configDeploymentTag" : 2
      },
      "createdDate" : "2024-05-02",
      "configChanged" : false,
      "rentType" : null,
      "acceptedCards" : [ "AMEX", "BANKAXEPT" ],
      "terminalStatusInfo" : {
        "status" : "ACTIVE",
        "statusMessage" : null,
        "timestamp" : "2024-05-02T17:06:57.950945461Z"
      }
    },
    "transactions" : [ {
      "transactionTime" : "2024-05-02T17:06:57.953681414Z",
      "transactionType" : "Purchase",
      "processingMode" : "Online",
      "hostMerchantId" : "M00000",
      "result" : "Approved",
      "cardData" : {
        "cardCategory" : "BankCard",
        "cardEntryMode" : "ChipContactless",
        "cardProduct" : "BankAxept"
      },
      "station" : null,
      "device" : {
        "attended" : "t",
        "businessId" : "AE12345",
        "configurationVersion" : null,
        "deviceCategory" : "EFTPOSTerminal",
        "deviceModel" : "TeliumTetra_L5000",
        "deviceType" : "IndoorPaymentTerminal",
        "id" : 987654321,
        "merchantCategoryCode" : "5814",
        "originalId" : "AE12345",
        "osVersion" : "11.20.01 PatchA(b06)",
        "serialNumber" : "54321",
        "softwareVersion" : "0401.132038",
        "xpayConfiguration" : "eft_port=COM10;pmg_addr_0=10.0.0.0;pmg_port_0=11186;pmg_addr_1=10.10.10.10;pmg_port_1=11186;log_size=100000;log_restart=23:59;log_name=date;menu_opt=3;bt_enter=Bekrefte;bt_cancel=Avbryte;bt_yes=Ja;bt_no=Nei;eft_codepage=2;timeout_connect=4;pmg_can=1;pmg_pre_open=1;pmg_ssl=1;abort_response=1;scan=1;pmg_msg=2;opi_main_addr=127.0.0.1;com_restart=5;",
        "xpayVersion" : "4.36.19.6"
      }
    }, {
      "transactionTime" : "2024-05-02T17:06:57.953720824Z",
      "transactionType" : "Purchase",
      "processingMode" : "Online",
      "hostMerchantId" : "M00000",
      "result" : "Approved",
      "cardData" : {
        "cardCategory" : "BankCard",
        "cardEntryMode" : "ChipContact",
        "cardProduct" : "MasterCard"
      },
      "station" : null,
      "device" : {
        "attended" : "t",
        "businessId" : "AE12345",
        "configurationVersion" : null,
        "deviceCategory" : "EFTPOSTerminal",
        "deviceModel" : "TeliumTetra_L5000",
        "deviceType" : "IndoorPaymentTerminal",
        "id" : 987654321,
        "merchantCategoryCode" : "5814",
        "originalId" : "AE12345",
        "osVersion" : "11.20.01 PatchA(b06)",
        "serialNumber" : "54321",
        "softwareVersion" : "0401.132038",
        "xpayConfiguration" : "eft_port=COM10;pmg_addr_0=10.0.0.0;pmg_port_0=11186;pmg_addr_1=10.10.10.10;pmg_port_1=11186;log_size=100000;log_restart=23:59;log_name=date;menu_opt=3;bt_enter=Bekrefte;bt_cancel=Avbryte;bt_yes=Ja;bt_no=Nei;eft_codepage=2;timeout_connect=4;pmg_can=1;pmg_pre_open=1;pmg_ssl=1;abort_response=1;scan=1;pmg_msg=2;opi_main_addr=127.0.0.1;com_restart=5;",
        "xpayVersion" : "4.36.19.6"
      }
    } ],
    "heartbeats" : [ {
      "eventTime" : "2024-05-02T17:06:57.959605246Z",
      "deviceData" : {
        "freeFlashMemory" : 50,
        "freeRamMemory" : 0,
        "id" : 123456789,
        "signalStrength" : 0,
        "totalFlashMemory" : 500,
        "totalRamMemory" : 0
      }
    } ]
  },
  "reportGenerationElapsedTimeMillis" : 19,
  "traceId" : null
}
Example Curl request
$ curl 'https://api.aerahost.com/ths/v1/report/terminal/AE12345?beginPeriod=2019-10-01T00:00:00Z&endPeriod=2019-11-01T00:00:00Z' -i -X GET \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiQmVhcmVyIiwiZ3JhbnRfdHlwZSI6InBhc3N3b3JkIiwic2NvcGUiOlsiUk9MRV9JTlRFUk5BTCIsIlJPTEVfQURNSU4iLCJjbXNBbGwiLCJ0bXNBbGwiLCJmc0FsbCIsInBvc3RBcnRBcHNUcmFuc2FjdGlvbiIsInBvc3RBcnRJYm1UcmFuc2FjdGlvbiIsInBvc3RBcnRBZXZpVHJhbnNhY3Rpb24iLCJwb3N0QXJ0QWV2aUV2ZW50IiwiZ2V0QXJ0SWJtVHJhbnNhY3Rpb24iLCJnZXRBcnRBZXZpVHJhbnNhY3Rpb24iXSwic3ViIjoiYXJ0LXN1cGVybG9jYWwtdXNlciIsImlzcyI6ImFlcmEudGVzdC1yZXNvdXJjZSIsImF1ZCI6ImFlcmEudGVzdC1yZXNvdXJjZSIsIm5iZiI6OTc3Njc3MjAwLCJpYXQiOjk3NzY3NzIwMCwiZXhwIjo0MTMzMzUwODAwLCJqdGkiOiI2ZWE5M2RlMy05MGNlLTRiOTgtOTcwYy1kNmExNGI0NzNiM2YifQ.PxqsyQeyB96C9y8BDZYQNJPQjl7ZDHy7BL9bKCwTg4rdpumdn0u-dyuJI_CsJJaLlg3X0dSsShP5hg_k3rN10mTbBNpTlwB6sS2UR_U_qj7ZRg-VO9NHYwghF-tPoyRuKEaoiHhrx2tao0_kb31VC3I5ZpnK2aIedPYd0SbVza3UYUGPml6vh8BFxTfgrVXjVpymKbQwtPFNwYHj-lXBaMQMPwUV8ionQFUGN2lN4vNBLF2p9LiNPNxssvgaJoLvVzuNt8A-AzjCjRG-yGMt3Ulb5Rs6MDmpKvG5NpSD_MiAOx8ukCxIH2P6C2ja2tMY9uSPCkInpZ7SX3tLuZ2pwA' \
    -H 'Accept: application/json'

16.3. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

16.3.1. Address

Name Schema

city
optional

string

countryCode
optional

string

houseNumber
optional

string

street
optional

string

zipCode
optional

string

16.3.2. CardDataDto

Name Schema

cardCategory
optional

string

cardEntryMode
optional

string

cardProduct
optional

string

16.3.3. Device

Name Schema

attended
optional

string

businessId
optional

string

configurationVersion
optional

string

deviceCategory
optional

string

deviceModel
optional

string

deviceType
optional

string

id
optional

integer (int64)

merchantCategoryCode
optional

string

originalId
optional

string

osVersion
optional

string

serialNumber
optional

string

softwareVersion
optional

string

xpayConfiguration
optional

string

xpayVersion
optional

string

16.3.4. DeviceData

Name Schema

freeFlashMemory
optional

integer (int64)

freeRamMemory
optional

integer (int64)

id
optional

integer (int64)

signalStrength
optional

integer (int64)

totalFlashMemory
optional

integer (int64)

totalRamMemory
optional

integer (int64)

16.3.5. HeartbeatDto

Name Schema

deviceData
optional

DeviceData

eventTime
optional

string (date-time)

16.3.6. Station

Name Schema

address
optional

Address

businessId
optional

string

id
optional

integer (int64)

name
optional

string

originalId
optional

string

timezone
optional

string

16.3.7. Status

Name Schema

description
optional

string

status
optional

string

16.3.8. TerminalConfigInfo

Information about terminal configuration profile, and deployment strategy used when new configuration of Terminals shall be deployed.

Name Description Schema

configDeploymentTag
optional

Deployment of new configuration on terminals shall be a controlled process, using different deployment strategies agreed upon between customer and Aera.
If default strategy is used, Aera will deploy terminal config in waves, depending on the total number of terminals registered on a merchantId, and the configDeploymentTags set.
Example: Customer has 5 terminals registered on merchant:
1 terminal has configDeploymentTag=1
1 terminal has configDeploymentTag=2
3 terminal has configDeploymentTag=3
This will give the following strategy when deploying new configuration:
Config deployed in first wave: 1 terminal
Config deployed in second wave: 1 terminal
Config deployed in third wave: 3 terminals

If no tag is specified, all terminals registered on a merchantId will get configDeploymentTag = â1â. This means that Aera will deploy new terminal-configuration in only 1 wave.

integer (int32)

configLabel
required

A configuration name used to create and deploy the right configuration on the terminal. The label names will be agreed on by Aera and customer.
Length : 1 - 255
Pattern : "^[a-zA-Z0-9_.-]*$"

string

configVersion
optional

Optional version of the configuration name. If not given and multiple versions exists, newest will be selected
Length : 1 - 20
Pattern : "^[a-zA-Z0-9_.-]*$"

string

16.3.9. TerminalData

Name Description Schema

acceptedCards
required

A list of cards the terminal accepts based on the Aera configuration. It may be a different configuration at the Acquirer.

< enum (BANKAXEPT, VISA, MASTERCARD, AMEX, DINERS, DISCOVER, JCB, MAESTRO, CUP, AERA, COOPCORP, NETSSG, NETSKG, IGIVEGK, IGIVEGS, IGIVEKK, IGIVEKS, IGIVEF, COOPVISA, TRUMF, NETSGK, NGCORP, NGGIFT, EVRYLOYAL, NETSKK, COOPMC, UNIGK, SENTRUMSGK) > array

commonName
optional

Customer reference of terminal. Could be an customer generated unique id.
Length : 1 - 40
Pattern : "^[\\p{Alnum}- .,;:'`´/_()æøåÃÃÃÃ&@#\\u00C0-\\u00FF]*"

string

configChanged
optional

True if configuration data elements in TerminalService has changed. It is recommended to deploy configuration on Terminal if this is true to be in sync with changes in the TerminalService.

boolean

createdDate
required

The date the Terminal ID was created/Terminal was ordered.

string (date)

deviceType
required

The terminal device type.

enum (LANE_5000, LANE_3000, MOVE_5000)

lastHeartbeat
optional

Last heartbeat received from terminal

string (date-time)

lastTransaction
optional

Last transaction received from terminal

string (date-time)

rentType
optional

The terminal rent type.

enum (MONTHLY, DAILY, SOLD)

serialNumber
optional

The terminal serial number. This will be added when the terminal is installed and activated (by Field service).
Length : 1 - 80

string

serviceId
required

Merchant´s serviceId.
Length : 1 - 20

string

terminalConfigInfo
required

TerminalConfigInfo

terminalId
required

Unique ID for a terminal. The terminalId is created by Aera.
Length : 1 - 80
Pattern : "^[0-9A-Za-z]{6,16}$"

string

terminalStatusInfo
required

TerminalStatusInfo

16.3.10. TerminalReport

Name Schema

reportGenerationElapsedTimeMillis
optional

integer (int64)

reportTimestamp
optional

string (date-time)

terminalId
optional

string

terminalReportAggregated
optional

TerminalReportAggregated

terminalReportRealtime
optional

TerminalReportRealtime

traceId
optional

string

16.3.11. TerminalReportAggregated

Name Schema

beginPeriod
optional

string (date-time)

endPeriod
optional

string (date-time)

readErrorsPeriod
optional

integer (int64)

readErrorsTotal
optional

integer (int64)

transactionCountersPeriod
optional

< TransactionCount > array

transactionCountersTotal
optional

< TransactionCount > array

16.3.12. TerminalReportRealtime

Name Schema

heartbeats
optional

< HeartbeatDto > array

terminalData
optional

TerminalData

transactions
optional

< TransactionDto > array

16.3.13. TerminalStatusInfo

Status information of the terminal.

Name Description Schema

status
optional

Status code.

enum (ORDERED, PENDING, SUSPENDED, ACTIVE, CANCELLED, DELETED, DELETE_PENDING, FAILED, INACTIVE)

statusMessage
optional

Additional status message.
Length : 1 - 255

string

timestamp
optional

Date/Time GMT.

string (date-time)

16.3.14. TransactionCount

Name Schema

count
optional

integer (int64)

posEntryMode
optional

enum (CHIP, NFC)

16.3.15. TransactionDto

Name Schema

cardData
optional

CardDataDto

device
optional

Device

hostMerchantId
optional

string

processingMode
optional

string

result
optional

string

station
optional

Station

transactionTime
optional

string (date-time)

transactionType
optional

string

17. Aera RealTime (ART)

17.1. What is ART

Aera RealTime (ART) is a real-time processing system for transaction information

17.2. Paths

Descriptions of resources/paths in the service.

17.2.1. Post Aera Acquirer transaction

POST /art/AeraAcquirerTransaction
Body parameter

Name : body
Flags : required
Type : JsonNode

Responses
HTTP Code Description Schema

200

OK

No Content
Consumes

  • application/json

Tags

  • art

17.2.2. Post Aevi event

POST /art/aevievent
Parameters
Type Name Description Schema Default

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Query

bulk
optional

boolean

"false"
Body parameter

Name : body
Flags : required
Type : JsonNode

Responses
HTTP Code Description Schema

200

OK

No Content
Consumes

  • application/json

Tags

  • art

17.2.3. Post Aevi transaction

POST /art/aevitransaction
Body parameter

Name : body
Flags : required
Type : JsonNode

Responses
HTTP Code Description Schema

200

OK

No Content
Consumes

  • application/json

Tags

  • art

17.2.4. Post APS transaction

POST /art/apstransaction
Parameters
Type Name Description Schema

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string
Body parameter

Name : body
Flags : required
Type : JsonNode

Responses
HTTP Code Description Schema

200

OK

No Content
Consumes

  • application/json

Tags

  • art

17.2.5. GET /art/health

Description

Get Application Status (Health check)

Responses
HTTP Code Description Schema

200

OK

Status
Produces

  • application/json

Tags

  • art

17.2.6. Post IPG transaction

POST /art/ipgtransaction
Body parameter

Name : body
Flags : required
Type : JsonNode

Responses
HTTP Code Description Schema

200

OK

No Content
Consumes

  • application/xml

Tags

  • art

17.3. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

17.3.1. JsonNode

Type : object

17.3.2. Status

Name Schema

description
optional

string

status
optional

string

18. Aera Account Services (AKB)

18.1. What is Aera Account Services

Aera Account Services (AKB) is an account-to-account payment service from end-users to registered merchants through a solution with a central interim and daily settlement payout to the merchants.

AKB Onboarding: More information
AKB Payments through APS: More information

19. Settlement Services

19.1. What is Aera Settlement Services

Aera Settlement Service can handle settlement for transactions done inside and outside Aera. Payment transactions are sent to Settlement Service from originator and aggregated payments are done to defined merchants. AERA AML for merchants can be done during onboarding if required.

19.2. Paths

Descriptions of resources/paths in the service.

19.2.1. Add merchant account external

POST /settlement/api/manage/merchant/account/external
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : MerchantAccountRequest

Responses
HTTP Code Description Schema

200

OK

MerchantAccountResponse
Consumes

  • application/vnd.banking.v1+json

Produces

  • application/vnd.banking.v1+json

Tags

  • Settlement

19.2.2. Get merchant accounts by cmsMerchantId

GET /settlement/api/manage/merchant/account/external/cmsMerchantId/{cmsMerchantId}
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

cmsAid
optional

string

Header

cmsUid
optional

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

cmsMerchantId
required

string
Responses
HTTP Code Description Schema

200

OK

MerchantAccountListResponse
Produces

  • application/vnd.banking.v1+json

Tags

  • Settlement

19.2.3. Update merchant account external

PUT /settlement/api/manage/merchant/account/external/{acquirerId}
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

cmsAid
optional

string

Header

cmsUid
optional

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string

Path

acquirerId
required

string
Body parameter

Name : body
Flags : required
Type : MerchantAccountRequest

Responses
HTTP Code Description Schema

200

OK

MerchantAccountResponse
Consumes

  • application/vnd.banking.v1+json

Produces

  • application/vnd.banking.v1+json

Tags

  • Settlement

19.2.4. Add transaction

POST /settlement/api/originator/transaction
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : TransactionRequest

Responses
HTTP Code Description Schema

200

OK

TransactionResponse
Consumes

  • application/vnd.banking.v1+json

Produces

  • application/vnd.banking.v1+json

Tags

  • Settlement

19.2.5. Get status for transaction

POST /settlement/api/originator/transaction/status
Parameters
Type Name Description Schema

Header

Accept
required

The Accept request HTTP header advertises which content types, expressed as MIME types, the client is able to understand.

string

Header

Authorization
required

The Bearer Access Token needed to get authorized to use the API.

string

Header

x-api-key
required

The x-api-key header needed to get access to the API services.

string
Body parameter

Name : body
Flags : required
Type : TransactionStatusRequest

Responses
HTTP Code Description Schema

200

OK

TransactionStatusResponse
Consumes

  • application/vnd.banking.v1+json

Produces

  • application/vnd.banking.v1+json

Tags

  • Settlement

19.2.6. Get Application Status (Health check)

GET /settlement/health
Parameters
Type Name Schema

Query

bm
optional

boolean

Query

version
optional

boolean
Responses
HTTP Code Description Schema

200

OK

Status
Produces

  • application/json

  • application/vnd.banking.v1+json

Tags

  • Settlement

19.3. Definitions

Descriptions of the definitions/models used by the services/resources defined above.

19.3.1. AgreementContact

Contact person who shall sign agreement(s) if required

Name Description Schema

email
required

Email address to person receiving agreement link for digital signing contract.
Length : 1 - 100

string

firstName
optional

A persons first name.
Length : 1 - 50
Pattern : "^[\\p{Alnum}- .,;:'´/_()æøåÆØÅÅ&@#\\u00C0-\\u00FF]*"`

string

lastName
required

Name of a company or a person’s family/last name.
Length : 1 - 50
Pattern : "^[\\p{Alnum}- .,;:'´/_()æøåÆØÅÅ&@#\\u00C0-\\u00FF]*"`

string

phone
optional

The contacts phone number.
Length : 1 - 15
Pattern : "^[\\p{Digit}+]*"

string

19.3.2. MerchantAccount

Name Description Schema

accountNumber
optional

Settlement account number

string

acquirerId
required

The AcquirerId
Length : 2 - 50

string

checkForDuplicate
optional

Enforce transaction duplicate check

boolean

cmsMerchantId
required

The CMS Merchant Id
Length : 2 - 50

string

emailAddress
optional

E-mail address for settlement reports

string

entityStatus
optional

Merchant Account status

enum (INACTIVE, ACTIVE, BLOCKED, REVOKED, PENDING_DELETE)

gln
optional

The GLN (Global Location Number)
Length : 13

string

groupId
optional

CustomerGroup Id

string

inUse
optional

If true, the account has been used recently and cannot be deleted

boolean

karValidated
optional

If true, the account has been validated against Bank KAR

boolean

orgnr
optional

The organization number
Length : 1 - 45

string

products
optional

List of products for this acquirerId

< string > array

settlementOnAccount
optional

Do settlement based on account number

boolean

validFrom
optional

The date the Account is enabled for settlement if status is active

string (date)

19.3.3. MerchantAccountListResponse

Name Description Schema

merchantAccounts
optional

Available merchantAccounts

< MerchantAccount > array

responseInfo
optional

ResponseInfo

19.3.4. MerchantAccountRequest

Name Description Schema

accountNumber
required

Settlement account number
Length : 11
Pattern : "^[0-9]{11}"

string

agreementContact
optional

AgreementContact

checkForDuplicate
optional

Enforce transaction duplicate check. Default: false

boolean

cmsMerchantId
required

Unique ID of Merchant generated by Aera. The merchantId is used as key when updating merchant information
Length : 1 - 20
Pattern : "^[a-zA-Z0-9\\-]{0,20}"

string

dailyReport
optional

Send daily report. Default: true

boolean

emailAddress
optional

Email address for settlement reports
Length : 5 - 100

string

entityStatus
optional

Merchant status. Default: ACTIVE

enum (INACTIVE, ACTIVE, BLOCKED, REVOKED, PENDING_DELETE)

productTypes
required

Supported Product types, ex: AERA_KORT, AERA_KONTO

< string > array

validFrom
required

The date the Account is enabled for settlement if status is active

string (date)

19.3.5. MerchantAccountResponse

Name Schema

merchantAccount
optional

MerchantAccount

responseInfo
optional

ResponseInfo

19.3.6. ResponseInfo

Info object that can provide specific messages

Name Description Schema

externalResponseCode
optional

Additional response code from external systems.

string

message
optional

Specific response message

string

responseCode
required

Minimum length : 1

string

timeStamp
required

Timestamp. Mandatory
Minimum length : 1
Example : "2021-12-21T10:23:19.279Z"

string

19.3.7. Status

Name Schema

description
optional

string

status
optional

string

19.3.8. Transaction

List of single transactions.

Name Description Schema

acquirerCreateTime
optional

The time the transaction was created in acquirer. ISO8601 format.
Length : 1 - 50

string

creditorId
required

Id of merchant. Related to creditor type.
Length : 1 - 36

string

creditorType
required

The creditor type, used together with creditor id.

enum (acquirerId, gln, orgnr)

currencyCode
required

The currency code (ISO 4217 alpha-3).
Length : 3

string

customerRef
optional

CustomerRef
Length : 1 - 50

string

externalTransactionId
required

The external transaction id (1-40 characters). Used also in merchant reports.
Length : 1 - 40

string

grossAmount
required

The net amount.
Max 17 digits for the integer part and 2 digits for the fractional part.

number

interimAccountNumber
required

The Interim Account Number, if set it will be validated
Length : 1 - 20

string

message
optional

Message
Length : 1 - 200

string

paymentTransactionId
optional

The payment transaction id (1-50 characters). Required if product requires refund check.
Length : 1 - 40

string

productCategory
optional

ProductCategory, DEFAULT if not set.

enum (DEFAULT, CREDIT_ACCOUNT)

reconciliationId
optional

ReconciliationId
Length : 1 - 50

string

transactionTime
required

The time the transaction was executed. This time determines when this transaction will be part of settlement. ISO8601 format.
Length : 1 - 50

string

transactionType
required

The transaction type

enum (Payment, Refund, Reversal, Fee)

19.3.9. TransactionRequest

Name Description Schema

productId
required

The product id (1-40 characters).
Length : 1 - 40

string

transactions
required

List of single transactions.

< Transaction > array

19.3.10. TransactionResponse

Name Description Schema

aeraTransactionId
optional

Unique transaction ID

string

responseInfo
optional

ResponseInfo

19.3.11. TransactionStatusRequest

Name Description Schema

externalTransactionId
required

The external transaction ID (1-40 characters).
Together with orderNumber a unique reference set by the merchant.
Length : 1 - 40

string

transactionType
required

The transaction type

enum (Payment, Refund, Reversal, Fee)

19.3.12. TransactionStatusResponse

Name Description Schema

aeraTransactionId
optional

Unique transaction ID

string

responseInfo
optional

ResponseInfo

transaction
optional

Transaction

20. Responses

20.1. Response Codes

To better explain generic responses a custom response code is returned.

Response code series:

Code series Description

0-09999

Successful (relevant for normal 2xx responses)

10000-19999

Search successful (but expected result not found)

20000-29999

Bad formatting

30000-39999

Other Bad requests

40000-49999

Other Client Errors

50000-59999

Internal Errors

60000-69999

Service specific response codes

Response codes:

Response Code Description

0

Successful

1000

Request OK but payment not successful

1001

Authorization declined

1002

Refund declined

1003

Capture failed

1004

Request was declined by 3rd party

1005

Authorization pending

1006

Payment declined

1007

Maximum account balance reached

1008

Maximum daily spending limit reached

1009

Card expired

1010

Amount exceeds maximum amount for the scheme

1011

Card is blocked due to card scheme rules

1012

Insufficient funds

1013

Amount exceeds amount limit for transaction or activity period

1014

Frequency limit for the activity period has been exceeded

1015

The amount is below the minimum limit

1400

No capture exist for transaction

2000

Consumer has expired cards

10000

Identifier not found

10001

Loyalty not found

10002

Identity not found

10003

Invalid verification code

10004

No identity transactions found

10005

Accepted request, but Signature is not valid

10006

No payment instruments found

10007

Merchant configuration is incomplete

10100

The search or request was successful, but no results found

10110

The request containing list of elements is validated OK, but one or more elements are not accepted (see responseInfo per list element)

12020

Accepted but not ready to respond

20000

Bad format - mobile number

20001

Bad format - email

20002

Bad format - date

20003

Invalid JSON

20004

Invalid filter

20005

Bad format - validity duration

20006

Bad format - message text

20007

Invalid source value

20008

Invalid argument

20009

Bad format - account number

20010

Bad format - pay card

20011

Bad format - identifier Id

20012

Bad format - SSN

20013

Bad format - birth date

20014

Bad format - pid

29999

Other bad formatting

30000

Missing required field

30001

Missing required header

30002

Invalid header

30003

Unknown identifier type

30004

Bad request to Payment Gateway

30005

Net amount + tax amount <> gross amount

30006

Customer verification data not valid

30007

Wallet reference not found

30008

Customer has withdrawn consent

30009

Only one identifier with this IdentifierType is allowed. Can also occur if inconsistent data across concepts (e.g. same PID, but different SSN on two concepts).

30010

Requested capability not active for consumer

39999

Other bad request

40000

Resource not found

40001

Resource already exists

40002

Unsupported media type

40003

Method not allowed

40004

Unauthorized

40005

Precondition failed

40006

Forbidden

40007

Forbidden operation - Will lead to inconsistent data

40008

Forbidden operation - Missing write access

40009

Too early - too many requests

40010

Forbidden - Authenticated Subject is not the expected Subject

40800

Request timeout - Not able to complete request within a timeframe

49999

Other client error

50000

Internal error

50100

BankID error

50200

Payment Gateway Server Error

50300

Service Unavailable

50310

Service Unavailable - FREG

50400

Gateway Timeout - Identity not available

50420

Gateway Timeout - Payment Gateway not available

20.2. HTTP Error responses

Error messages are important because they tell end consumers when they are integrating with your API services in an incorrect way.

HTTP Code Description Schema

400

400 Bad Request: The request is malformed

CommonResponse

401

401 Unauthorized: You are not authorized to view the resource

CommonResponse

403

403 Forbidden: Accessing the resource you were trying to reach is forbidden

No Content

404

404 Not Found: The resource you were trying to reach is not found

CommonResponse

405

405 Method Not Allowed: The HTTP method is not allowed

No Content

409

409 Conflict: The resource you are trying to add already exists

CommonResponse

413

413 Request Entity Too Large: The request is too large

No Content

415

415 Unsupported Media Type: The media type of the request is not supported

No Content

429

429 Too Many Requests: You have sent too many request in a given amount of time

No Content

500

500 Internal Server Error: The server was unable to fulfill the request

CommonResponse

504

504 Gateway Timeout

No Content

20.2.1. Example HTTP Error response

HTTP/1.1 400 Bad Request
Content-Type: application/vnd.identities.v1+json;charset=UTF-8
Signature: s16w+6nnfpeGWO0zYCZmdF6ors3K/3QTPF6Fk1d/tEyqvvxZWc/o08em8PoQal5++wVcbEmG1i7pNzeINEdSiqChBQLxRj4F6srTfWW6jSnnYyXGSOro1hqFhVI8qIyvmimZpVr9g39ksjiqavcVMKP4Ge7h4ilzy3qbNfgqJHH00CwnootnENyT++uUKFHXUlc952lN8Dumj5cs1xeQIGd5qsBsyl/l5f6h8+C0bC2jXpKJjZUIrpfm4phJZ7QdVcxlVlst2ONsZejeaBzdbJ3EuPu+idtpfanGU60RqCIX41Hl1Ry44tcEhzce+fEGw8RoUBHLSOU/yUGvT5Dh0g==
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 182

{
  "responseInfo" : {
    "message" : "[Error in field: identity, message: must not be null]",
    "responseCode" : "30000",
    "timeStamp" : "2018-03-19T11:46:23:850Z"
  }
}

Service specific response code series:

Code series Description

60000-60099

Aera SecureID

61000-61099

AID Services

66000-66099

Aera Settlement Services

67000-67099

Aera Account Services (AKB)

Aera SecureID:

Response Code Description

60027

SDK version blocked (user must upgrade App)

60041

SDK does not have required capability

60043

SDK blocked

60044

SDK revoked

60045

App PIN incorrect (offline App PIN)

60046

App PIN incorrect, cool-down (offline App PIN)

60047

App PIN blocked, re-init SDK to set new App PIN (offline App PIN)

60061

App version blocked (user must upgrade App)

600xx

Other, contact support

21. Security

Aera takes security very seriously, and has a set of standards, policies and principles based on best practice to ensure your data is secure.

21.1. Infrastructure Security

Our infrastructure runs on data centers provided by Amazon Web Services (AWS), which have several security measures in place. We adhere to AWS best practices, which are continously monitored and improved. There are several layers of infrastructure security, and access is role-based using AWS Identity and Access Management (IAM).

21.2. Authentication and Authorization

The Aera Payment & Identification (API) Gateway has several security measures to Authenticate (AuthN) and Authorize (AuthZ) Access to services (API endpoints) and data.

The process of authorization is distinct from that of authentication. Whereas authentication is the process of verifying that “you are who you say you are,” authorization is the process of verifying that “you are permitted to do what you are trying to do.” This does not mean authorization presupposes authentication; an anonymous agent could be authorized to a limited action set.

— Wikipedia

21.2.1. API Key

All API endpoints/services require an API key set as x-api-key header.

An API key is a unique identifier that is passed to the API to identify the caller and to authorize the use of the API. API keys are used to track and control how the API is being used, for example to prevent malicious use or abuse of the API. The API Key acts as both a unique identifier/authenticator and as a secure token for authorization, and has a set of access rights associated with it.

21.2.2. Access token

Most API endpoints require an OAuth access token in the Authorization header.

The API Gateway currently supports OAuth 2.0. OAuth2.0 is a simple and secure authentication mechanism. It allows application to acquire an access token/Json Web Token (JWT) for the API. Once an application has an access token, it will be given permissions to access services/endpoints according to the access policy.

Access Policy contains a list of policy statements. A policy statement stipulates whether to allow or deny the execution of the specified API method(resource). Access policy is generated based on a service agreement with Aera Payment & Identification AS.

OAuth access token and API key MUST be treated as secret data and NOT exposed to unauthorized parties.

The authorization setup is similar to what AWS describes in its article Introducing custom authorizers in Amazon API Gateway. Image from AWS:

Authorizer Flow

21.3. Data Security

21.3.1. Data at Rest

All data is stored in managed databases which are regularly patched for security. Data is stored with at least dual redundancy with a minimum of 25 days of backups and is accessible only within the private cloud.

All data at rest are encrypted using strong encryption. Either by using client side encryption, encryption of storage or a combination.

21.3.2. Data in Transit

The use of TLS is mandatory, i.e. all requests MUST use the SSL endpoint. Aera Payment & Identification Gateway is enforcing TLS v1.2 on its end-points.

HTTP Data Integrity

In order to protect end-to-end data integrity, the HTTP response is signed and a digital signature is included at the JSON response object retrieved from the RESTful interface.

All RESTful responses have a Base64 encoded string in a response header named Signature. At retrieval of the HTTP Response the receiver should verify the integrity of the data. The signature has two purposes, prevent unintentional changes in information and unauthorized access (tampering) of data.
The current solution uses SHA-256 to create a hash digest of the full HTTP body. The digest is signed with our private key. We use RSA with a 2048 bits key. The signature is Base64 encoded. Use the pre-shared key to verify the signature.

The signature is only valid for the HTTP body and not the HTTP headers or URL.
Below is a simplified method that validates a signature
public boolean verifySignature(byte[] payload, byte[] signature, PublicKey publicKey) {
	Signature s = Signature.getInstance("SHA256withRSA");
	s.initVerify(publicKey);
	s.update(payload);

	return publicSignature.verify(signature);
}
Public Key of Staging Environment
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAv0Dmc
ZCsOF0Kvrg460utqCTM7EZcmr1p3aB+Mlqds5j7ID6epZQj/S
cfh5owlfPWcYaCpjY6OnF7SJHP5RqzQl9JI0YKcvFkDeu1nHA
6e5A7yhemHgjTS4iO0dHVfbcGlqELeragafNHZwKqqvu+ZYZt
vmOTseiLo//wRWlDUurBETAxjveLy1/BzUkFZRKPII8owU6U7
t3Jlrtwb6KontLm89SnUhXRe8HjXK1xN/2JA/q/YX4ketTWbV
0yi8jseGSfeNsDGApdXYsLoclYsbyOlVJXBVHOtqQoXNGd5dS
KTJ5dewsWXzeRmIWMvDFifzDsp+uWZQmF1/zsieJUrwIDAQAB
-----END PUBLIC KEY-----
Public Key of Production Environment
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1tAzW
Ba9pY5WUfLLVpiL53BirmW144OGzgYrOWt5hQjZQevE6fuN3g
DhGjtNVHGx8Fn+im5IOwDo+1USYGIM15xzzmuRmEQ8jd8154I
Zu/TIhfhx+WbsTMVb0U0TfSrD8GFBgGt6IZnDR8k/jt0wYqEV
aoeZPRzkeGFfbUQXH446ZyolH+ATke8AtaWq8VKoqHNWS5FeO
Ydg2EGGmi0er3Kn6+9/XvIkx4KhrvKr0FdBoXXvaLOY/ZCa7o
S7zZ6rblHYDV1xHGEhcy1T+tkmg3ACX206FnNnsdBx21SdhBz
jjGSsUmS9Jkc2mzwxTk8ElJHlD56vLXGmnmYGSefQTQIDAQAB
-----END PUBLIC KEY-----

21.3.3. Data in Process

Access to the services are granted using API key and in most cases a JWT access token which are being validated. The data access/filtering is based on the subject’s scopes and data authorization.

Strict data validation is implemented on the request objects (size, range, constraints, etc.) to ensure the quality and correctness, in addition to prevention of injection attacks etc.

Input Validation

All input will be validated to ensure data quality and to avoid abuse or certain attacks of the services.

URL validations
Invalid URL, Parameters and Query strings will result in the server rejecting with "400 Bad Request" or "403 Request refused /Forbidden". See HTTP Error responses for more details.

Incoming Content-Type validations
APIs will never assume Content-Type, any unexpected Content-Type header will result in the server rejecting the content with a "415 Unsupported Media Type"

Incoming Content validations
APIs will never allow free-form content, any unexpected content, for example: invalid data type, invalid input format, invalid size of request, etc. will result in the server rejecting the content with a "400 Bad Request".

Response Types validations
The client can not specify the preferred order of response types by the Accept header in the request. If the Accept header does not specifically contain the allowable type, the request may be rejected.

21.4. Request Headers

Name Description

x-api-key
required

An ApiKey must be set to be able to get access to the services on the API Gateway, e.g. ' x-api-key: {api_key}'.

Authorization
required

All services require an access token to be provided except request of access token, e.g. 'Authorization: Bearer {access_token}'.

Content-Type
required on most HTTP methods

API must send the Content-Type header with the correct Content-Type if there is a body/payload, e.g. 'Content-Type: application/vnd.identities.v1+json'.

Accept
required on most HTTP methods

The Accept header (media type) should be declared, e.g. 'Accept: application/vnd.identities.v1+json'.

21.5. Attack Prevention and Mitigation

Aera Payment & Identification Gateway maintain intelligent API protection, firewalls, DDoS mitigation [on layer 3 og 4], etc., which along with the automatic scaling capacity of resources are designed to mitigate attacks at both the Application and Network layer.

Aera logs activity across the platform, from individual API requests to infrastructure configuration changes. Logs are aggregated for monitoring, analysis, and anomaly detection.

Aera’s developers are trained with specific attention towards security. The applications/developed code are being analysed automatically by several security and best practice tools, and human peer review is being performed. This is to ensure the best possible quality and security of Aera’s Platform. In addition, the Platform are regularly being security audited.

21.6. Security Incidents

If you’ve found a vulnerability in Aera’s services, please send an email to security@aera.id. We will review it and respond as soon as possible.

22. Terms of use

Thank you for your interest in the Aera APIs

Copyright 2017 Aera AS

These Terms of Use (the “Terms”), dated as of October 25, 2017, are entered into by and between Aera Payment & Identification AS (“Aera”), and you. Your use or accessing of the API, or downloading of the API documentation, confirm your acceptance and acknowledgement of being legally bound by these Terms of Use. If you are acting on behalf of an entity that has entered into an agreement with Aera containing separate terms of use of Aera documentation (including this API documentation), applicable terms of use will be governed by such an agreement and not by these Terms of Use.

Aera and you hereby agree as follows:

22.1. Use of the API

Subject to the terms of these Terms of Use, you will utilise the API, and make sure all applications/usage will remain, in compliance with the terms and conditions set out in this API documentation.

22.1.1. Permitted Uses of the AP and Confidentiality.

You will only use or access the API and related documentation in accordance with the limited license granted to you according to sub-clause "Using the API" below. Your use of and access to the API shall be treated in strict confidence, and any information related thereto and which is not already publicly known shall be kept confidential and not be shared with anyone other than the entity on whose behalf you are acting, and only on a need-to-know basis to relevant personnel employed or hired by that entity.

22.1.2. Prohibited Uses of the API

You must never do any of the following:

•Distribute or allow access to the API to anyone other than the entity on whose behalf you are acting, or create an application programming interface that enables access to Aera Content.
•Implement features or business practices that unlawfully harm the professional reputation or relationships of Aera.
•Use Aera Content received from the API in any manner that facilitates bias, discrimination, or
data “redlining,” whether intentional or inadvertent, based on sensitive or protected categories or characteristics.
•Impersonate Aera or intentionally misrepresent Aera or other third party when requesting or publishing information.
•Copy, reformat, reverse-engineer, or otherwise modify the API, Access Credentials, or any Aera Content.
•By use of the API Promote or operate any product or service that competes with the Aera Services.
•Interfere with or disrupt Aera services, Aera servers or networks connected to Aera services.

22.2. API License

22.2.1. Using the API

As part of the terms and conditions set out in this API documentation ,Aera grants you a non-exclusive, non-transferable, and non-sublicensable (except as expressly permitted herein) license to use the API only in accordance with the instructions set out in terms and conditions set out in this API documentation and strictly for the purpose of performing such activities which are agreed between Aera and you or between Aera and the entity on whose behalf you are acting, as applicable.

22.2.2. Access Credentials

Aera will provide you with Access Credentials that permit you to access the API. The Access Credentials are the property of Aera and may be revoked if: you share them with any third party (other than as allowed in the terms and conditions set out in this API documentation )if they are compromised, if you violate the API Terms or any terms set out in this documentation ,or if Aera terminates the terms and conditions set out in this API documentation

22.2.3. API Call Limitations

The number of API calls you will be permitted to make during any given time period may be limited as decided by Aera from time to time.

22.3. Intellectual Property

22.3.1. Aera Materials

Aera owns all rights, title, and interest, including all intellectual property rights, in and to, the Aera
API; all elements, components, and executables of the Aera API (“Aera Materials”). Except for the licenses granted in
the terms and conditions set out in this API documentation ,Aera does not grant you any right, title, or interest in the Aera Materials.

22.3.2. Feedback

You may, but is not required to, provide suggestions, comments, ideas, or know-how, in any
form, to Aera related to Aera products, services or technology (“Feedback”). To the extent you
provide Feedback to Aera, you grant Aera the right to use such Feedback without any right to
compensation from Aera.