Home » NOVA TX Approval

Domain NOVA TX Approval

[Planned Breaking Changes] [Diagrams] [Artifacts] [Dependencies] [Provided REST Endpoints / Services] [Deprecations] [Maven Artifacts]


Diagrams

NOVA TX Approval Service Model NOVA TX Approval Events
- Transaction Approval Service Model
- Transaction Approval Service Model - OpenAPI
- Transaction Approval Service Model - Roles 		- Transaction Approval Events
- Transaction Approval Events - OpenAPI

Artifacts

Artifact Icon Maturity Level since
NOVA TX Approval Service Model 🐦 Early Bird 2.0.0
NOVA TX Approval Events 🐔 Crazy Chicken

Dependencies

Artifact Outgoing Dependencies Incoming Dependencies
NOVA TX Approval Service Model - NOVA Common Data Types
- NOVA Customer Data Types
- NOVA System Problem 		- NOVA Transaction Approval Events
NOVA TX Approval Events - NOVA Common Data Types
- NOVA Common Events
- NOVA Customer Data Types
- NOVA System Problem
- NOVA Transaction Approval Service Model

Provided REST Endpoints / Services

TransactionApprovalService

NOVA Transaction Approval Service provides a mechanism to approve any kind of transactions. Therefore the services requests an additional approval from a customer for a specific transaction.

As the transaction approval process also requires some special interactions with client UIs (similar to 3D Secure for Credit Cards) a transaction can only be approved after some additional information are provided by the client in a second call (initiateTransactionApproval(...)).


REST Path / Operation Description
/transaction-approval:createTransactionApproval [POST]

prepareTransactionApproval(PrepareTransactionApprovalRequest, NOVAContext) 		Operation prepares a transaction approval.
/transaction-approval/{transaction-id} [GET]

getTransactionApproval(String, NOVAContext) 		Method returns the transaction approval with the passed ID.
/transaction-approval/{transaction-id}:initiateTransactionApproval [POST]

initiateTransactionApproval(String, ClientFlowInfo, NOVAContext) 		Operation initiates the transaction approval. Depending on the approval mechanism in this step e.g. a SMS might be sent to a customer containing the approval code.
/transaction-approval/{transaction-id}:approveTransaction [POST]

approveTransaction(String, TransactionApprovalCode, NOVAContext) 		Operation approves the transaction with the passed ID.


Planned Breaking Changes

No breaking changes planned.

Deprecations

Package ch.voev.nova.txapproval.servicemodel

No deprecations published.


Package ch.voev.nova.txapproval.events

No deprecations published.


Maven Artifacts

The following table shows the Maven modules that might be used by integrators.

Module Type [1] NOVA TX Approval Service Model NOVA TX Approval Events
OpenAPI 
<dependency>
    <groupId>ch.voev.nova.txapproval.api</groupId>
    <artifactId>nova-txapproval-servicemodel-api-openapi</artifactId>
</dependency>
<dependency>
    <groupId>ch.voev.nova.txapproval.api</groupId>
    <artifactId>nova-txapproval-events-api-openapi</artifactId>
</dependency>
Java 
<dependency>
    <groupId>ch.voev.nova.txapproval.api</groupId>
    <artifactId>nova-txapproval-servicemodel-api-java</artifactId>
</dependency>
<dependency>
    <groupId>ch.voev.nova.txapproval.api</groupId>
    <artifactId>nova-txapproval-events-api-java</artifactId>
</dependency>
Java Runtime 
<dependency>
    <groupId>ch.voev.nova.txapproval.api</groupId>
    <artifactId>nova-txapproval-servicemodel-api-java-runtime</artifactId>
</dependency>
<dependency>
    <groupId>ch.voev.nova.txapproval.api</groupId>
    <artifactId>nova-txapproval-events-api-java-runtime</artifactId>
</dependency>
Services 
<dependency>
    <groupId>ch.voev.nova.txapproval.api</groupId>
    <artifactId>nova-txapproval-servicemodel-api-services</artifactId>
</dependency>
REST Client 
<dependency>
    <groupId>ch.voev.nova.txapproval.api</groupId>
    <artifactId>nova-txapproval-servicemodel-api-rest-client</artifactId>
</dependency>
REST Client Starter 
<dependency>
    <groupId>ch.voev.nova.txapproval.api</groupId>
    <artifactId>nova-txapproval-servicemodel-api-rest-client-starter</artifactId>
</dependency>
Jackson Starter 
<dependency>
    <groupId>ch.voev.nova.txapproval.api</groupId>
    <artifactId>nova-txapproval-events-api-starter</artifactId>
</dependency>

[1] For further details about the different module types please see: