@enfuce/nextgen-sdk 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/authorisation-control/api.d.ts +771 -0
- package/dist/authorisation-control/api.js +240 -0
- package/dist/authorisation-control/base.d.ts +66 -0
- package/dist/authorisation-control/base.js +65 -0
- package/dist/authorisation-control/common.d.ts +65 -0
- package/dist/authorisation-control/common.js +161 -0
- package/dist/authorisation-control/configuration.d.ts +91 -0
- package/dist/authorisation-control/configuration.js +44 -0
- package/dist/authorisation-control/index.d.ts +13 -0
- package/dist/authorisation-control/index.js +31 -0
- package/dist/card/api.d.ts +2065 -0
- package/dist/card/api.js +1406 -0
- package/dist/card/base.d.ts +66 -0
- package/dist/card/base.js +65 -0
- package/dist/card/common.d.ts +65 -0
- package/dist/card/common.js +161 -0
- package/dist/card/configuration.d.ts +91 -0
- package/dist/card/configuration.js +44 -0
- package/dist/card/index.d.ts +13 -0
- package/dist/card/index.js +31 -0
- package/dist/cardholder/api.d.ts +1890 -0
- package/dist/cardholder/api.js +1239 -0
- package/dist/cardholder/base.d.ts +66 -0
- package/dist/cardholder/base.js +65 -0
- package/dist/cardholder/common.d.ts +65 -0
- package/dist/cardholder/common.js +161 -0
- package/dist/cardholder/configuration.d.ts +91 -0
- package/dist/cardholder/configuration.js +44 -0
- package/dist/cardholder/index.d.ts +13 -0
- package/dist/cardholder/index.js +31 -0
- package/dist/cards/api.d.ts +78 -0
- package/dist/cards/api.js +142 -0
- package/dist/cards/base.d.ts +66 -0
- package/dist/cards/base.js +65 -0
- package/dist/cards/common.d.ts +65 -0
- package/dist/cards/common.js +161 -0
- package/dist/cards/configuration.d.ts +91 -0
- package/dist/cards/configuration.js +44 -0
- package/dist/cards/index.d.ts +13 -0
- package/dist/cards/index.js +31 -0
- package/dist/clearing-file-copy/api.d.ts +1245 -0
- package/dist/clearing-file-copy/api.js +139 -0
- package/dist/clearing-file-copy/base.d.ts +66 -0
- package/dist/clearing-file-copy/base.js +65 -0
- package/dist/clearing-file-copy/common.d.ts +65 -0
- package/dist/clearing-file-copy/common.js +161 -0
- package/dist/clearing-file-copy/configuration.d.ts +91 -0
- package/dist/clearing-file-copy/configuration.js +44 -0
- package/dist/clearing-file-copy/index.d.ts +13 -0
- package/dist/clearing-file-copy/index.js +31 -0
- package/dist/esm/authorisation-control/api.d.ts +771 -0
- package/dist/esm/authorisation-control/api.js +233 -0
- package/dist/esm/authorisation-control/base.d.ts +66 -0
- package/dist/esm/authorisation-control/base.js +60 -0
- package/dist/esm/authorisation-control/common.d.ts +65 -0
- package/dist/esm/authorisation-control/common.js +149 -0
- package/dist/esm/authorisation-control/configuration.d.ts +91 -0
- package/dist/esm/authorisation-control/configuration.js +40 -0
- package/dist/esm/authorisation-control/index.d.ts +13 -0
- package/dist/esm/authorisation-control/index.js +15 -0
- package/dist/esm/card/api.d.ts +2065 -0
- package/dist/esm/card/api.js +1379 -0
- package/dist/esm/card/base.d.ts +66 -0
- package/dist/esm/card/base.js +60 -0
- package/dist/esm/card/common.d.ts +65 -0
- package/dist/esm/card/common.js +149 -0
- package/dist/esm/card/configuration.d.ts +91 -0
- package/dist/esm/card/configuration.js +40 -0
- package/dist/esm/card/index.d.ts +13 -0
- package/dist/esm/card/index.js +15 -0
- package/dist/esm/cardholder/api.d.ts +1890 -0
- package/dist/esm/cardholder/api.js +1220 -0
- package/dist/esm/cardholder/base.d.ts +66 -0
- package/dist/esm/cardholder/base.js +60 -0
- package/dist/esm/cardholder/common.d.ts +65 -0
- package/dist/esm/cardholder/common.js +149 -0
- package/dist/esm/cardholder/configuration.d.ts +91 -0
- package/dist/esm/cardholder/configuration.js +40 -0
- package/dist/esm/cardholder/index.d.ts +13 -0
- package/dist/esm/cardholder/index.js +15 -0
- package/dist/esm/cards/api.d.ts +78 -0
- package/dist/esm/cards/api.js +135 -0
- package/dist/esm/cards/base.d.ts +66 -0
- package/dist/esm/cards/base.js +60 -0
- package/dist/esm/cards/common.d.ts +65 -0
- package/dist/esm/cards/common.js +149 -0
- package/dist/esm/cards/configuration.d.ts +91 -0
- package/dist/esm/cards/configuration.js +40 -0
- package/dist/esm/cards/index.d.ts +13 -0
- package/dist/esm/cards/index.js +15 -0
- package/dist/esm/clearing-file-copy/api.d.ts +1245 -0
- package/dist/esm/clearing-file-copy/api.js +136 -0
- package/dist/esm/clearing-file-copy/base.d.ts +66 -0
- package/dist/esm/clearing-file-copy/base.js +60 -0
- package/dist/esm/clearing-file-copy/common.d.ts +65 -0
- package/dist/esm/clearing-file-copy/common.js +149 -0
- package/dist/esm/clearing-file-copy/configuration.d.ts +91 -0
- package/dist/esm/clearing-file-copy/configuration.js +40 -0
- package/dist/esm/clearing-file-copy/index.d.ts +13 -0
- package/dist/esm/clearing-file-copy/index.js +15 -0
- package/dist/esm/index.d.ts +12 -0
- package/dist/esm/index.js +14 -0
- package/dist/esm/issuer-events/api.d.ts +1721 -0
- package/dist/esm/issuer-events/api.js +940 -0
- package/dist/esm/issuer-events/base.d.ts +66 -0
- package/dist/esm/issuer-events/base.js +60 -0
- package/dist/esm/issuer-events/common.d.ts +65 -0
- package/dist/esm/issuer-events/common.js +149 -0
- package/dist/esm/issuer-events/configuration.d.ts +91 -0
- package/dist/esm/issuer-events/configuration.js +40 -0
- package/dist/esm/issuer-events/index.d.ts +13 -0
- package/dist/esm/issuer-events/index.js +15 -0
- package/dist/esm/oauth/axios.d.ts +14 -0
- package/dist/esm/oauth/axios.js +58 -0
- package/dist/esm/oauth/clientCredentials.d.ts +24 -0
- package/dist/esm/oauth/clientCredentials.js +59 -0
- package/dist/esm/oauth/index.d.ts +3 -0
- package/dist/esm/oauth/index.js +24 -0
- package/dist/esm/oauth/tokenManager.d.ts +38 -0
- package/dist/esm/oauth/tokenManager.js +77 -0
- package/dist/esm/pin/api.d.ts +329 -0
- package/dist/esm/pin/api.js +341 -0
- package/dist/esm/pin/base.d.ts +66 -0
- package/dist/esm/pin/base.js +60 -0
- package/dist/esm/pin/common.d.ts +65 -0
- package/dist/esm/pin/common.js +149 -0
- package/dist/esm/pin/configuration.d.ts +91 -0
- package/dist/esm/pin/configuration.js +40 -0
- package/dist/esm/pin/index.d.ts +13 -0
- package/dist/esm/pin/index.js +15 -0
- package/dist/esm/threeds/api.d.ts +104 -0
- package/dist/esm/threeds/api.js +136 -0
- package/dist/esm/threeds/base.d.ts +66 -0
- package/dist/esm/threeds/base.js +60 -0
- package/dist/esm/threeds/common.d.ts +65 -0
- package/dist/esm/threeds/common.js +149 -0
- package/dist/esm/threeds/configuration.d.ts +91 -0
- package/dist/esm/threeds/configuration.js +40 -0
- package/dist/esm/threeds/index.d.ts +13 -0
- package/dist/esm/threeds/index.js +15 -0
- package/dist/esm/threeds-oob/api.d.ts +241 -0
- package/dist/esm/threeds-oob/api.js +141 -0
- package/dist/esm/threeds-oob/base.d.ts +66 -0
- package/dist/esm/threeds-oob/base.js +60 -0
- package/dist/esm/threeds-oob/common.d.ts +65 -0
- package/dist/esm/threeds-oob/common.js +149 -0
- package/dist/esm/threeds-oob/configuration.d.ts +91 -0
- package/dist/esm/threeds-oob/configuration.js +40 -0
- package/dist/esm/threeds-oob/index.d.ts +13 -0
- package/dist/esm/threeds-oob/index.js +15 -0
- package/dist/esm/transaction-event/api.d.ts +1082 -0
- package/dist/esm/transaction-event/api.js +163 -0
- package/dist/esm/transaction-event/base.d.ts +66 -0
- package/dist/esm/transaction-event/base.js +60 -0
- package/dist/esm/transaction-event/common.d.ts +65 -0
- package/dist/esm/transaction-event/common.js +149 -0
- package/dist/esm/transaction-event/configuration.d.ts +91 -0
- package/dist/esm/transaction-event/configuration.js +40 -0
- package/dist/esm/transaction-event/index.d.ts +13 -0
- package/dist/esm/transaction-event/index.js +15 -0
- package/dist/esm/wallet/api.d.ts +1385 -0
- package/dist/esm/wallet/api.js +1342 -0
- package/dist/esm/wallet/base.d.ts +66 -0
- package/dist/esm/wallet/base.js +60 -0
- package/dist/esm/wallet/common.d.ts +65 -0
- package/dist/esm/wallet/common.js +149 -0
- package/dist/esm/wallet/configuration.d.ts +91 -0
- package/dist/esm/wallet/configuration.js +40 -0
- package/dist/esm/wallet/index.d.ts +13 -0
- package/dist/esm/wallet/index.js +15 -0
- package/dist/index.d.ts +12 -0
- package/dist/index.js +17 -0
- package/dist/issuer-events/api.d.ts +1721 -0
- package/dist/issuer-events/api.js +947 -0
- package/dist/issuer-events/base.d.ts +66 -0
- package/dist/issuer-events/base.js +65 -0
- package/dist/issuer-events/common.d.ts +65 -0
- package/dist/issuer-events/common.js +161 -0
- package/dist/issuer-events/configuration.d.ts +91 -0
- package/dist/issuer-events/configuration.js +44 -0
- package/dist/issuer-events/index.d.ts +13 -0
- package/dist/issuer-events/index.js +31 -0
- package/dist/oauth/axios.d.ts +14 -0
- package/dist/oauth/axios.js +61 -0
- package/dist/oauth/clientCredentials.d.ts +24 -0
- package/dist/oauth/clientCredentials.js +63 -0
- package/dist/oauth/index.d.ts +3 -0
- package/dist/oauth/index.js +31 -0
- package/dist/oauth/tokenManager.d.ts +38 -0
- package/dist/oauth/tokenManager.js +81 -0
- package/dist/pin/api.d.ts +329 -0
- package/dist/pin/api.js +352 -0
- package/dist/pin/base.d.ts +66 -0
- package/dist/pin/base.js +65 -0
- package/dist/pin/common.d.ts +65 -0
- package/dist/pin/common.js +161 -0
- package/dist/pin/configuration.d.ts +91 -0
- package/dist/pin/configuration.js +44 -0
- package/dist/pin/index.d.ts +13 -0
- package/dist/pin/index.js +31 -0
- package/dist/threeds/api.d.ts +104 -0
- package/dist/threeds/api.js +143 -0
- package/dist/threeds/base.d.ts +66 -0
- package/dist/threeds/base.js +65 -0
- package/dist/threeds/common.d.ts +65 -0
- package/dist/threeds/common.js +161 -0
- package/dist/threeds/configuration.d.ts +91 -0
- package/dist/threeds/configuration.js +44 -0
- package/dist/threeds/index.d.ts +13 -0
- package/dist/threeds/index.js +31 -0
- package/dist/threeds-oob/api.d.ts +241 -0
- package/dist/threeds-oob/api.js +148 -0
- package/dist/threeds-oob/base.d.ts +66 -0
- package/dist/threeds-oob/base.js +65 -0
- package/dist/threeds-oob/common.d.ts +65 -0
- package/dist/threeds-oob/common.js +161 -0
- package/dist/threeds-oob/configuration.d.ts +91 -0
- package/dist/threeds-oob/configuration.js +44 -0
- package/dist/threeds-oob/index.d.ts +13 -0
- package/dist/threeds-oob/index.js +31 -0
- package/dist/transaction-event/api.d.ts +1082 -0
- package/dist/transaction-event/api.js +166 -0
- package/dist/transaction-event/base.d.ts +66 -0
- package/dist/transaction-event/base.js +65 -0
- package/dist/transaction-event/common.d.ts +65 -0
- package/dist/transaction-event/common.js +161 -0
- package/dist/transaction-event/configuration.d.ts +91 -0
- package/dist/transaction-event/configuration.js +44 -0
- package/dist/transaction-event/index.d.ts +13 -0
- package/dist/transaction-event/index.js +31 -0
- package/dist/wallet/api.d.ts +1385 -0
- package/dist/wallet/api.js +1377 -0
- package/dist/wallet/base.d.ts +66 -0
- package/dist/wallet/base.js +65 -0
- package/dist/wallet/common.d.ts +65 -0
- package/dist/wallet/common.js +161 -0
- package/dist/wallet/configuration.d.ts +91 -0
- package/dist/wallet/configuration.js +44 -0
- package/dist/wallet/index.d.ts +13 -0
- package/dist/wallet/index.js +31 -0
- package/package.json +25 -0
- package/src/authorisation-control/api.ts +876 -0
- package/src/authorisation-control/base.ts +86 -0
- package/src/authorisation-control/common.ts +150 -0
- package/src/authorisation-control/configuration.ts +115 -0
- package/src/authorisation-control/index.ts +18 -0
- package/src/card/api.ts +2792 -0
- package/src/card/base.ts +86 -0
- package/src/card/common.ts +150 -0
- package/src/card/configuration.ts +115 -0
- package/src/card/index.ts +18 -0
- package/src/cardholder/api.ts +2244 -0
- package/src/cardholder/base.ts +86 -0
- package/src/cardholder/common.ts +150 -0
- package/src/cardholder/configuration.ts +115 -0
- package/src/cardholder/index.ts +18 -0
- package/src/cards/api.ts +141 -0
- package/src/cards/base.ts +86 -0
- package/src/cards/common.ts +150 -0
- package/src/cards/configuration.ts +115 -0
- package/src/cards/index.ts +18 -0
- package/src/clearing-file-copy/api.ts +1309 -0
- package/src/clearing-file-copy/base.ts +86 -0
- package/src/clearing-file-copy/common.ts +150 -0
- package/src/clearing-file-copy/configuration.ts +115 -0
- package/src/clearing-file-copy/index.ts +18 -0
- package/src/index.ts +16 -0
- package/src/issuer-events/api.ts +1926 -0
- package/src/issuer-events/base.ts +86 -0
- package/src/issuer-events/common.ts +150 -0
- package/src/issuer-events/configuration.ts +115 -0
- package/src/issuer-events/index.ts +18 -0
- package/src/oauth/axios.ts +60 -0
- package/src/oauth/clientCredentials.ts +72 -0
- package/src/oauth/index.ts +24 -0
- package/src/oauth/tokenManager.ts +85 -0
- package/src/pin/api.ts +507 -0
- package/src/pin/base.ts +86 -0
- package/src/pin/common.ts +150 -0
- package/src/pin/configuration.ts +115 -0
- package/src/pin/index.ts +18 -0
- package/src/threeds/api.ts +173 -0
- package/src/threeds/base.ts +86 -0
- package/src/threeds/common.ts +150 -0
- package/src/threeds/configuration.ts +115 -0
- package/src/threeds/index.ts +18 -0
- package/src/threeds-oob/api.ts +311 -0
- package/src/threeds-oob/base.ts +86 -0
- package/src/threeds-oob/common.ts +150 -0
- package/src/threeds-oob/configuration.ts +115 -0
- package/src/threeds-oob/index.ts +18 -0
- package/src/transaction-event/api.ts +1152 -0
- package/src/transaction-event/base.ts +86 -0
- package/src/transaction-event/common.ts +150 -0
- package/src/transaction-event/configuration.ts +115 -0
- package/src/transaction-event/index.ts +18 -0
- package/src/wallet/api.ts +2083 -0
- package/src/wallet/base.ts +86 -0
- package/src/wallet/common.ts +150 -0
- package/src/wallet/configuration.ts +115 -0
- package/src/wallet/index.ts +18 -0
- package/test/authorisation-control.test.ts +71 -0
- package/test/card.test.ts +39 -0
- package/test/cardholder.test.ts +51 -0
- package/test/cards.test.ts +35 -0
- package/test/issuer-events.test.ts +55 -0
- package/test/oauth.test.ts +205 -0
- package/test/pin.test.ts +39 -0
- package/test/threeds-oob.test.ts +90 -0
- package/test/threeds.test.ts +55 -0
- package/test/wallet.test.ts +62 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +14 -0
|
@@ -0,0 +1,241 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 3DS OOB Outgoing Webhook API
|
|
3
|
+
* The 3DS Authentication API supports OOB (out of band) authentication during 3DS payment processing, where the client\'s own cardholder authentication service is used. All endpoints use HTTP response codes; requests and responses are UTF-8 encoded in JSON format. A client must be able to handle new elements added to either the request or response without breaking. **Timeout**: The 3rd party authentication system has 150 seconds (default, configurable during 3DS setup) to send a callback with the authentication challenge result. After this, Enfuce responds with a timeout to ACS and end user authentication fails. **CustomerNumber** in this context is equal to `cardholder.customerNumber` in other parts of the Enfuce API. ## 3DS OOB Authentication flow ``` Payment Network Enfuce 3DS API Client System | | | |-- 3ds auth request -->| | (1) | |-- POST /v1/3ds/oob/challenge/initiate ->| (2) | |<-------------- HTTP 200 OK --------------| (3) | | | | | authenticate cardholder | | | | |<-- POST /v1/3ds/challenge/oob/result ---| (4) |<- 3ds auth response --| | (5) ``` 1. Enfuce receives a 3DS authentication request from the payment network including merchant information. 2. Enfuce calls the client system, requesting a cardholder authentication. - The request contains both `authenticationId` and `challengeId` (UUIDs) that the client system uses when sending the challenge result back. - It also contains the customerNumber and other contextual info. 3. The client system must return an HTTP 200 OK response within 2 seconds. 4. Once the client system has a result from the cardholder authentication, it calls the \"Submit authentication challenge result\" endpoint, which needs to happen within 150 seconds from the start. 5. Enfuce responds to the payment network, and the authorization process can proceed.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import type { RequestArgs } from './base';
|
|
15
|
+
import { BaseAPI } from './base';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface InitiateAuthenticationChallengeBody
|
|
20
|
+
*/
|
|
21
|
+
export interface InitiateAuthenticationChallengeBody {
|
|
22
|
+
/**
|
|
23
|
+
* Unique identifier of the authentication request.
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof InitiateAuthenticationChallengeBody
|
|
26
|
+
*/
|
|
27
|
+
'authenticationId': string;
|
|
28
|
+
/**
|
|
29
|
+
* Unique challenge identifier of this authentication step.
|
|
30
|
+
* @type {any}
|
|
31
|
+
* @memberof InitiateAuthenticationChallengeBody
|
|
32
|
+
*/
|
|
33
|
+
'challengeId': any;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {InitiateAuthenticationChallengeBodyCardholder}
|
|
37
|
+
* @memberof InitiateAuthenticationChallengeBody
|
|
38
|
+
*/
|
|
39
|
+
'cardholder': InitiateAuthenticationChallengeBodyCardholder;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {InitiateAuthenticationChallengeBodyCard}
|
|
43
|
+
* @memberof InitiateAuthenticationChallengeBody
|
|
44
|
+
*/
|
|
45
|
+
'card': InitiateAuthenticationChallengeBodyCard;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {ThreeDsTransaction}
|
|
49
|
+
* @memberof InitiateAuthenticationChallengeBody
|
|
50
|
+
*/
|
|
51
|
+
'threeDsTransaction'?: ThreeDsTransaction;
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
* @type {Merchant}
|
|
55
|
+
* @memberof InitiateAuthenticationChallengeBody
|
|
56
|
+
*/
|
|
57
|
+
'merchant'?: Merchant;
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
* @export
|
|
62
|
+
* @interface InitiateAuthenticationChallengeBodyCard
|
|
63
|
+
*/
|
|
64
|
+
export interface InitiateAuthenticationChallengeBodyCard {
|
|
65
|
+
/**
|
|
66
|
+
* Unique identification number of the card.
|
|
67
|
+
* @type {string}
|
|
68
|
+
* @memberof InitiateAuthenticationChallengeBodyCard
|
|
69
|
+
*/
|
|
70
|
+
'id': string;
|
|
71
|
+
/**
|
|
72
|
+
* Truncated card number.
|
|
73
|
+
* @type {string}
|
|
74
|
+
* @memberof InitiateAuthenticationChallengeBodyCard
|
|
75
|
+
*/
|
|
76
|
+
'maskedPan': string;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
*
|
|
80
|
+
* @export
|
|
81
|
+
* @interface InitiateAuthenticationChallengeBodyCardholder
|
|
82
|
+
*/
|
|
83
|
+
export interface InitiateAuthenticationChallengeBodyCardholder {
|
|
84
|
+
/**
|
|
85
|
+
* Unique identification number of the cardholder.
|
|
86
|
+
* @type {string}
|
|
87
|
+
* @memberof InitiateAuthenticationChallengeBodyCardholder
|
|
88
|
+
*/
|
|
89
|
+
'id': string;
|
|
90
|
+
/**
|
|
91
|
+
* Unique identifier of the cardholder in other parts of the Enfuce API.
|
|
92
|
+
* @type {string}
|
|
93
|
+
* @memberof InitiateAuthenticationChallengeBodyCardholder
|
|
94
|
+
*/
|
|
95
|
+
'customerNumber': string;
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
*
|
|
99
|
+
* @export
|
|
100
|
+
* @interface Merchant
|
|
101
|
+
*/
|
|
102
|
+
export interface Merchant {
|
|
103
|
+
/**
|
|
104
|
+
* Merchant name
|
|
105
|
+
* @type {string}
|
|
106
|
+
* @memberof Merchant
|
|
107
|
+
*/
|
|
108
|
+
'name'?: string;
|
|
109
|
+
/**
|
|
110
|
+
* The country where the transaction or withdrawal has occurred, or where the merchant is registered.
|
|
111
|
+
* @type {string}
|
|
112
|
+
* @memberof Merchant
|
|
113
|
+
*/
|
|
114
|
+
'country'?: string;
|
|
115
|
+
/**
|
|
116
|
+
* Merchant URL
|
|
117
|
+
* @type {string}
|
|
118
|
+
* @memberof Merchant
|
|
119
|
+
*/
|
|
120
|
+
'url'?: string;
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* Amount including currency
|
|
124
|
+
* @export
|
|
125
|
+
* @interface Money
|
|
126
|
+
*/
|
|
127
|
+
export interface Money {
|
|
128
|
+
/**
|
|
129
|
+
*
|
|
130
|
+
* @type {number}
|
|
131
|
+
* @memberof Money
|
|
132
|
+
*/
|
|
133
|
+
'amount': number;
|
|
134
|
+
/**
|
|
135
|
+
* A valid ISO 4217 currency code
|
|
136
|
+
* @type {string}
|
|
137
|
+
* @memberof Money
|
|
138
|
+
*/
|
|
139
|
+
'currency': string;
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
*
|
|
143
|
+
* @export
|
|
144
|
+
* @interface ThreeDsTransaction
|
|
145
|
+
*/
|
|
146
|
+
export interface ThreeDsTransaction {
|
|
147
|
+
/**
|
|
148
|
+
*
|
|
149
|
+
* @type {Money}
|
|
150
|
+
* @memberof ThreeDsTransaction
|
|
151
|
+
*/
|
|
152
|
+
'transactionAmount'?: Money;
|
|
153
|
+
/**
|
|
154
|
+
* Transaction category: - `PAYMENT` — Payment authentication - `NON_PAYMENT` — Non-payment authentication
|
|
155
|
+
* @type {string}
|
|
156
|
+
* @memberof ThreeDsTransaction
|
|
157
|
+
*/
|
|
158
|
+
'category'?: ThreeDsTransactionCategoryEnum;
|
|
159
|
+
/**
|
|
160
|
+
* Channel where the transaction is initiated: - `APP` — App-based - `BROWSER` — Browser-based - `REQUESTOR_INITIATED` — 3DS Requestor Initiated
|
|
161
|
+
* @type {string}
|
|
162
|
+
* @memberof ThreeDsTransaction
|
|
163
|
+
*/
|
|
164
|
+
'deviceChannel': ThreeDsTransactionDeviceChannelEnum;
|
|
165
|
+
/**
|
|
166
|
+
* Time when the transaction is processed by Enfuce.
|
|
167
|
+
* @type {string}
|
|
168
|
+
* @memberof ThreeDsTransaction
|
|
169
|
+
*/
|
|
170
|
+
'processedDateTime': string;
|
|
171
|
+
}
|
|
172
|
+
export declare const ThreeDsTransactionCategoryEnum: {
|
|
173
|
+
readonly Payment: "PAYMENT";
|
|
174
|
+
readonly NonPayment: "NON_PAYMENT";
|
|
175
|
+
};
|
|
176
|
+
export type ThreeDsTransactionCategoryEnum = typeof ThreeDsTransactionCategoryEnum[keyof typeof ThreeDsTransactionCategoryEnum];
|
|
177
|
+
export declare const ThreeDsTransactionDeviceChannelEnum: {
|
|
178
|
+
readonly App: "APP";
|
|
179
|
+
readonly Browser: "BROWSER";
|
|
180
|
+
readonly RequestorInitiated: "REQUESTOR_INITIATED";
|
|
181
|
+
};
|
|
182
|
+
export type ThreeDsTransactionDeviceChannelEnum = typeof ThreeDsTransactionDeviceChannelEnum[keyof typeof ThreeDsTransactionDeviceChannelEnum];
|
|
183
|
+
/**
|
|
184
|
+
* OOBAuthenticationChallengeWebhookNotificationApi - axios parameter creator
|
|
185
|
+
* @export
|
|
186
|
+
*/
|
|
187
|
+
export declare const OOBAuthenticationChallengeWebhookNotificationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
188
|
+
/**
|
|
189
|
+
* In Out-of-Band (OOB) authentication flow, Enfuce sends an authentication challenge webhook notification to the issuer\'s registered endpoint for cardholder\'s approval.
|
|
190
|
+
* @summary Initiate OOB Authentication Challenge
|
|
191
|
+
* @param {InitiateAuthenticationChallengeBody} initiateAuthenticationChallengeBody
|
|
192
|
+
* @param {*} [options] Override http request option.
|
|
193
|
+
* @throws {RequiredError}
|
|
194
|
+
*/
|
|
195
|
+
initiateAuthenticationChallenge: (initiateAuthenticationChallengeBody: InitiateAuthenticationChallengeBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
196
|
+
};
|
|
197
|
+
/**
|
|
198
|
+
* OOBAuthenticationChallengeWebhookNotificationApi - functional programming interface
|
|
199
|
+
* @export
|
|
200
|
+
*/
|
|
201
|
+
export declare const OOBAuthenticationChallengeWebhookNotificationApiFp: (configuration?: Configuration) => {
|
|
202
|
+
/**
|
|
203
|
+
* In Out-of-Band (OOB) authentication flow, Enfuce sends an authentication challenge webhook notification to the issuer\'s registered endpoint for cardholder\'s approval.
|
|
204
|
+
* @summary Initiate OOB Authentication Challenge
|
|
205
|
+
* @param {InitiateAuthenticationChallengeBody} initiateAuthenticationChallengeBody
|
|
206
|
+
* @param {*} [options] Override http request option.
|
|
207
|
+
* @throws {RequiredError}
|
|
208
|
+
*/
|
|
209
|
+
initiateAuthenticationChallenge(initiateAuthenticationChallengeBody: InitiateAuthenticationChallengeBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
210
|
+
};
|
|
211
|
+
/**
|
|
212
|
+
* OOBAuthenticationChallengeWebhookNotificationApi - factory interface
|
|
213
|
+
* @export
|
|
214
|
+
*/
|
|
215
|
+
export declare const OOBAuthenticationChallengeWebhookNotificationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
216
|
+
/**
|
|
217
|
+
* In Out-of-Band (OOB) authentication flow, Enfuce sends an authentication challenge webhook notification to the issuer\'s registered endpoint for cardholder\'s approval.
|
|
218
|
+
* @summary Initiate OOB Authentication Challenge
|
|
219
|
+
* @param {InitiateAuthenticationChallengeBody} initiateAuthenticationChallengeBody
|
|
220
|
+
* @param {*} [options] Override http request option.
|
|
221
|
+
* @throws {RequiredError}
|
|
222
|
+
*/
|
|
223
|
+
initiateAuthenticationChallenge(initiateAuthenticationChallengeBody: InitiateAuthenticationChallengeBody, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
224
|
+
};
|
|
225
|
+
/**
|
|
226
|
+
* OOBAuthenticationChallengeWebhookNotificationApi - object-oriented interface
|
|
227
|
+
* @export
|
|
228
|
+
* @class OOBAuthenticationChallengeWebhookNotificationApi
|
|
229
|
+
* @extends {BaseAPI}
|
|
230
|
+
*/
|
|
231
|
+
export declare class OOBAuthenticationChallengeWebhookNotificationApi extends BaseAPI {
|
|
232
|
+
/**
|
|
233
|
+
* In Out-of-Band (OOB) authentication flow, Enfuce sends an authentication challenge webhook notification to the issuer\'s registered endpoint for cardholder\'s approval.
|
|
234
|
+
* @summary Initiate OOB Authentication Challenge
|
|
235
|
+
* @param {InitiateAuthenticationChallengeBody} initiateAuthenticationChallengeBody
|
|
236
|
+
* @param {*} [options] Override http request option.
|
|
237
|
+
* @throws {RequiredError}
|
|
238
|
+
* @memberof OOBAuthenticationChallengeWebhookNotificationApi
|
|
239
|
+
*/
|
|
240
|
+
initiateAuthenticationChallenge(initiateAuthenticationChallengeBody: InitiateAuthenticationChallengeBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
241
|
+
}
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* 3DS OOB Outgoing Webhook API
|
|
6
|
+
* The 3DS Authentication API supports OOB (out of band) authentication during 3DS payment processing, where the client\'s own cardholder authentication service is used. All endpoints use HTTP response codes; requests and responses are UTF-8 encoded in JSON format. A client must be able to handle new elements added to either the request or response without breaking. **Timeout**: The 3rd party authentication system has 150 seconds (default, configurable during 3DS setup) to send a callback with the authentication challenge result. After this, Enfuce responds with a timeout to ACS and end user authentication fails. **CustomerNumber** in this context is equal to `cardholder.customerNumber` in other parts of the Enfuce API. ## 3DS OOB Authentication flow ``` Payment Network Enfuce 3DS API Client System | | | |-- 3ds auth request -->| | (1) | |-- POST /v1/3ds/oob/challenge/initiate ->| (2) | |<-------------- HTTP 200 OK --------------| (3) | | | | | authenticate cardholder | | | | |<-- POST /v1/3ds/challenge/oob/result ---| (4) |<- 3ds auth response --| | (5) ``` 1. Enfuce receives a 3DS authentication request from the payment network including merchant information. 2. Enfuce calls the client system, requesting a cardholder authentication. - The request contains both `authenticationId` and `challengeId` (UUIDs) that the client system uses when sending the challenge result back. - It also contains the customerNumber and other contextual info. 3. The client system must return an HTTP 200 OK response within 2 seconds. 4. Once the client system has a result from the cardholder authentication, it calls the \"Submit authentication challenge result\" endpoint, which needs to happen within 150 seconds from the start. 5. Enfuce responds to the payment network, and the authorization process can proceed.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.OOBAuthenticationChallengeWebhookNotificationApi = exports.OOBAuthenticationChallengeWebhookNotificationApiFactory = exports.OOBAuthenticationChallengeWebhookNotificationApiFp = exports.OOBAuthenticationChallengeWebhookNotificationApiAxiosParamCreator = exports.ThreeDsTransactionDeviceChannelEnum = exports.ThreeDsTransactionCategoryEnum = void 0;
|
|
26
|
+
const axios_1 = require("axios");
|
|
27
|
+
// Some imports not used depending on template conditions
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
const common_1 = require("./common");
|
|
30
|
+
// @ts-ignore
|
|
31
|
+
const base_1 = require("./base");
|
|
32
|
+
exports.ThreeDsTransactionCategoryEnum = {
|
|
33
|
+
Payment: 'PAYMENT',
|
|
34
|
+
NonPayment: 'NON_PAYMENT'
|
|
35
|
+
};
|
|
36
|
+
exports.ThreeDsTransactionDeviceChannelEnum = {
|
|
37
|
+
App: 'APP',
|
|
38
|
+
Browser: 'BROWSER',
|
|
39
|
+
RequestorInitiated: 'REQUESTOR_INITIATED'
|
|
40
|
+
};
|
|
41
|
+
/**
|
|
42
|
+
* OOBAuthenticationChallengeWebhookNotificationApi - axios parameter creator
|
|
43
|
+
* @export
|
|
44
|
+
*/
|
|
45
|
+
const OOBAuthenticationChallengeWebhookNotificationApiAxiosParamCreator = function (configuration) {
|
|
46
|
+
return {
|
|
47
|
+
/**
|
|
48
|
+
* In Out-of-Band (OOB) authentication flow, Enfuce sends an authentication challenge webhook notification to the issuer\'s registered endpoint for cardholder\'s approval.
|
|
49
|
+
* @summary Initiate OOB Authentication Challenge
|
|
50
|
+
* @param {InitiateAuthenticationChallengeBody} initiateAuthenticationChallengeBody
|
|
51
|
+
* @param {*} [options] Override http request option.
|
|
52
|
+
* @throws {RequiredError}
|
|
53
|
+
*/
|
|
54
|
+
initiateAuthenticationChallenge: (initiateAuthenticationChallengeBody_1, ...args_1) => __awaiter(this, [initiateAuthenticationChallengeBody_1, ...args_1], void 0, function* (initiateAuthenticationChallengeBody, options = {}) {
|
|
55
|
+
// verify required parameter 'initiateAuthenticationChallengeBody' is not null or undefined
|
|
56
|
+
(0, common_1.assertParamExists)('initiateAuthenticationChallenge', 'initiateAuthenticationChallengeBody', initiateAuthenticationChallengeBody);
|
|
57
|
+
const localVarPath = `/v1/3ds/oob/challenge/initiate`;
|
|
58
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
59
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
60
|
+
let baseOptions;
|
|
61
|
+
if (configuration) {
|
|
62
|
+
baseOptions = configuration.baseOptions;
|
|
63
|
+
}
|
|
64
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
65
|
+
const localVarHeaderParameter = {};
|
|
66
|
+
const localVarQueryParameter = {};
|
|
67
|
+
// authentication basicAuth required
|
|
68
|
+
// http basic authentication required
|
|
69
|
+
(0, common_1.setBasicAuthToObject)(localVarRequestOptions, configuration);
|
|
70
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
71
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
72
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
73
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
74
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(initiateAuthenticationChallengeBody, localVarRequestOptions, configuration);
|
|
75
|
+
return {
|
|
76
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
77
|
+
options: localVarRequestOptions,
|
|
78
|
+
};
|
|
79
|
+
}),
|
|
80
|
+
};
|
|
81
|
+
};
|
|
82
|
+
exports.OOBAuthenticationChallengeWebhookNotificationApiAxiosParamCreator = OOBAuthenticationChallengeWebhookNotificationApiAxiosParamCreator;
|
|
83
|
+
/**
|
|
84
|
+
* OOBAuthenticationChallengeWebhookNotificationApi - functional programming interface
|
|
85
|
+
* @export
|
|
86
|
+
*/
|
|
87
|
+
const OOBAuthenticationChallengeWebhookNotificationApiFp = function (configuration) {
|
|
88
|
+
const localVarAxiosParamCreator = (0, exports.OOBAuthenticationChallengeWebhookNotificationApiAxiosParamCreator)(configuration);
|
|
89
|
+
return {
|
|
90
|
+
/**
|
|
91
|
+
* In Out-of-Band (OOB) authentication flow, Enfuce sends an authentication challenge webhook notification to the issuer\'s registered endpoint for cardholder\'s approval.
|
|
92
|
+
* @summary Initiate OOB Authentication Challenge
|
|
93
|
+
* @param {InitiateAuthenticationChallengeBody} initiateAuthenticationChallengeBody
|
|
94
|
+
* @param {*} [options] Override http request option.
|
|
95
|
+
* @throws {RequiredError}
|
|
96
|
+
*/
|
|
97
|
+
initiateAuthenticationChallenge(initiateAuthenticationChallengeBody, options) {
|
|
98
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
99
|
+
var _a, _b, _c;
|
|
100
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.initiateAuthenticationChallenge(initiateAuthenticationChallengeBody, options);
|
|
101
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
102
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OOBAuthenticationChallengeWebhookNotificationApi.initiateAuthenticationChallenge']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
103
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
104
|
+
});
|
|
105
|
+
},
|
|
106
|
+
};
|
|
107
|
+
};
|
|
108
|
+
exports.OOBAuthenticationChallengeWebhookNotificationApiFp = OOBAuthenticationChallengeWebhookNotificationApiFp;
|
|
109
|
+
/**
|
|
110
|
+
* OOBAuthenticationChallengeWebhookNotificationApi - factory interface
|
|
111
|
+
* @export
|
|
112
|
+
*/
|
|
113
|
+
const OOBAuthenticationChallengeWebhookNotificationApiFactory = function (configuration, basePath, axios) {
|
|
114
|
+
const localVarFp = (0, exports.OOBAuthenticationChallengeWebhookNotificationApiFp)(configuration);
|
|
115
|
+
return {
|
|
116
|
+
/**
|
|
117
|
+
* In Out-of-Band (OOB) authentication flow, Enfuce sends an authentication challenge webhook notification to the issuer\'s registered endpoint for cardholder\'s approval.
|
|
118
|
+
* @summary Initiate OOB Authentication Challenge
|
|
119
|
+
* @param {InitiateAuthenticationChallengeBody} initiateAuthenticationChallengeBody
|
|
120
|
+
* @param {*} [options] Override http request option.
|
|
121
|
+
* @throws {RequiredError}
|
|
122
|
+
*/
|
|
123
|
+
initiateAuthenticationChallenge(initiateAuthenticationChallengeBody, options) {
|
|
124
|
+
return localVarFp.initiateAuthenticationChallenge(initiateAuthenticationChallengeBody, options).then((request) => request(axios, basePath));
|
|
125
|
+
},
|
|
126
|
+
};
|
|
127
|
+
};
|
|
128
|
+
exports.OOBAuthenticationChallengeWebhookNotificationApiFactory = OOBAuthenticationChallengeWebhookNotificationApiFactory;
|
|
129
|
+
/**
|
|
130
|
+
* OOBAuthenticationChallengeWebhookNotificationApi - object-oriented interface
|
|
131
|
+
* @export
|
|
132
|
+
* @class OOBAuthenticationChallengeWebhookNotificationApi
|
|
133
|
+
* @extends {BaseAPI}
|
|
134
|
+
*/
|
|
135
|
+
class OOBAuthenticationChallengeWebhookNotificationApi extends base_1.BaseAPI {
|
|
136
|
+
/**
|
|
137
|
+
* In Out-of-Band (OOB) authentication flow, Enfuce sends an authentication challenge webhook notification to the issuer\'s registered endpoint for cardholder\'s approval.
|
|
138
|
+
* @summary Initiate OOB Authentication Challenge
|
|
139
|
+
* @param {InitiateAuthenticationChallengeBody} initiateAuthenticationChallengeBody
|
|
140
|
+
* @param {*} [options] Override http request option.
|
|
141
|
+
* @throws {RequiredError}
|
|
142
|
+
* @memberof OOBAuthenticationChallengeWebhookNotificationApi
|
|
143
|
+
*/
|
|
144
|
+
initiateAuthenticationChallenge(initiateAuthenticationChallengeBody, options) {
|
|
145
|
+
return (0, exports.OOBAuthenticationChallengeWebhookNotificationApiFp)(this.configuration).initiateAuthenticationChallenge(initiateAuthenticationChallengeBody, options).then((request) => request(this.axios, this.basePath));
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
exports.OOBAuthenticationChallengeWebhookNotificationApi = OOBAuthenticationChallengeWebhookNotificationApi;
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 3DS OOB Outgoing Webhook API
|
|
3
|
+
* The 3DS Authentication API supports OOB (out of band) authentication during 3DS payment processing, where the client\'s own cardholder authentication service is used. All endpoints use HTTP response codes; requests and responses are UTF-8 encoded in JSON format. A client must be able to handle new elements added to either the request or response without breaking. **Timeout**: The 3rd party authentication system has 150 seconds (default, configurable during 3DS setup) to send a callback with the authentication challenge result. After this, Enfuce responds with a timeout to ACS and end user authentication fails. **CustomerNumber** in this context is equal to `cardholder.customerNumber` in other parts of the Enfuce API. ## 3DS OOB Authentication flow ``` Payment Network Enfuce 3DS API Client System | | | |-- 3ds auth request -->| | (1) | |-- POST /v1/3ds/oob/challenge/initiate ->| (2) | |<-------------- HTTP 200 OK --------------| (3) | | | | | authenticate cardholder | | | | |<-- POST /v1/3ds/challenge/oob/result ---| (4) |<- 3ds auth response --| | (5) ``` 1. Enfuce receives a 3DS authentication request from the payment network including merchant information. 2. Enfuce calls the client system, requesting a cardholder authentication. - The request contains both `authenticationId` and `challengeId` (UUIDs) that the client system uses when sending the challenge result back. - It also contains the customerNumber and other contextual info. 3. The client system must return an HTTP 200 OK response within 2 seconds. 4. Once the client system has a result from the cardholder authentication, it calls the \"Submit authentication challenge result\" endpoint, which needs to happen within 150 seconds from the start. 5. Enfuce responds to the payment network, and the authorization process can proceed.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
export declare const BASE_PATH: string;
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export declare const COLLECTION_FORMATS: {
|
|
20
|
+
csv: string;
|
|
21
|
+
ssv: string;
|
|
22
|
+
tsv: string;
|
|
23
|
+
pipes: string;
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @export
|
|
28
|
+
* @interface RequestArgs
|
|
29
|
+
*/
|
|
30
|
+
export interface RequestArgs {
|
|
31
|
+
url: string;
|
|
32
|
+
options: RawAxiosRequestConfig;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @export
|
|
37
|
+
* @class BaseAPI
|
|
38
|
+
*/
|
|
39
|
+
export declare class BaseAPI {
|
|
40
|
+
protected basePath: string;
|
|
41
|
+
protected axios: AxiosInstance;
|
|
42
|
+
protected configuration: Configuration | undefined;
|
|
43
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @export
|
|
48
|
+
* @class RequiredError
|
|
49
|
+
* @extends {Error}
|
|
50
|
+
*/
|
|
51
|
+
export declare class RequiredError extends Error {
|
|
52
|
+
field: string;
|
|
53
|
+
constructor(field: string, msg?: string);
|
|
54
|
+
}
|
|
55
|
+
interface ServerMap {
|
|
56
|
+
[key: string]: {
|
|
57
|
+
url: string;
|
|
58
|
+
description: string;
|
|
59
|
+
}[];
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @export
|
|
64
|
+
*/
|
|
65
|
+
export declare const operationServerMap: ServerMap;
|
|
66
|
+
export {};
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* 3DS OOB Outgoing Webhook API
|
|
6
|
+
* The 3DS Authentication API supports OOB (out of band) authentication during 3DS payment processing, where the client\'s own cardholder authentication service is used. All endpoints use HTTP response codes; requests and responses are UTF-8 encoded in JSON format. A client must be able to handle new elements added to either the request or response without breaking. **Timeout**: The 3rd party authentication system has 150 seconds (default, configurable during 3DS setup) to send a callback with the authentication challenge result. After this, Enfuce responds with a timeout to ACS and end user authentication fails. **CustomerNumber** in this context is equal to `cardholder.customerNumber` in other parts of the Enfuce API. ## 3DS OOB Authentication flow ``` Payment Network Enfuce 3DS API Client System | | | |-- 3ds auth request -->| | (1) | |-- POST /v1/3ds/oob/challenge/initiate ->| (2) | |<-------------- HTTP 200 OK --------------| (3) | | | | | authenticate cardholder | | | | |<-- POST /v1/3ds/challenge/oob/result ---| (4) |<- 3ds auth response --| | (5) ``` 1. Enfuce receives a 3DS authentication request from the payment network including merchant information. 2. Enfuce calls the client system, requesting a cardholder authentication. - The request contains both `authenticationId` and `challengeId` (UUIDs) that the client system uses when sending the challenge result back. - It also contains the customerNumber and other contextual info. 3. The client system must return an HTTP 200 OK response within 2 seconds. 4. Once the client system has a result from the cardholder authentication, it calls the \"Submit authentication challenge result\" endpoint, which needs to happen within 150 seconds from the start. 5. Enfuce responds to the payment network, and the authorization process can proceed.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
|
|
17
|
+
const axios_1 = require("axios");
|
|
18
|
+
exports.BASE_PATH = "http://localhost".replace(/\/+$/, "");
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @export
|
|
22
|
+
*/
|
|
23
|
+
exports.COLLECTION_FORMATS = {
|
|
24
|
+
csv: ",",
|
|
25
|
+
ssv: " ",
|
|
26
|
+
tsv: "\t",
|
|
27
|
+
pipes: "|",
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @export
|
|
32
|
+
* @class BaseAPI
|
|
33
|
+
*/
|
|
34
|
+
class BaseAPI {
|
|
35
|
+
constructor(configuration, basePath = exports.BASE_PATH, axios = axios_1.default) {
|
|
36
|
+
var _a;
|
|
37
|
+
this.basePath = basePath;
|
|
38
|
+
this.axios = axios;
|
|
39
|
+
if (configuration) {
|
|
40
|
+
this.configuration = configuration;
|
|
41
|
+
this.basePath = (_a = configuration.basePath) !== null && _a !== void 0 ? _a : basePath;
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
exports.BaseAPI = BaseAPI;
|
|
46
|
+
;
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @export
|
|
50
|
+
* @class RequiredError
|
|
51
|
+
* @extends {Error}
|
|
52
|
+
*/
|
|
53
|
+
class RequiredError extends Error {
|
|
54
|
+
constructor(field, msg) {
|
|
55
|
+
super(msg);
|
|
56
|
+
this.field = field;
|
|
57
|
+
this.name = "RequiredError";
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
exports.RequiredError = RequiredError;
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @export
|
|
64
|
+
*/
|
|
65
|
+
exports.operationServerMap = {};
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 3DS OOB Outgoing Webhook API
|
|
3
|
+
* The 3DS Authentication API supports OOB (out of band) authentication during 3DS payment processing, where the client\'s own cardholder authentication service is used. All endpoints use HTTP response codes; requests and responses are UTF-8 encoded in JSON format. A client must be able to handle new elements added to either the request or response without breaking. **Timeout**: The 3rd party authentication system has 150 seconds (default, configurable during 3DS setup) to send a callback with the authentication challenge result. After this, Enfuce responds with a timeout to ACS and end user authentication fails. **CustomerNumber** in this context is equal to `cardholder.customerNumber` in other parts of the Enfuce API. ## 3DS OOB Authentication flow ``` Payment Network Enfuce 3DS API Client System | | | |-- 3ds auth request -->| | (1) | |-- POST /v1/3ds/oob/challenge/initiate ->| (2) | |<-------------- HTTP 200 OK --------------| (3) | | | | | authenticate cardholder | | | | |<-- POST /v1/3ds/challenge/oob/result ---| (4) |<- 3ds auth response --| | (5) ``` 1. Enfuce receives a 3DS authentication request from the payment network including merchant information. 2. Enfuce calls the client system, requesting a cardholder authentication. - The request contains both `authenticationId` and `challengeId` (UUIDs) that the client system uses when sending the challenge result back. - It also contains the customerNumber and other contextual info. 3. The client system must return an HTTP 200 OK response within 2 seconds. 4. Once the client system has a result from the cardholder authentication, it calls the \"Submit authentication challenge result\" endpoint, which needs to happen within 150 seconds from the start. 5. Enfuce responds to the payment network, and the authorization process can proceed.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from "./configuration";
|
|
13
|
+
import type { RequestArgs } from "./base";
|
|
14
|
+
import type { AxiosInstance, AxiosResponse } from 'axios';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export declare const DUMMY_BASE_URL = "https://example.com";
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @throws {RequiredError}
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @export
|
|
29
|
+
*/
|
|
30
|
+
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @export
|
|
34
|
+
*/
|
|
35
|
+
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @export
|
|
39
|
+
*/
|
|
40
|
+
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @export
|
|
44
|
+
*/
|
|
45
|
+
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @export
|
|
49
|
+
*/
|
|
50
|
+
export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @export
|
|
54
|
+
*/
|
|
55
|
+
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @export
|
|
59
|
+
*/
|
|
60
|
+
export declare const toPathString: (url: URL) => string;
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @export
|
|
64
|
+
*/
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|