Home > API > Customer Account > Add event

Add event

Add event to account

PATH:

/api/v3/customer-account/{accountNumber}/event

PATH PARAMETERS:

accountNumber
required

string

Account number

REQUEST BODY SCHEMA:

eventType
required

string

Enum: Info Purchase Withdrawal WithdrawalCorrection WithdrawalCommission InterestCorrection

Event type

categoryType

string

Enum: NotSet Charge Sales Deposit Payout Transfer Unit Consumer Cancel Clearing CardDeposit CardClearing

Category type

time
required

string

Date and time when event has appeared

nfcId

string

ID of NFC chip used in event

posId

string

ID of POS terminal used in event

posName

string

Name of POS terminal used in event

totalTax

number

Total tax for this event (sum of all taxes of linked items)

totalAmount

number

Total amount for this event (sum of all gross amounts of linked items)

items

array of items

Event items linked to this event

Array () [
itemId
required

string

Item ID

itemDescription
required

string

Item description

unitCode
required

string

Unit code

quantity
required

number

Quantity

unitPrice
required

number

Unit price (gross amount)

netAmount

number

Net amount of one item

taxAmount

number

Tax amount of one item

discount

number

Total discount

grossAmount

number

Total gross amount (unit price * quantity - discount)


]
currency
required

string

Enum: EUR NOK SEK DKK CHF

Transaction currency

accountTransactionId

string

Transaction ID

countryCode
required

string

Enum: NO SE FI DK DE AT CH NL BE

Country code

conversationLanguage
required

string

Enum: NO SV SE FI DA DK EN DE NL FR

Conversation language. 'SE' and 'DK' are obsolete values, and will be removed in the future. Use 'SV' instead of 'SE', and 'DA' instead of 'DK'.

RESPONSES:

200 OK

RESPONSE SCHEMA:

eventAdded

boolean

Indicates whether event was added or not

transactionId

string

outcome

string

Enum: Accepted Pending Rejected NotEvaluated

Outcome

riskCheckMessages

array of riskCheckMessages

Risk check messages

Array () [
type

string

Enum: BusinessError TechnicalError NotificationMessage

Message type

code

string <= 100 characters

Confirmation or error code

message

string <= 4096 characters

Message content

customerFacingMessage

string <= 4096 characters

Message to display to customer

actionCode

string

Enum: Unavailable AskConsumerToConfirm AskConsumerToReEnterData OfferSecurePaymentMethods RequiresSsn AskConsumerToIdentify

Possible next action to make

fieldReference

string <= 100 characters

Reference to field that caused an error


]
400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum: BusinessError TechnicalError NotificationMessage

Message type

code

string <= 100 characters

Confirmation or error code

message

string <= 4096 characters

Message content

customerFacingMessage

string <= 4096 characters

Message to display to customer

actionCode

string

Enum: Unavailable AskConsumerToConfirm AskConsumerToReEnterData OfferSecurePaymentMethods RequiresSsn AskConsumerToIdentify

Possible next action to make

fieldReference

string <= 100 characters

Reference to field that caused an error

]
401 Authorization has been denied for this request.
500 Internal server error.

Path

post

/api/v3/customer-account/{accountNumber}/event

Request samples

  • {
    • "eventType": "string",
    • "categoryType": "string",
    • "time": "string",
    • "nfcId": "string",
    • "posId": "string",
    • "posName": "string",
    • "totalTax": 1.00,
    • "totalAmount": 1.00,
    • "items": [ ...
      • {
        • "itemId": "string",
        • "itemDescription": "string",
        • "unitCode": "string",
        • "quantity": 1.00,
        • "unitPrice": 1.00,
        • "netAmount": 1.00,
        • "taxAmount": 1.00,
        • "discount": 1.00,
        • "grossAmount": 1.00
        }
      ],
    • "currency": "string",
    • "accountTransactionId": "string",
    • "countryCode": "string",
    • "conversationLanguage": "string"
  • }

Response samples

200400
  • {
    • "eventAdded": true,
    • "transactionId": "string",
    • "outcome": "string",
    • "riskCheckMessages": [ ...
      • {
        • "type": "string",
        • "code": "string",
        • "message": "string",
        • "customerFacingMessage": "string",
        • "actionCode": "string",
        • "fieldReference": "string"
        }
      ]
    }
  • [
      ...
      • {
        • "type": "string",
        • "code": "string",
        • "message": "string",
        • "customerFacingMessage": "string",
        • "actionCode": "string",
        • "fieldReference": "string"
        }
    ]