@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,2065 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Card API
|
|
3
|
+
* Endpoints for doing various actions connected to the Card entity. All date-time fields adhere to the ISO 8601 standard unless specified otherwise. For example: 2024-05-31T06:55:17Z
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1
|
|
6
|
+
* Contact: info@enfuce.com
|
|
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 Address
|
|
20
|
+
*/
|
|
21
|
+
export interface Address {
|
|
22
|
+
/**
|
|
23
|
+
* First line of address.
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof Address
|
|
26
|
+
*/
|
|
27
|
+
'address1': string;
|
|
28
|
+
/**
|
|
29
|
+
* Second line of address. Any string without trailing or leading whitespaces, or an empty string.
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof Address
|
|
32
|
+
*/
|
|
33
|
+
'address2'?: string;
|
|
34
|
+
/**
|
|
35
|
+
* Third line of address. Any string without trailing or leading whitespaces, or an empty string.
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof Address
|
|
38
|
+
*/
|
|
39
|
+
'address3'?: string;
|
|
40
|
+
/**
|
|
41
|
+
* Fourth line of the address. Any string without trailing or leading whitespaces, or an empty string.
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof Address
|
|
44
|
+
*/
|
|
45
|
+
'address4'?: string;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof Address
|
|
50
|
+
*/
|
|
51
|
+
'city': string;
|
|
52
|
+
/**
|
|
53
|
+
* A valid ISO-3166-1 alpha-3 country code.
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof Address
|
|
56
|
+
*/
|
|
57
|
+
'country': string;
|
|
58
|
+
/**
|
|
59
|
+
*
|
|
60
|
+
* @type {string}
|
|
61
|
+
* @memberof Address
|
|
62
|
+
*/
|
|
63
|
+
'region'?: string;
|
|
64
|
+
/**
|
|
65
|
+
*
|
|
66
|
+
* @type {string}
|
|
67
|
+
* @memberof Address
|
|
68
|
+
*/
|
|
69
|
+
'zipCode': string;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @export
|
|
74
|
+
* @interface CardApplication
|
|
75
|
+
*/
|
|
76
|
+
export interface CardApplication {
|
|
77
|
+
/**
|
|
78
|
+
* A unique code to identify the card configuration. Max character limit is 36.
|
|
79
|
+
* @type {string}
|
|
80
|
+
* @memberof CardApplication
|
|
81
|
+
*/
|
|
82
|
+
'cardConfigurationCode': string;
|
|
83
|
+
/**
|
|
84
|
+
*
|
|
85
|
+
* @type {CreatePinStatus}
|
|
86
|
+
* @memberof CardApplication
|
|
87
|
+
*/
|
|
88
|
+
'pinStatus'?: CreatePinStatus;
|
|
89
|
+
/**
|
|
90
|
+
* The account id that is connected to the card
|
|
91
|
+
* @type {string}
|
|
92
|
+
* @memberof CardApplication
|
|
93
|
+
*/
|
|
94
|
+
'accountId': string;
|
|
95
|
+
/**
|
|
96
|
+
* The digital layout code for the card. Max character limit is 36.
|
|
97
|
+
* @type {string}
|
|
98
|
+
* @memberof CardApplication
|
|
99
|
+
*/
|
|
100
|
+
'digitalLayoutCode'?: string;
|
|
101
|
+
/**
|
|
102
|
+
*
|
|
103
|
+
* @type {MultiApplicationProperties}
|
|
104
|
+
* @memberof CardApplication
|
|
105
|
+
*/
|
|
106
|
+
'multiApplicationProperties'?: MultiApplicationProperties;
|
|
107
|
+
/**
|
|
108
|
+
* You can include up to **30 additional key-value pairs** in the embossing file sent to the card manufacturer. - **Keys** must follow the pattern: `^[a-zA-Z0-9-]{1,36}$` (only letters, numbers, and hyphens, with a maximum length of 36 characters). - **Values** must follow the pattern: `^[a-zA-Z0-9|\\-_ +.@éàèùçâêîôûëïü\'/=]{1,1000}$`. Enfuce **does not perform any additional validation** on these key-value pairs beyond ensuring they match the specified patterns. These fields are intended for **storing data without further processing**. If you need to store a **complex structure**, you can **base64 encode** the value. The encoded value will be passed as entered, without modifications. ⚠ **Important:** Any usage of these fields should be agreed upon with the manufacturer.
|
|
109
|
+
* @type {{ [key: string]: string; }}
|
|
110
|
+
* @memberof CardApplication
|
|
111
|
+
*/
|
|
112
|
+
'additionalValues'?: {
|
|
113
|
+
[key: string]: string;
|
|
114
|
+
};
|
|
115
|
+
/**
|
|
116
|
+
* Unique identifier of a fee configuration. When provided, this value overrides the program default. This feature must be enabled for the tenant; otherwise, this field can be left null and will not be used.
|
|
117
|
+
* @type {string}
|
|
118
|
+
* @memberof CardApplication
|
|
119
|
+
*/
|
|
120
|
+
'feeConfigId'?: string;
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* The type of card defined by this card configuration.
|
|
124
|
+
* @export
|
|
125
|
+
* @enum {string}
|
|
126
|
+
*/
|
|
127
|
+
export declare const CardConfigurationType: {
|
|
128
|
+
readonly Debit: "DEBIT";
|
|
129
|
+
readonly Credit: "CREDIT";
|
|
130
|
+
readonly Combo: "COMBO";
|
|
131
|
+
};
|
|
132
|
+
export type CardConfigurationType = typeof CardConfigurationType[keyof typeof CardConfigurationType];
|
|
133
|
+
/**
|
|
134
|
+
*
|
|
135
|
+
* @export
|
|
136
|
+
* @interface CardDataControlTokenResponseBody
|
|
137
|
+
*/
|
|
138
|
+
export interface CardDataControlTokenResponseBody {
|
|
139
|
+
/**
|
|
140
|
+
* The control token.
|
|
141
|
+
* @type {string}
|
|
142
|
+
* @memberof CardDataControlTokenResponseBody
|
|
143
|
+
*/
|
|
144
|
+
'token': string;
|
|
145
|
+
/**
|
|
146
|
+
* The URL to call on mobile devices for accessing the card\'s data.
|
|
147
|
+
* @type {string}
|
|
148
|
+
* @memberof CardDataControlTokenResponseBody
|
|
149
|
+
*/
|
|
150
|
+
'cardDataUrl'?: string;
|
|
151
|
+
/**
|
|
152
|
+
* The URL to open in iframe to access the card\'s data.
|
|
153
|
+
* @type {string}
|
|
154
|
+
* @memberof CardDataControlTokenResponseBody
|
|
155
|
+
*/
|
|
156
|
+
'cardDataFrameUrl'?: string;
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* Select the type of delivery you prefer for the new card being created. - MAIL - The card would be sent via mail services. - COURIER - The card would be sent via courier services. - CUSTOM_1–CUSTOM_5 - Custom delivery types that can be used for shipping methods agreed between the customer and the bureau.
|
|
160
|
+
* @export
|
|
161
|
+
* @enum {string}
|
|
162
|
+
*/
|
|
163
|
+
export declare const CardDeliveryType: {
|
|
164
|
+
readonly Mail: "MAIL";
|
|
165
|
+
readonly Courier: "COURIER";
|
|
166
|
+
readonly Custom1: "CUSTOM_1";
|
|
167
|
+
readonly Custom2: "CUSTOM_2";
|
|
168
|
+
readonly Custom3: "CUSTOM_3";
|
|
169
|
+
readonly Custom4: "CUSTOM_4";
|
|
170
|
+
readonly Custom5: "CUSTOM_5";
|
|
171
|
+
};
|
|
172
|
+
export type CardDeliveryType = typeof CardDeliveryType[keyof typeof CardDeliveryType];
|
|
173
|
+
/**
|
|
174
|
+
*
|
|
175
|
+
* @export
|
|
176
|
+
* @interface CardResponse
|
|
177
|
+
*/
|
|
178
|
+
export interface CardResponse {
|
|
179
|
+
/**
|
|
180
|
+
* Unique identifier of a card.
|
|
181
|
+
* @type {string}
|
|
182
|
+
* @memberof CardResponse
|
|
183
|
+
*/
|
|
184
|
+
'id'?: string;
|
|
185
|
+
/**
|
|
186
|
+
* The date and time when the card was created.
|
|
187
|
+
* @type {string}
|
|
188
|
+
* @memberof CardResponse
|
|
189
|
+
*/
|
|
190
|
+
'createdAt'?: string;
|
|
191
|
+
/**
|
|
192
|
+
* The date and time when the object/entity was updated last time.
|
|
193
|
+
* @type {string}
|
|
194
|
+
* @memberof CardResponse
|
|
195
|
+
*/
|
|
196
|
+
'updatedAt'?: string;
|
|
197
|
+
/**
|
|
198
|
+
* The program ID associated with the card.
|
|
199
|
+
* @type {string}
|
|
200
|
+
* @memberof CardResponse
|
|
201
|
+
*/
|
|
202
|
+
'programId'?: string;
|
|
203
|
+
/**
|
|
204
|
+
* Unique identifier of the cardholder associated with the card.
|
|
205
|
+
* @type {string}
|
|
206
|
+
* @memberof CardResponse
|
|
207
|
+
*/
|
|
208
|
+
'cardholderId'?: string;
|
|
209
|
+
/**
|
|
210
|
+
* Unique identifier of the account associated with the card.
|
|
211
|
+
* @type {string}
|
|
212
|
+
* @memberof CardResponse
|
|
213
|
+
*/
|
|
214
|
+
'accountId'?: string;
|
|
215
|
+
/**
|
|
216
|
+
*
|
|
217
|
+
* @type {Plastic}
|
|
218
|
+
* @memberof CardResponse
|
|
219
|
+
*/
|
|
220
|
+
'plastic'?: Plastic;
|
|
221
|
+
/**
|
|
222
|
+
* Card versions ordered by sequence number ascending.
|
|
223
|
+
* @type {Array<CardVersion>}
|
|
224
|
+
* @memberof CardResponse
|
|
225
|
+
*/
|
|
226
|
+
'cardVersions'?: Array<CardVersion>;
|
|
227
|
+
/**
|
|
228
|
+
*
|
|
229
|
+
* @type {CardRole}
|
|
230
|
+
* @memberof CardResponse
|
|
231
|
+
*/
|
|
232
|
+
'role'?: CardRole;
|
|
233
|
+
/**
|
|
234
|
+
* Unique identifier of the main card. Populated if this card is part of a card application
|
|
235
|
+
* @type {string}
|
|
236
|
+
* @memberof CardResponse
|
|
237
|
+
*/
|
|
238
|
+
'mainCardId'?: string;
|
|
239
|
+
/**
|
|
240
|
+
* A unique code to identify the card configuration. Max character limit is 36.
|
|
241
|
+
* @type {string}
|
|
242
|
+
* @memberof CardResponse
|
|
243
|
+
*/
|
|
244
|
+
'cardConfigurationCode'?: string;
|
|
245
|
+
/**
|
|
246
|
+
*
|
|
247
|
+
* @type {CardConfigurationType}
|
|
248
|
+
* @memberof CardResponse
|
|
249
|
+
*/
|
|
250
|
+
'cardConfigurationType'?: CardConfigurationType;
|
|
251
|
+
/**
|
|
252
|
+
*
|
|
253
|
+
* @type {CardScheme}
|
|
254
|
+
* @memberof CardResponse
|
|
255
|
+
*/
|
|
256
|
+
'cardScheme'?: CardScheme;
|
|
257
|
+
/**
|
|
258
|
+
* A masked version of the primary account number
|
|
259
|
+
* @type {string}
|
|
260
|
+
* @memberof CardResponse
|
|
261
|
+
*/
|
|
262
|
+
'maskedPan'?: string;
|
|
263
|
+
/**
|
|
264
|
+
*
|
|
265
|
+
* @type {PinStatus}
|
|
266
|
+
* @memberof CardResponse
|
|
267
|
+
*/
|
|
268
|
+
'pinStatus'?: PinStatus;
|
|
269
|
+
/**
|
|
270
|
+
*
|
|
271
|
+
* @type {CardStatus}
|
|
272
|
+
* @memberof CardResponse
|
|
273
|
+
*/
|
|
274
|
+
'cardStatus'?: CardStatus;
|
|
275
|
+
/**
|
|
276
|
+
* A flag indicating whether automatic renewal is enabled or not.
|
|
277
|
+
* @type {boolean}
|
|
278
|
+
* @memberof CardResponse
|
|
279
|
+
*/
|
|
280
|
+
'automaticRenewal'?: boolean;
|
|
281
|
+
/**
|
|
282
|
+
* The digital layout code for the card. Max character limit is 36.
|
|
283
|
+
* @type {string}
|
|
284
|
+
* @memberof CardResponse
|
|
285
|
+
*/
|
|
286
|
+
'digitalLayoutCode'?: string;
|
|
287
|
+
/**
|
|
288
|
+
*
|
|
289
|
+
* @type {MultiApplicationProperties}
|
|
290
|
+
* @memberof CardResponse
|
|
291
|
+
*/
|
|
292
|
+
'multiApplicationProperties'?: MultiApplicationProperties;
|
|
293
|
+
/**
|
|
294
|
+
* The version number of the entity.
|
|
295
|
+
* @type {number}
|
|
296
|
+
* @memberof CardResponse
|
|
297
|
+
*/
|
|
298
|
+
'updateCount'?: number;
|
|
299
|
+
/**
|
|
300
|
+
* You can include up to **30 additional key-value pairs** in the embossing file sent to the card manufacturer. - **Keys** must follow the pattern: `^[a-zA-Z0-9-]{1,36}$` (only letters, numbers, and hyphens, with a maximum length of 36 characters). - **Values** must follow the pattern: `^[a-zA-Z0-9|\\-_ +.@éàèùçâêîôûëïü\'/=]{1,1000}$`. Enfuce **does not perform any additional validation** on these key-value pairs beyond ensuring they match the specified patterns. These fields are intended for **storing data without further processing**. If you need to store a **complex structure**, you can **base64 encode** the value. The encoded value will be passed as entered, without modifications. ⚠ **Important:** Any usage of these fields should be agreed upon with the manufacturer.
|
|
301
|
+
* @type {{ [key: string]: string; }}
|
|
302
|
+
* @memberof CardResponse
|
|
303
|
+
*/
|
|
304
|
+
'additionalValues'?: {
|
|
305
|
+
[key: string]: string;
|
|
306
|
+
};
|
|
307
|
+
/**
|
|
308
|
+
* Unique identifier of a fee configuration. When provided, this value overrides the program default. This feature must be enabled for the tenant; otherwise, this field can be left null and will not be used.
|
|
309
|
+
* @type {string}
|
|
310
|
+
* @memberof CardResponse
|
|
311
|
+
*/
|
|
312
|
+
'feeConfigId'?: string | null;
|
|
313
|
+
}
|
|
314
|
+
/**
|
|
315
|
+
* The role of the card. Multi application cards will have one main card and multiple card applications. Single cards will be treated as main cards.
|
|
316
|
+
* @export
|
|
317
|
+
* @enum {string}
|
|
318
|
+
*/
|
|
319
|
+
export declare const CardRole: {
|
|
320
|
+
readonly MainCard: "MAIN_CARD";
|
|
321
|
+
readonly CardApplication: "CARD_APPLICATION";
|
|
322
|
+
};
|
|
323
|
+
export type CardRole = typeof CardRole[keyof typeof CardRole];
|
|
324
|
+
/**
|
|
325
|
+
*
|
|
326
|
+
* @export
|
|
327
|
+
* @enum {string}
|
|
328
|
+
*/
|
|
329
|
+
export declare const CardScheme: {
|
|
330
|
+
readonly Mastercard: "MASTERCARD";
|
|
331
|
+
readonly Visa: "VISA";
|
|
332
|
+
};
|
|
333
|
+
export type CardScheme = typeof CardScheme[keyof typeof CardScheme];
|
|
334
|
+
/**
|
|
335
|
+
* - ACTIVE - Card is active and is enabled for normal usage. - BLOCKED - Card is temporarily blocked. - BLOCKED_SUSPECTED_FRAUD - Card is temporarily blocked due to suspected fraud. - CLOSED_DUE_TO_FRAUD - Card has been closed due to fraud. - CLOSED_LOST - Card has been closed due to being lost. - CLOSED_STOLEN - Card has been closed due to being stolen. - CLOSED - Card has been manually closed. - CLOSED_EXPIRED - Card has no active or initial card versions and cannot be used.
|
|
336
|
+
* @export
|
|
337
|
+
* @enum {string}
|
|
338
|
+
*/
|
|
339
|
+
export declare const CardStatus: {
|
|
340
|
+
readonly Active: "ACTIVE";
|
|
341
|
+
readonly Blocked: "BLOCKED";
|
|
342
|
+
readonly BlockedSuspectedFraud: "BLOCKED_SUSPECTED_FRAUD";
|
|
343
|
+
readonly ClosedDueToFraud: "CLOSED_DUE_TO_FRAUD";
|
|
344
|
+
readonly ClosedLost: "CLOSED_LOST";
|
|
345
|
+
readonly ClosedStolen: "CLOSED_STOLEN";
|
|
346
|
+
readonly Closed: "CLOSED";
|
|
347
|
+
readonly ClosedExpired: "CLOSED_EXPIRED";
|
|
348
|
+
};
|
|
349
|
+
export type CardStatus = typeof CardStatus[keyof typeof CardStatus];
|
|
350
|
+
/**
|
|
351
|
+
*
|
|
352
|
+
* @export
|
|
353
|
+
* @interface CardVersion
|
|
354
|
+
*/
|
|
355
|
+
export interface CardVersion {
|
|
356
|
+
/**
|
|
357
|
+
*
|
|
358
|
+
* @type {CardVersionStatus}
|
|
359
|
+
* @memberof CardVersion
|
|
360
|
+
*/
|
|
361
|
+
'status'?: CardVersionStatus;
|
|
362
|
+
/**
|
|
363
|
+
* The expiration date-time of the card in UTC format. The time must be a value in te future.
|
|
364
|
+
* @type {string}
|
|
365
|
+
* @memberof CardVersion
|
|
366
|
+
*/
|
|
367
|
+
'expirationTime'?: string;
|
|
368
|
+
/**
|
|
369
|
+
* The date when the auto renewal occurs.
|
|
370
|
+
* @type {string}
|
|
371
|
+
* @memberof CardVersion
|
|
372
|
+
*/
|
|
373
|
+
'renewalDate'?: string;
|
|
374
|
+
/**
|
|
375
|
+
* The sequence number of the card version, this value is also known as PSN (pan sequence number)
|
|
376
|
+
* @type {number}
|
|
377
|
+
* @memberof CardVersion
|
|
378
|
+
*/
|
|
379
|
+
'sequenceNumber'?: number;
|
|
380
|
+
/**
|
|
381
|
+
* The id of the key set used by this card version
|
|
382
|
+
* @type {string}
|
|
383
|
+
* @memberof CardVersion
|
|
384
|
+
*/
|
|
385
|
+
'keySetId'?: string;
|
|
386
|
+
/**
|
|
387
|
+
* The date and time when the card was created.
|
|
388
|
+
* @type {string}
|
|
389
|
+
* @memberof CardVersion
|
|
390
|
+
*/
|
|
391
|
+
'createdAt'?: string;
|
|
392
|
+
/**
|
|
393
|
+
* The date and time when the object/entity was updated last time.
|
|
394
|
+
* @type {string}
|
|
395
|
+
* @memberof CardVersion
|
|
396
|
+
*/
|
|
397
|
+
'updatedAt'?: string;
|
|
398
|
+
}
|
|
399
|
+
/**
|
|
400
|
+
* - ACTIVE - The card is completely operational. You can perform all actions with the card. - INITIAL - The specific card version is awaiting activation. During this state, the card can have limited usage, such as being added to a digital wallet or cardholder can view the PIN (if it is a plastic card). However, in the INITIAL state, the card cannot be used for payments. - CLOSED - The previous versions of the card are no longer valid as a new version is activated or the card is closed.
|
|
401
|
+
* @export
|
|
402
|
+
* @enum {string}
|
|
403
|
+
*/
|
|
404
|
+
export declare const CardVersionStatus: {
|
|
405
|
+
readonly Active: "ACTIVE";
|
|
406
|
+
readonly Initial: "INITIAL";
|
|
407
|
+
readonly Closed: "CLOSED";
|
|
408
|
+
};
|
|
409
|
+
export type CardVersionStatus = typeof CardVersionStatus[keyof typeof CardVersionStatus];
|
|
410
|
+
/**
|
|
411
|
+
* - GENERATED - A pin should be randomly generated for the card. - WAITING - A pin is waiting to be set on the card.
|
|
412
|
+
* @export
|
|
413
|
+
* @enum {string}
|
|
414
|
+
*/
|
|
415
|
+
export declare const ChangePinStatus: {
|
|
416
|
+
readonly Generated: "GENERATED";
|
|
417
|
+
readonly Waiting: "WAITING";
|
|
418
|
+
};
|
|
419
|
+
export type ChangePinStatus = typeof ChangePinStatus[keyof typeof ChangePinStatus];
|
|
420
|
+
/**
|
|
421
|
+
*
|
|
422
|
+
* @export
|
|
423
|
+
* @interface ControlTokenRequestBody
|
|
424
|
+
*/
|
|
425
|
+
export interface ControlTokenRequestBody {
|
|
426
|
+
/**
|
|
427
|
+
* The sequence number of the card version to use. If not specified, the latest card version is used by default. Only card versions not in CLOSED status are allowed.
|
|
428
|
+
* @type {number}
|
|
429
|
+
* @memberof ControlTokenRequestBody
|
|
430
|
+
*/
|
|
431
|
+
'sequenceNumber'?: number;
|
|
432
|
+
}
|
|
433
|
+
/**
|
|
434
|
+
* @type CreateCard201Response
|
|
435
|
+
* @export
|
|
436
|
+
*/
|
|
437
|
+
export type CreateCard201Response = CardResponse | CreateMultiApplicationCardResponse;
|
|
438
|
+
/**
|
|
439
|
+
*
|
|
440
|
+
* @export
|
|
441
|
+
* @interface CreateCardBody
|
|
442
|
+
*/
|
|
443
|
+
export interface CreateCardBody {
|
|
444
|
+
/**
|
|
445
|
+
* The program id that you want to associate with the new card you are creating.
|
|
446
|
+
* @type {string}
|
|
447
|
+
* @memberof CreateCardBody
|
|
448
|
+
*/
|
|
449
|
+
'programId': string;
|
|
450
|
+
/**
|
|
451
|
+
* A unique code to identify the card configuration. Max character limit is 36.
|
|
452
|
+
* @type {string}
|
|
453
|
+
* @memberof CreateCardBody
|
|
454
|
+
*/
|
|
455
|
+
'cardConfigurationCode': string;
|
|
456
|
+
/**
|
|
457
|
+
*
|
|
458
|
+
* @type {CreatePinStatus}
|
|
459
|
+
* @memberof CreateCardBody
|
|
460
|
+
*/
|
|
461
|
+
'pinStatus'?: CreatePinStatus;
|
|
462
|
+
/**
|
|
463
|
+
* Unique identifier of the cardholder associated with the new card.
|
|
464
|
+
* @type {string}
|
|
465
|
+
* @memberof CreateCardBody
|
|
466
|
+
*/
|
|
467
|
+
'cardholderId'?: string;
|
|
468
|
+
/**
|
|
469
|
+
* The expiration date-time of the card in UTC format. The time must be a value in te future.
|
|
470
|
+
* @type {string}
|
|
471
|
+
* @memberof CreateCardBody
|
|
472
|
+
*/
|
|
473
|
+
'expirationTime'?: string;
|
|
474
|
+
/**
|
|
475
|
+
* Unique identifier of the account associated with the new card.
|
|
476
|
+
* @type {string}
|
|
477
|
+
* @memberof CreateCardBody
|
|
478
|
+
*/
|
|
479
|
+
'accountId': string;
|
|
480
|
+
/**
|
|
481
|
+
*
|
|
482
|
+
* @type {CreatePlasticBody}
|
|
483
|
+
* @memberof CreateCardBody
|
|
484
|
+
*/
|
|
485
|
+
'plastic'?: CreatePlasticBody;
|
|
486
|
+
/**
|
|
487
|
+
* A flag indicating whether automatic renewal is enabled or not.
|
|
488
|
+
* @type {boolean}
|
|
489
|
+
* @memberof CreateCardBody
|
|
490
|
+
*/
|
|
491
|
+
'automaticRenewal'?: boolean;
|
|
492
|
+
/**
|
|
493
|
+
* The digital layout code for the card. Max character limit is 36.
|
|
494
|
+
* @type {string}
|
|
495
|
+
* @memberof CreateCardBody
|
|
496
|
+
*/
|
|
497
|
+
'digitalLayoutCode'?: string;
|
|
498
|
+
/**
|
|
499
|
+
* You can include up to **30 additional key-value pairs** in the embossing file sent to the card manufacturer. - **Keys** must follow the pattern: `^[a-zA-Z0-9-]{1,36}$` (only letters, numbers, and hyphens, with a maximum length of 36 characters). - **Values** must follow the pattern: `^[a-zA-Z0-9|\\-_ +.@éàèùçâêîôûëïü\'/=]{1,1000}$`. Enfuce **does not perform any additional validation** on these key-value pairs beyond ensuring they match the specified patterns. These fields are intended for **storing data without further processing**. If you need to store a **complex structure**, you can **base64 encode** the value. The encoded value will be passed as entered, without modifications. ⚠ **Important:** Any usage of these fields should be agreed upon with the manufacturer.
|
|
500
|
+
* @type {{ [key: string]: string; }}
|
|
501
|
+
* @memberof CreateCardBody
|
|
502
|
+
*/
|
|
503
|
+
'additionalValues'?: {
|
|
504
|
+
[key: string]: string;
|
|
505
|
+
};
|
|
506
|
+
/**
|
|
507
|
+
* Unique identifier of a fee configuration. When provided, this value overrides the program default. This feature must be enabled for the tenant; otherwise, this field can be left null and will not be used.
|
|
508
|
+
* @type {string}
|
|
509
|
+
* @memberof CreateCardBody
|
|
510
|
+
*/
|
|
511
|
+
'feeConfigId'?: string;
|
|
512
|
+
}
|
|
513
|
+
/**
|
|
514
|
+
* @type CreateCardRequest
|
|
515
|
+
* @export
|
|
516
|
+
*/
|
|
517
|
+
export type CreateCardRequest = CreateCardBody | CreateMultiApplicationCardBody;
|
|
518
|
+
/**
|
|
519
|
+
*
|
|
520
|
+
* @export
|
|
521
|
+
* @interface CreateMultiApplicationCardBody
|
|
522
|
+
*/
|
|
523
|
+
export interface CreateMultiApplicationCardBody {
|
|
524
|
+
/**
|
|
525
|
+
*
|
|
526
|
+
* @type {MainCard}
|
|
527
|
+
* @memberof CreateMultiApplicationCardBody
|
|
528
|
+
*/
|
|
529
|
+
'mainCard': MainCard;
|
|
530
|
+
/**
|
|
531
|
+
*
|
|
532
|
+
* @type {Array<CardApplication>}
|
|
533
|
+
* @memberof CreateMultiApplicationCardBody
|
|
534
|
+
*/
|
|
535
|
+
'cardApplications': Array<CardApplication>;
|
|
536
|
+
}
|
|
537
|
+
/**
|
|
538
|
+
*
|
|
539
|
+
* @export
|
|
540
|
+
* @interface CreateMultiApplicationCardResponse
|
|
541
|
+
*/
|
|
542
|
+
export interface CreateMultiApplicationCardResponse {
|
|
543
|
+
/**
|
|
544
|
+
* Unique identifier of a card.
|
|
545
|
+
* @type {string}
|
|
546
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
547
|
+
*/
|
|
548
|
+
'id'?: string;
|
|
549
|
+
/**
|
|
550
|
+
* The date and time when the card was created.
|
|
551
|
+
* @type {string}
|
|
552
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
553
|
+
*/
|
|
554
|
+
'createdAt'?: string;
|
|
555
|
+
/**
|
|
556
|
+
* The date and time when the object/entity was updated last time.
|
|
557
|
+
* @type {string}
|
|
558
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
559
|
+
*/
|
|
560
|
+
'updatedAt'?: string;
|
|
561
|
+
/**
|
|
562
|
+
* The program ID associated with the card.
|
|
563
|
+
* @type {string}
|
|
564
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
565
|
+
*/
|
|
566
|
+
'programId'?: string;
|
|
567
|
+
/**
|
|
568
|
+
* Unique identifier of the cardholder associated with the card.
|
|
569
|
+
* @type {string}
|
|
570
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
571
|
+
*/
|
|
572
|
+
'cardholderId'?: string;
|
|
573
|
+
/**
|
|
574
|
+
* Unique identifier of the account associated with the card.
|
|
575
|
+
* @type {string}
|
|
576
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
577
|
+
*/
|
|
578
|
+
'accountId'?: string;
|
|
579
|
+
/**
|
|
580
|
+
*
|
|
581
|
+
* @type {Plastic}
|
|
582
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
583
|
+
*/
|
|
584
|
+
'plastic'?: Plastic;
|
|
585
|
+
/**
|
|
586
|
+
* Card versions ordered by sequence number ascending.
|
|
587
|
+
* @type {Array<CardVersion>}
|
|
588
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
589
|
+
*/
|
|
590
|
+
'cardVersions'?: Array<CardVersion>;
|
|
591
|
+
/**
|
|
592
|
+
*
|
|
593
|
+
* @type {CardRole}
|
|
594
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
595
|
+
*/
|
|
596
|
+
'role'?: CardRole;
|
|
597
|
+
/**
|
|
598
|
+
* Unique identifier of the main card. Populated if this card is part of a card application
|
|
599
|
+
* @type {string}
|
|
600
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
601
|
+
*/
|
|
602
|
+
'mainCardId'?: string;
|
|
603
|
+
/**
|
|
604
|
+
* A unique code to identify the card configuration. Max character limit is 36.
|
|
605
|
+
* @type {string}
|
|
606
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
607
|
+
*/
|
|
608
|
+
'cardConfigurationCode'?: string;
|
|
609
|
+
/**
|
|
610
|
+
*
|
|
611
|
+
* @type {CardConfigurationType}
|
|
612
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
613
|
+
*/
|
|
614
|
+
'cardConfigurationType'?: CardConfigurationType;
|
|
615
|
+
/**
|
|
616
|
+
*
|
|
617
|
+
* @type {CardScheme}
|
|
618
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
619
|
+
*/
|
|
620
|
+
'cardScheme'?: CardScheme;
|
|
621
|
+
/**
|
|
622
|
+
* A masked version of the primary account number
|
|
623
|
+
* @type {string}
|
|
624
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
625
|
+
*/
|
|
626
|
+
'maskedPan'?: string;
|
|
627
|
+
/**
|
|
628
|
+
*
|
|
629
|
+
* @type {PinStatus}
|
|
630
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
631
|
+
*/
|
|
632
|
+
'pinStatus'?: PinStatus;
|
|
633
|
+
/**
|
|
634
|
+
*
|
|
635
|
+
* @type {CardStatus}
|
|
636
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
637
|
+
*/
|
|
638
|
+
'cardStatus'?: CardStatus;
|
|
639
|
+
/**
|
|
640
|
+
* A flag indicating whether automatic renewal is enabled or not.
|
|
641
|
+
* @type {boolean}
|
|
642
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
643
|
+
*/
|
|
644
|
+
'automaticRenewal'?: boolean;
|
|
645
|
+
/**
|
|
646
|
+
* The digital layout code for the card. Max character limit is 36.
|
|
647
|
+
* @type {string}
|
|
648
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
649
|
+
*/
|
|
650
|
+
'digitalLayoutCode'?: string;
|
|
651
|
+
/**
|
|
652
|
+
*
|
|
653
|
+
* @type {MultiApplicationProperties}
|
|
654
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
655
|
+
*/
|
|
656
|
+
'multiApplicationProperties'?: MultiApplicationProperties;
|
|
657
|
+
/**
|
|
658
|
+
* The version number of the entity.
|
|
659
|
+
* @type {number}
|
|
660
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
661
|
+
*/
|
|
662
|
+
'updateCount'?: number;
|
|
663
|
+
/**
|
|
664
|
+
* You can include up to **30 additional key-value pairs** in the embossing file sent to the card manufacturer. - **Keys** must follow the pattern: `^[a-zA-Z0-9-]{1,36}$` (only letters, numbers, and hyphens, with a maximum length of 36 characters). - **Values** must follow the pattern: `^[a-zA-Z0-9|\\-_ +.@éàèùçâêîôûëïü\'/=]{1,1000}$`. Enfuce **does not perform any additional validation** on these key-value pairs beyond ensuring they match the specified patterns. These fields are intended for **storing data without further processing**. If you need to store a **complex structure**, you can **base64 encode** the value. The encoded value will be passed as entered, without modifications. ⚠ **Important:** Any usage of these fields should be agreed upon with the manufacturer.
|
|
665
|
+
* @type {{ [key: string]: string; }}
|
|
666
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
667
|
+
*/
|
|
668
|
+
'additionalValues'?: {
|
|
669
|
+
[key: string]: string;
|
|
670
|
+
};
|
|
671
|
+
/**
|
|
672
|
+
* Unique identifier of a fee configuration. When provided, this value overrides the program default. This feature must be enabled for the tenant; otherwise, this field can be left null and will not be used.
|
|
673
|
+
* @type {string}
|
|
674
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
675
|
+
*/
|
|
676
|
+
'feeConfigId'?: string | null;
|
|
677
|
+
/**
|
|
678
|
+
*
|
|
679
|
+
* @type {Array<CardResponse>}
|
|
680
|
+
* @memberof CreateMultiApplicationCardResponse
|
|
681
|
+
*/
|
|
682
|
+
'cardApplications'?: Array<CardResponse>;
|
|
683
|
+
}
|
|
684
|
+
/**
|
|
685
|
+
* - GENERATED - This endpoint request would generate a random PIN for the new card. - WAITING - The card PIN would be set later.
|
|
686
|
+
* @export
|
|
687
|
+
* @enum {string}
|
|
688
|
+
*/
|
|
689
|
+
export declare const CreatePinStatus: {
|
|
690
|
+
readonly Generated: "GENERATED";
|
|
691
|
+
readonly Waiting: "WAITING";
|
|
692
|
+
};
|
|
693
|
+
export type CreatePinStatus = typeof CreatePinStatus[keyof typeof CreatePinStatus];
|
|
694
|
+
/**
|
|
695
|
+
*
|
|
696
|
+
* @export
|
|
697
|
+
* @interface CreatePlasticBody
|
|
698
|
+
*/
|
|
699
|
+
export interface CreatePlasticBody {
|
|
700
|
+
/**
|
|
701
|
+
* The name to be embossed on the card. Max character limit is 26.
|
|
702
|
+
* @type {string}
|
|
703
|
+
* @memberof CreatePlasticBody
|
|
704
|
+
*/
|
|
705
|
+
'embossingName'?: string;
|
|
706
|
+
/**
|
|
707
|
+
*
|
|
708
|
+
* @type {Address}
|
|
709
|
+
* @memberof CreatePlasticBody
|
|
710
|
+
*/
|
|
711
|
+
'preferredCardAddress'?: Address;
|
|
712
|
+
/**
|
|
713
|
+
*
|
|
714
|
+
* @type {CardDeliveryType}
|
|
715
|
+
* @memberof CreatePlasticBody
|
|
716
|
+
*/
|
|
717
|
+
'preferredCardDeliveryType'?: CardDeliveryType;
|
|
718
|
+
/**
|
|
719
|
+
*
|
|
720
|
+
* @type {Address}
|
|
721
|
+
* @memberof CreatePlasticBody
|
|
722
|
+
*/
|
|
723
|
+
'preferredPinAddress'?: Address;
|
|
724
|
+
/**
|
|
725
|
+
*
|
|
726
|
+
* @type {PinDeliveryType}
|
|
727
|
+
* @memberof CreatePlasticBody
|
|
728
|
+
*/
|
|
729
|
+
'preferredPinDeliveryType'?: PinDeliveryType;
|
|
730
|
+
/**
|
|
731
|
+
* Unique code forwarded to the embossing house; the code identifies the plastic layout to be used for printing the new card. Ensure beforehand, the selected embossing house is aligned with the code used for each layout.
|
|
732
|
+
* @type {string}
|
|
733
|
+
* @memberof CreatePlasticBody
|
|
734
|
+
*/
|
|
735
|
+
'externalLayoutCode'?: string;
|
|
736
|
+
/**
|
|
737
|
+
* The manufacturer id to use for this specific plastic if it deviates from the default manufacturer configured on the program
|
|
738
|
+
* @type {string}
|
|
739
|
+
* @memberof CreatePlasticBody
|
|
740
|
+
*/
|
|
741
|
+
'manufacturerId'?: string;
|
|
742
|
+
}
|
|
743
|
+
/**
|
|
744
|
+
*
|
|
745
|
+
* @export
|
|
746
|
+
* @interface EncryptCardPaymentInfoRequestBody
|
|
747
|
+
*/
|
|
748
|
+
export interface EncryptCardPaymentInfoRequestBody {
|
|
749
|
+
/**
|
|
750
|
+
* Public key used to encrypt the fields in the result.
|
|
751
|
+
* @type {string}
|
|
752
|
+
* @memberof EncryptCardPaymentInfoRequestBody
|
|
753
|
+
*/
|
|
754
|
+
'encryptionKey': string;
|
|
755
|
+
/**
|
|
756
|
+
* In this field the encryption method is selected. This is to prepared for future use since only one method is now supported.
|
|
757
|
+
* @type {string}
|
|
758
|
+
* @memberof EncryptCardPaymentInfoRequestBody
|
|
759
|
+
*/
|
|
760
|
+
'encryptionMethod': EncryptCardPaymentInfoRequestBodyEncryptionMethodEnum;
|
|
761
|
+
/**
|
|
762
|
+
* In this field you can include the parameters that you want to be returned in an encrypted way. If a field is not listed, it will be left out from the response. Note that only primaryAccountNumber and CVV2 will be encrypted.
|
|
763
|
+
* @type {Array<string>}
|
|
764
|
+
* @memberof EncryptCardPaymentInfoRequestBody
|
|
765
|
+
*/
|
|
766
|
+
'fields': Array<EncryptCardPaymentInfoRequestBodyFieldsEnum>;
|
|
767
|
+
/**
|
|
768
|
+
* The sequence number of the card version to use. If not specified, the latest card version is used by default.
|
|
769
|
+
* @type {number}
|
|
770
|
+
* @memberof EncryptCardPaymentInfoRequestBody
|
|
771
|
+
*/
|
|
772
|
+
'sequenceNumber'?: number;
|
|
773
|
+
}
|
|
774
|
+
export declare const EncryptCardPaymentInfoRequestBodyEncryptionMethodEnum: {
|
|
775
|
+
readonly RsaEcbOaepSha256Mgf12048: "RSA_ECB_OAEP_SHA256_MGF1_2048";
|
|
776
|
+
};
|
|
777
|
+
export type EncryptCardPaymentInfoRequestBodyEncryptionMethodEnum = typeof EncryptCardPaymentInfoRequestBodyEncryptionMethodEnum[keyof typeof EncryptCardPaymentInfoRequestBodyEncryptionMethodEnum];
|
|
778
|
+
export declare const EncryptCardPaymentInfoRequestBodyFieldsEnum: {
|
|
779
|
+
readonly PrimaryAccountNumber: "PRIMARY_ACCOUNT_NUMBER";
|
|
780
|
+
readonly ExpirationDate: "EXPIRATION_DATE";
|
|
781
|
+
readonly Cvv2: "CVV2";
|
|
782
|
+
};
|
|
783
|
+
export type EncryptCardPaymentInfoRequestBodyFieldsEnum = typeof EncryptCardPaymentInfoRequestBodyFieldsEnum[keyof typeof EncryptCardPaymentInfoRequestBodyFieldsEnum];
|
|
784
|
+
/**
|
|
785
|
+
*
|
|
786
|
+
* @export
|
|
787
|
+
* @interface EncryptCardPaymentInfoResponseBody
|
|
788
|
+
*/
|
|
789
|
+
export interface EncryptCardPaymentInfoResponseBody {
|
|
790
|
+
/**
|
|
791
|
+
* The encrypted full card number (PAN) — Base64 encoded.
|
|
792
|
+
* @type {string}
|
|
793
|
+
* @memberof EncryptCardPaymentInfoResponseBody
|
|
794
|
+
*/
|
|
795
|
+
'primaryAccountNumber': string;
|
|
796
|
+
/**
|
|
797
|
+
* The expiration date of the card in MMYY format.
|
|
798
|
+
* @type {string}
|
|
799
|
+
* @memberof EncryptCardPaymentInfoResponseBody
|
|
800
|
+
*/
|
|
801
|
+
'expirationDate': string;
|
|
802
|
+
/**
|
|
803
|
+
* The encrypted CVV2 (for Visa) or CVC2 (for Mastercard) value — Base64 encoded.
|
|
804
|
+
* @type {string}
|
|
805
|
+
* @memberof EncryptCardPaymentInfoResponseBody
|
|
806
|
+
*/
|
|
807
|
+
'cvv2': string;
|
|
808
|
+
}
|
|
809
|
+
/**
|
|
810
|
+
*
|
|
811
|
+
* @export
|
|
812
|
+
* @interface ErrorResponse
|
|
813
|
+
*/
|
|
814
|
+
export interface ErrorResponse {
|
|
815
|
+
/**
|
|
816
|
+
* The problem type.
|
|
817
|
+
* @type {string}
|
|
818
|
+
* @memberof ErrorResponse
|
|
819
|
+
*/
|
|
820
|
+
'type'?: string;
|
|
821
|
+
/**
|
|
822
|
+
* The reason phrase of HttpStatus.
|
|
823
|
+
* @type {string}
|
|
824
|
+
* @memberof ErrorResponse
|
|
825
|
+
*/
|
|
826
|
+
'title'?: string;
|
|
827
|
+
/**
|
|
828
|
+
* HTTP problem status.
|
|
829
|
+
* @type {number}
|
|
830
|
+
* @memberof ErrorResponse
|
|
831
|
+
*/
|
|
832
|
+
'status'?: number;
|
|
833
|
+
/**
|
|
834
|
+
* The problem detail.
|
|
835
|
+
* @type {string}
|
|
836
|
+
* @memberof ErrorResponse
|
|
837
|
+
*/
|
|
838
|
+
'detail'?: string;
|
|
839
|
+
/**
|
|
840
|
+
* The request path.
|
|
841
|
+
* @type {string}
|
|
842
|
+
* @memberof ErrorResponse
|
|
843
|
+
*/
|
|
844
|
+
'instance'?: string;
|
|
845
|
+
/**
|
|
846
|
+
* Unique error identifier.
|
|
847
|
+
* @type {string}
|
|
848
|
+
* @memberof ErrorResponse
|
|
849
|
+
*/
|
|
850
|
+
'id'?: string;
|
|
851
|
+
/**
|
|
852
|
+
* Date-time when error occurred.
|
|
853
|
+
* @type {string}
|
|
854
|
+
* @memberof ErrorResponse
|
|
855
|
+
*/
|
|
856
|
+
'timestamp'?: string;
|
|
857
|
+
}
|
|
858
|
+
/**
|
|
859
|
+
*
|
|
860
|
+
* @export
|
|
861
|
+
* @interface MainCard
|
|
862
|
+
*/
|
|
863
|
+
export interface MainCard {
|
|
864
|
+
/**
|
|
865
|
+
*
|
|
866
|
+
* @type {MultiApplicationProperties}
|
|
867
|
+
* @memberof MainCard
|
|
868
|
+
*/
|
|
869
|
+
'multiApplicationProperties'?: MultiApplicationProperties;
|
|
870
|
+
/**
|
|
871
|
+
* The program id that you want to associate with the new card you are creating.
|
|
872
|
+
* @type {string}
|
|
873
|
+
* @memberof MainCard
|
|
874
|
+
*/
|
|
875
|
+
'programId': string;
|
|
876
|
+
/**
|
|
877
|
+
* A unique code to identify the card configuration. Max character limit is 36.
|
|
878
|
+
* @type {string}
|
|
879
|
+
* @memberof MainCard
|
|
880
|
+
*/
|
|
881
|
+
'cardConfigurationCode': string;
|
|
882
|
+
/**
|
|
883
|
+
*
|
|
884
|
+
* @type {CreatePinStatus}
|
|
885
|
+
* @memberof MainCard
|
|
886
|
+
*/
|
|
887
|
+
'pinStatus'?: CreatePinStatus;
|
|
888
|
+
/**
|
|
889
|
+
* Unique identifier of the cardholder associated with the new card.
|
|
890
|
+
* @type {string}
|
|
891
|
+
* @memberof MainCard
|
|
892
|
+
*/
|
|
893
|
+
'cardholderId'?: string;
|
|
894
|
+
/**
|
|
895
|
+
* The expiration date-time of the card in UTC format. The time must be a value in te future.
|
|
896
|
+
* @type {string}
|
|
897
|
+
* @memberof MainCard
|
|
898
|
+
*/
|
|
899
|
+
'expirationTime'?: string;
|
|
900
|
+
/**
|
|
901
|
+
* Unique identifier of the account associated with the new card.
|
|
902
|
+
* @type {string}
|
|
903
|
+
* @memberof MainCard
|
|
904
|
+
*/
|
|
905
|
+
'accountId': string;
|
|
906
|
+
/**
|
|
907
|
+
*
|
|
908
|
+
* @type {CreatePlasticBody}
|
|
909
|
+
* @memberof MainCard
|
|
910
|
+
*/
|
|
911
|
+
'plastic'?: CreatePlasticBody;
|
|
912
|
+
/**
|
|
913
|
+
* A flag indicating whether automatic renewal is enabled or not.
|
|
914
|
+
* @type {boolean}
|
|
915
|
+
* @memberof MainCard
|
|
916
|
+
*/
|
|
917
|
+
'automaticRenewal'?: boolean;
|
|
918
|
+
/**
|
|
919
|
+
* The digital layout code for the card. Max character limit is 36.
|
|
920
|
+
* @type {string}
|
|
921
|
+
* @memberof MainCard
|
|
922
|
+
*/
|
|
923
|
+
'digitalLayoutCode'?: string;
|
|
924
|
+
/**
|
|
925
|
+
* You can include up to **30 additional key-value pairs** in the embossing file sent to the card manufacturer. - **Keys** must follow the pattern: `^[a-zA-Z0-9-]{1,36}$` (only letters, numbers, and hyphens, with a maximum length of 36 characters). - **Values** must follow the pattern: `^[a-zA-Z0-9|\\-_ +.@éàèùçâêîôûëïü\'/=]{1,1000}$`. Enfuce **does not perform any additional validation** on these key-value pairs beyond ensuring they match the specified patterns. These fields are intended for **storing data without further processing**. If you need to store a **complex structure**, you can **base64 encode** the value. The encoded value will be passed as entered, without modifications. ⚠ **Important:** Any usage of these fields should be agreed upon with the manufacturer.
|
|
926
|
+
* @type {{ [key: string]: string; }}
|
|
927
|
+
* @memberof MainCard
|
|
928
|
+
*/
|
|
929
|
+
'additionalValues'?: {
|
|
930
|
+
[key: string]: string;
|
|
931
|
+
};
|
|
932
|
+
/**
|
|
933
|
+
* Unique identifier of a fee configuration. When provided, this value overrides the program default. This feature must be enabled for the tenant; otherwise, this field can be left null and will not be used.
|
|
934
|
+
* @type {string}
|
|
935
|
+
* @memberof MainCard
|
|
936
|
+
*/
|
|
937
|
+
'feeConfigId'?: string;
|
|
938
|
+
}
|
|
939
|
+
/**
|
|
940
|
+
* Reason for manufacturing the card.
|
|
941
|
+
* @export
|
|
942
|
+
* @enum {string}
|
|
943
|
+
*/
|
|
944
|
+
export declare const ManufacturingReason: {
|
|
945
|
+
readonly NewCard: "NEW_CARD";
|
|
946
|
+
readonly ReplaceCard: "REPLACE_CARD";
|
|
947
|
+
readonly ReissueCard: "REISSUE_CARD";
|
|
948
|
+
readonly ReorderPin: "REORDER_PIN";
|
|
949
|
+
readonly RenewCard: "RENEW_CARD";
|
|
950
|
+
};
|
|
951
|
+
export type ManufacturingReason = typeof ManufacturingReason[keyof typeof ManufacturingReason];
|
|
952
|
+
/**
|
|
953
|
+
* - AWAITING_CRYPTO_VALUES - The card is created and is awaiting to receive cryptographic values before being sent to the card manufacturer. - CRYPTO_VALUES_PROCESSED - The card is awaiting to be included in the next embossing file. - SENT_TO_MANUFACTURER - The card has been successfully processed and sent to the manufacturer. - MANUFACTURING_ABORTED - The manufacturing process is aborted.
|
|
954
|
+
* @export
|
|
955
|
+
* @enum {string}
|
|
956
|
+
*/
|
|
957
|
+
export declare const ManufacturingStatus: {
|
|
958
|
+
readonly AwaitingCryptoValues: "AWAITING_CRYPTO_VALUES";
|
|
959
|
+
readonly CryptoValuesProcessed: "CRYPTO_VALUES_PROCESSED";
|
|
960
|
+
readonly SentToManufacturer: "SENT_TO_MANUFACTURER";
|
|
961
|
+
readonly ManufacturingAborted: "MANUFACTURING_ABORTED";
|
|
962
|
+
};
|
|
963
|
+
export type ManufacturingStatus = typeof ManufacturingStatus[keyof typeof ManufacturingStatus];
|
|
964
|
+
/**
|
|
965
|
+
*
|
|
966
|
+
* @export
|
|
967
|
+
* @interface MultiApplicationProperties
|
|
968
|
+
*/
|
|
969
|
+
export interface MultiApplicationProperties {
|
|
970
|
+
/**
|
|
971
|
+
* Name of the application. Max character limit is 16. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
|
|
972
|
+
* @type {string}
|
|
973
|
+
* @memberof MultiApplicationProperties
|
|
974
|
+
*/
|
|
975
|
+
'applicationName'?: string;
|
|
976
|
+
/**
|
|
977
|
+
* The index of the application
|
|
978
|
+
* @type {number}
|
|
979
|
+
* @memberof MultiApplicationProperties
|
|
980
|
+
*/
|
|
981
|
+
'applicationIndex'?: number;
|
|
982
|
+
/**
|
|
983
|
+
* The contact priority level for given card. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
|
|
984
|
+
* @type {number}
|
|
985
|
+
* @memberof MultiApplicationProperties
|
|
986
|
+
*/
|
|
987
|
+
'contactPriorityLevel'?: number;
|
|
988
|
+
/**
|
|
989
|
+
* The contactless priority level of the given card. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
|
|
990
|
+
* @type {number}
|
|
991
|
+
* @memberof MultiApplicationProperties
|
|
992
|
+
*/
|
|
993
|
+
'contactlessPriorityLevel'?: number;
|
|
994
|
+
/**
|
|
995
|
+
* Indicates whether the specific card would be printed or not. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
|
|
996
|
+
* @type {boolean}
|
|
997
|
+
* @memberof MultiApplicationProperties
|
|
998
|
+
*/
|
|
999
|
+
'printed'?: boolean;
|
|
1000
|
+
/**
|
|
1001
|
+
* Whether the card should be visible in card terminal or not. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
|
|
1002
|
+
* @type {boolean}
|
|
1003
|
+
* @memberof MultiApplicationProperties
|
|
1004
|
+
*/
|
|
1005
|
+
'chipEnabled'?: boolean;
|
|
1006
|
+
}
|
|
1007
|
+
/**
|
|
1008
|
+
*
|
|
1009
|
+
* @export
|
|
1010
|
+
* @interface PinControlInfoRequestBody
|
|
1011
|
+
*/
|
|
1012
|
+
export interface PinControlInfoRequestBody {
|
|
1013
|
+
/**
|
|
1014
|
+
*
|
|
1015
|
+
* @type {PinScope}
|
|
1016
|
+
* @memberof PinControlInfoRequestBody
|
|
1017
|
+
*/
|
|
1018
|
+
'scope': PinScope;
|
|
1019
|
+
/**
|
|
1020
|
+
* The sequence number of the card version, this value is also known as PSN (pan sequence number)
|
|
1021
|
+
* @type {number}
|
|
1022
|
+
* @memberof PinControlInfoRequestBody
|
|
1023
|
+
*/
|
|
1024
|
+
'sequenceNumber'?: number;
|
|
1025
|
+
}
|
|
1026
|
+
/**
|
|
1027
|
+
*
|
|
1028
|
+
* @export
|
|
1029
|
+
* @interface PinControlInfoResponseBody
|
|
1030
|
+
*/
|
|
1031
|
+
export interface PinControlInfoResponseBody {
|
|
1032
|
+
/**
|
|
1033
|
+
* The ID of this PIN Control access token.
|
|
1034
|
+
* @type {string}
|
|
1035
|
+
* @memberof PinControlInfoResponseBody
|
|
1036
|
+
*/
|
|
1037
|
+
'id': string;
|
|
1038
|
+
/**
|
|
1039
|
+
* The URL that the cardholder\'s mobile device webview should browse to for accessing the PIN.
|
|
1040
|
+
* @type {string}
|
|
1041
|
+
* @memberof PinControlInfoResponseBody
|
|
1042
|
+
*/
|
|
1043
|
+
'pinUrl'?: string;
|
|
1044
|
+
/**
|
|
1045
|
+
* The URL of the iframe for desktop browser based flows for accessing PIN.
|
|
1046
|
+
* @type {string}
|
|
1047
|
+
* @memberof PinControlInfoResponseBody
|
|
1048
|
+
*/
|
|
1049
|
+
'pinFrameUrl'?: string;
|
|
1050
|
+
}
|
|
1051
|
+
/**
|
|
1052
|
+
* Select the type of delivery you prefer for sending the card PIN. - MAIL - The card PIN would be sent via mail services. - COURIER - The card PIN would be sent via courier services. - EPIN - The card PIN would be sent digitally.
|
|
1053
|
+
* @export
|
|
1054
|
+
* @enum {string}
|
|
1055
|
+
*/
|
|
1056
|
+
export declare const PinDeliveryType: {
|
|
1057
|
+
readonly Mail: "MAIL";
|
|
1058
|
+
readonly Courier: "COURIER";
|
|
1059
|
+
readonly Epin: "EPIN";
|
|
1060
|
+
};
|
|
1061
|
+
export type PinDeliveryType = typeof PinDeliveryType[keyof typeof PinDeliveryType];
|
|
1062
|
+
/**
|
|
1063
|
+
* Describes the scope of the operation authorised by the user.
|
|
1064
|
+
* @export
|
|
1065
|
+
* @enum {string}
|
|
1066
|
+
*/
|
|
1067
|
+
export declare const PinScope: {
|
|
1068
|
+
readonly ViewPin: "VIEW_PIN";
|
|
1069
|
+
readonly SetPin: "SET_PIN";
|
|
1070
|
+
readonly ChangePin: "CHANGE_PIN";
|
|
1071
|
+
};
|
|
1072
|
+
export type PinScope = typeof PinScope[keyof typeof PinScope];
|
|
1073
|
+
/**
|
|
1074
|
+
* - GENERATED - A pin has been randomly generated for the card. - WAITING - A pin is waiting to be set on the card. - SET - A pin has been manually set on the card. - INHERITED - For card applications only. The pin status is inherited from the main card.
|
|
1075
|
+
* @export
|
|
1076
|
+
* @enum {string}
|
|
1077
|
+
*/
|
|
1078
|
+
export declare const PinStatus: {
|
|
1079
|
+
readonly Generated: "GENERATED";
|
|
1080
|
+
readonly Waiting: "WAITING";
|
|
1081
|
+
readonly Set: "SET";
|
|
1082
|
+
readonly Inherited: "INHERITED";
|
|
1083
|
+
};
|
|
1084
|
+
export type PinStatus = typeof PinStatus[keyof typeof PinStatus];
|
|
1085
|
+
/**
|
|
1086
|
+
*
|
|
1087
|
+
* @export
|
|
1088
|
+
* @interface Plastic
|
|
1089
|
+
*/
|
|
1090
|
+
export interface Plastic {
|
|
1091
|
+
/**
|
|
1092
|
+
* The name to be embossed on the card. Max character limit is 26.
|
|
1093
|
+
* @type {string}
|
|
1094
|
+
* @memberof Plastic
|
|
1095
|
+
*/
|
|
1096
|
+
'embossingName'?: string;
|
|
1097
|
+
/**
|
|
1098
|
+
*
|
|
1099
|
+
* @type {Address}
|
|
1100
|
+
* @memberof Plastic
|
|
1101
|
+
*/
|
|
1102
|
+
'preferredCardAddress'?: Address;
|
|
1103
|
+
/**
|
|
1104
|
+
*
|
|
1105
|
+
* @type {CardDeliveryType}
|
|
1106
|
+
* @memberof Plastic
|
|
1107
|
+
*/
|
|
1108
|
+
'preferredCardDeliveryType': CardDeliveryType;
|
|
1109
|
+
/**
|
|
1110
|
+
*
|
|
1111
|
+
* @type {Address}
|
|
1112
|
+
* @memberof Plastic
|
|
1113
|
+
*/
|
|
1114
|
+
'preferredPinAddress'?: Address;
|
|
1115
|
+
/**
|
|
1116
|
+
*
|
|
1117
|
+
* @type {PinDeliveryType}
|
|
1118
|
+
* @memberof Plastic
|
|
1119
|
+
*/
|
|
1120
|
+
'preferredPinDeliveryType': PinDeliveryType;
|
|
1121
|
+
/**
|
|
1122
|
+
* Unique identifier of a resource.
|
|
1123
|
+
* @type {string}
|
|
1124
|
+
* @memberof Plastic
|
|
1125
|
+
*/
|
|
1126
|
+
'manufacturerId'?: string;
|
|
1127
|
+
/**
|
|
1128
|
+
* Unique code forwarded to the embossing house; the code identifies the plastic layout to be used for printing the new card. Ensure beforehand, the selected embossing house is aligned with the code used for each layout.
|
|
1129
|
+
* @type {string}
|
|
1130
|
+
* @memberof Plastic
|
|
1131
|
+
*/
|
|
1132
|
+
'externalLayoutCode'?: string;
|
|
1133
|
+
/**
|
|
1134
|
+
* The date and time when the card was created.
|
|
1135
|
+
* @type {string}
|
|
1136
|
+
* @memberof Plastic
|
|
1137
|
+
*/
|
|
1138
|
+
'createdAt'?: string;
|
|
1139
|
+
/**
|
|
1140
|
+
* The date and time when the object/entity was updated last time.
|
|
1141
|
+
* @type {string}
|
|
1142
|
+
* @memberof Plastic
|
|
1143
|
+
*/
|
|
1144
|
+
'updatedAt'?: string;
|
|
1145
|
+
}
|
|
1146
|
+
/**
|
|
1147
|
+
*
|
|
1148
|
+
* @export
|
|
1149
|
+
* @interface PlasticManufacturingHistoryResponse
|
|
1150
|
+
*/
|
|
1151
|
+
export interface PlasticManufacturingHistoryResponse {
|
|
1152
|
+
/**
|
|
1153
|
+
*
|
|
1154
|
+
* @type {Array<PlasticManufacturingHistoryResponseManufacturingEntriesInner>}
|
|
1155
|
+
* @memberof PlasticManufacturingHistoryResponse
|
|
1156
|
+
*/
|
|
1157
|
+
'manufacturingEntries'?: Array<PlasticManufacturingHistoryResponseManufacturingEntriesInner>;
|
|
1158
|
+
}
|
|
1159
|
+
/**
|
|
1160
|
+
*
|
|
1161
|
+
* @export
|
|
1162
|
+
* @interface PlasticManufacturingHistoryResponseManufacturingEntriesInner
|
|
1163
|
+
*/
|
|
1164
|
+
export interface PlasticManufacturingHistoryResponseManufacturingEntriesInner {
|
|
1165
|
+
/**
|
|
1166
|
+
* Unique identifer of a manufacturing request.
|
|
1167
|
+
* @type {string}
|
|
1168
|
+
* @memberof PlasticManufacturingHistoryResponseManufacturingEntriesInner
|
|
1169
|
+
*/
|
|
1170
|
+
'id'?: string;
|
|
1171
|
+
/**
|
|
1172
|
+
* The date and time when the card was created.
|
|
1173
|
+
* @type {string}
|
|
1174
|
+
* @memberof PlasticManufacturingHistoryResponseManufacturingEntriesInner
|
|
1175
|
+
*/
|
|
1176
|
+
'createdAt'?: string;
|
|
1177
|
+
/**
|
|
1178
|
+
* The date and time when the card was sent to the manufacturer
|
|
1179
|
+
* @type {string}
|
|
1180
|
+
* @memberof PlasticManufacturingHistoryResponseManufacturingEntriesInner
|
|
1181
|
+
*/
|
|
1182
|
+
'sentToManufacturerAt'?: string;
|
|
1183
|
+
/**
|
|
1184
|
+
* Unique identifier of the manufacturer to whom the the card data wants sent for printing the physical card.
|
|
1185
|
+
* @type {string}
|
|
1186
|
+
* @memberof PlasticManufacturingHistoryResponseManufacturingEntriesInner
|
|
1187
|
+
*/
|
|
1188
|
+
'manufacturerId'?: string;
|
|
1189
|
+
/**
|
|
1190
|
+
* The sequence number of the card version, this value is also known as PSN (pan sequence number)
|
|
1191
|
+
* @type {number}
|
|
1192
|
+
* @memberof PlasticManufacturingHistoryResponseManufacturingEntriesInner
|
|
1193
|
+
*/
|
|
1194
|
+
'cardVersionSequenceNumber'?: number;
|
|
1195
|
+
/**
|
|
1196
|
+
*
|
|
1197
|
+
* @type {ManufacturingReason}
|
|
1198
|
+
* @memberof PlasticManufacturingHistoryResponseManufacturingEntriesInner
|
|
1199
|
+
*/
|
|
1200
|
+
'manufacturingReason'?: ManufacturingReason;
|
|
1201
|
+
/**
|
|
1202
|
+
*
|
|
1203
|
+
* @type {ManufacturingStatus}
|
|
1204
|
+
* @memberof PlasticManufacturingHistoryResponseManufacturingEntriesInner
|
|
1205
|
+
*/
|
|
1206
|
+
'status'?: ManufacturingStatus;
|
|
1207
|
+
/**
|
|
1208
|
+
* The json data that was included in the plastic manufacturer file
|
|
1209
|
+
* @type {string}
|
|
1210
|
+
* @memberof PlasticManufacturingHistoryResponseManufacturingEntriesInner
|
|
1211
|
+
*/
|
|
1212
|
+
'data'?: string;
|
|
1213
|
+
}
|
|
1214
|
+
/**
|
|
1215
|
+
*
|
|
1216
|
+
* @export
|
|
1217
|
+
* @interface ReissueCardBody
|
|
1218
|
+
*/
|
|
1219
|
+
export interface ReissueCardBody {
|
|
1220
|
+
/**
|
|
1221
|
+
*
|
|
1222
|
+
* @type {ChangePinStatus}
|
|
1223
|
+
* @memberof ReissueCardBody
|
|
1224
|
+
*/
|
|
1225
|
+
'pinStatus'?: ChangePinStatus;
|
|
1226
|
+
}
|
|
1227
|
+
/**
|
|
1228
|
+
*
|
|
1229
|
+
* @export
|
|
1230
|
+
* @interface ReplaceCardBody
|
|
1231
|
+
*/
|
|
1232
|
+
export interface ReplaceCardBody {
|
|
1233
|
+
/**
|
|
1234
|
+
* Description of why the card should be replaced.
|
|
1235
|
+
* @type {string}
|
|
1236
|
+
* @memberof ReplaceCardBody
|
|
1237
|
+
*/
|
|
1238
|
+
'description'?: string;
|
|
1239
|
+
/**
|
|
1240
|
+
*
|
|
1241
|
+
* @type {ChangePinStatus}
|
|
1242
|
+
* @memberof ReplaceCardBody
|
|
1243
|
+
*/
|
|
1244
|
+
'pinStatus'?: ChangePinStatus;
|
|
1245
|
+
}
|
|
1246
|
+
/**
|
|
1247
|
+
*
|
|
1248
|
+
* @export
|
|
1249
|
+
* @interface ResourceResponse
|
|
1250
|
+
*/
|
|
1251
|
+
export interface ResourceResponse {
|
|
1252
|
+
/**
|
|
1253
|
+
* A description of the response returned.
|
|
1254
|
+
* @type {string}
|
|
1255
|
+
* @memberof ResourceResponse
|
|
1256
|
+
*/
|
|
1257
|
+
'description'?: string;
|
|
1258
|
+
/**
|
|
1259
|
+
* A unique identifier assigned to identify the endpoint request.
|
|
1260
|
+
* @type {string}
|
|
1261
|
+
* @memberof ResourceResponse
|
|
1262
|
+
*/
|
|
1263
|
+
'id'?: string;
|
|
1264
|
+
}
|
|
1265
|
+
/**
|
|
1266
|
+
*
|
|
1267
|
+
* @export
|
|
1268
|
+
* @interface UpdateCardBody
|
|
1269
|
+
*/
|
|
1270
|
+
export interface UpdateCardBody {
|
|
1271
|
+
/**
|
|
1272
|
+
* Whether the card should be visible in card terminal or not. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
|
|
1273
|
+
* @type {boolean}
|
|
1274
|
+
* @memberof UpdateCardBody
|
|
1275
|
+
*/
|
|
1276
|
+
'chipEnabled'?: boolean;
|
|
1277
|
+
/**
|
|
1278
|
+
* The digital layout code for the card. Max character limit is 36.
|
|
1279
|
+
* @type {string}
|
|
1280
|
+
* @memberof UpdateCardBody
|
|
1281
|
+
*/
|
|
1282
|
+
'digitalLayoutCode'?: string;
|
|
1283
|
+
/**
|
|
1284
|
+
* Name of the application. Max character limit is 16. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
|
|
1285
|
+
* @type {string}
|
|
1286
|
+
* @memberof UpdateCardBody
|
|
1287
|
+
*/
|
|
1288
|
+
'applicationName'?: string;
|
|
1289
|
+
/**
|
|
1290
|
+
* The contact priority level for given card. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
|
|
1291
|
+
* @type {number}
|
|
1292
|
+
* @memberof UpdateCardBody
|
|
1293
|
+
*/
|
|
1294
|
+
'contactPriorityLevel'?: number;
|
|
1295
|
+
/**
|
|
1296
|
+
* The contactless priority level of the given card. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
|
|
1297
|
+
* @type {number}
|
|
1298
|
+
* @memberof UpdateCardBody
|
|
1299
|
+
*/
|
|
1300
|
+
'contactlessPriorityLevel'?: number;
|
|
1301
|
+
/**
|
|
1302
|
+
* Indicates whether the specific card would be printed or not. Only applicable to multi-application cards. Otherwise, the request will return 400 Bad Request.
|
|
1303
|
+
* @type {boolean}
|
|
1304
|
+
* @memberof UpdateCardBody
|
|
1305
|
+
*/
|
|
1306
|
+
'printed'?: boolean;
|
|
1307
|
+
/**
|
|
1308
|
+
* Unique identifier of a resource.
|
|
1309
|
+
* @type {string}
|
|
1310
|
+
* @memberof UpdateCardBody
|
|
1311
|
+
*/
|
|
1312
|
+
'cardholderId'?: string;
|
|
1313
|
+
/**
|
|
1314
|
+
* Unique identifier of an account.
|
|
1315
|
+
* @type {string}
|
|
1316
|
+
* @memberof UpdateCardBody
|
|
1317
|
+
*/
|
|
1318
|
+
'accountId'?: string;
|
|
1319
|
+
/**
|
|
1320
|
+
* A flag indicating whether automatic renewal is enabled or not.
|
|
1321
|
+
* @type {boolean}
|
|
1322
|
+
* @memberof UpdateCardBody
|
|
1323
|
+
*/
|
|
1324
|
+
'automaticRenewal'?: boolean;
|
|
1325
|
+
/**
|
|
1326
|
+
*
|
|
1327
|
+
* @type {UpdatePlasticBody}
|
|
1328
|
+
* @memberof UpdateCardBody
|
|
1329
|
+
*/
|
|
1330
|
+
'plastic'?: UpdatePlasticBody;
|
|
1331
|
+
/**
|
|
1332
|
+
*
|
|
1333
|
+
* @type {CardStatus}
|
|
1334
|
+
* @memberof UpdateCardBody
|
|
1335
|
+
*/
|
|
1336
|
+
'cardStatus'?: CardStatus;
|
|
1337
|
+
/**
|
|
1338
|
+
* If set to true, the card status change will impact the status of all tokens. If set to false, the card status change will not impact the status of all tokens.
|
|
1339
|
+
* @type {boolean}
|
|
1340
|
+
* @memberof UpdateCardBody
|
|
1341
|
+
*/
|
|
1342
|
+
'impactTokenStatus'?: boolean;
|
|
1343
|
+
/**
|
|
1344
|
+
*
|
|
1345
|
+
* @type {UpdatePinStatus}
|
|
1346
|
+
* @memberof UpdateCardBody
|
|
1347
|
+
*/
|
|
1348
|
+
'pinStatus'?: UpdatePinStatus;
|
|
1349
|
+
/**
|
|
1350
|
+
* You can include up to **30 additional key-value pairs** in the embossing file sent to the card manufacturer. - **Keys** must follow the pattern: `^[a-zA-Z0-9-]{1,36}$` (only letters, numbers, and hyphens, with a maximum length of 36 characters). - **Values** must follow the pattern: `^[a-zA-Z0-9|\\-_ +.@éàèùçâêîôûëïü\'/=]{1,1000}$`. Enfuce **does not perform any additional validation** on these key-value pairs beyond ensuring they match the specified patterns. These fields are intended for **storing data without further processing**. If you need to store a **complex structure**, you can **base64 encode** the value. The encoded value will be passed as entered, without modifications. ⚠ **Important:** Any usage of these fields should be agreed upon with the manufacturer.
|
|
1351
|
+
* @type {{ [key: string]: string; }}
|
|
1352
|
+
* @memberof UpdateCardBody
|
|
1353
|
+
*/
|
|
1354
|
+
'additionalValues'?: {
|
|
1355
|
+
[key: string]: string;
|
|
1356
|
+
};
|
|
1357
|
+
/**
|
|
1358
|
+
* Unique identifier of a fee configuration. When provided, this value overrides the program default. This feature must be enabled for the tenant; otherwise, this field can be left null and will not be used.
|
|
1359
|
+
* @type {string}
|
|
1360
|
+
* @memberof UpdateCardBody
|
|
1361
|
+
*/
|
|
1362
|
+
'feeConfigId'?: string | null;
|
|
1363
|
+
}
|
|
1364
|
+
/**
|
|
1365
|
+
* - GENERATED - A pin should be randomly generated for the card.
|
|
1366
|
+
* @export
|
|
1367
|
+
* @enum {string}
|
|
1368
|
+
*/
|
|
1369
|
+
export declare const UpdatePinStatus: {
|
|
1370
|
+
readonly Generated: "GENERATED";
|
|
1371
|
+
};
|
|
1372
|
+
export type UpdatePinStatus = typeof UpdatePinStatus[keyof typeof UpdatePinStatus];
|
|
1373
|
+
/**
|
|
1374
|
+
*
|
|
1375
|
+
* @export
|
|
1376
|
+
* @interface UpdatePlasticBody
|
|
1377
|
+
*/
|
|
1378
|
+
export interface UpdatePlasticBody {
|
|
1379
|
+
/**
|
|
1380
|
+
* The name to be embossed on the card. Max character limit is 26.
|
|
1381
|
+
* @type {string}
|
|
1382
|
+
* @memberof UpdatePlasticBody
|
|
1383
|
+
*/
|
|
1384
|
+
'embossingName'?: string;
|
|
1385
|
+
/**
|
|
1386
|
+
*
|
|
1387
|
+
* @type {Address}
|
|
1388
|
+
* @memberof UpdatePlasticBody
|
|
1389
|
+
*/
|
|
1390
|
+
'preferredCardAddress'?: Address;
|
|
1391
|
+
/**
|
|
1392
|
+
*
|
|
1393
|
+
* @type {CardDeliveryType}
|
|
1394
|
+
* @memberof UpdatePlasticBody
|
|
1395
|
+
*/
|
|
1396
|
+
'preferredCardDeliveryType'?: CardDeliveryType;
|
|
1397
|
+
/**
|
|
1398
|
+
*
|
|
1399
|
+
* @type {Address}
|
|
1400
|
+
* @memberof UpdatePlasticBody
|
|
1401
|
+
*/
|
|
1402
|
+
'preferredPinAddress'?: Address;
|
|
1403
|
+
/**
|
|
1404
|
+
*
|
|
1405
|
+
* @type {PinDeliveryType}
|
|
1406
|
+
* @memberof UpdatePlasticBody
|
|
1407
|
+
*/
|
|
1408
|
+
'preferredPinDeliveryType'?: PinDeliveryType;
|
|
1409
|
+
/**
|
|
1410
|
+
* Unique identifier of an entity.
|
|
1411
|
+
* @type {string}
|
|
1412
|
+
* @memberof UpdatePlasticBody
|
|
1413
|
+
*/
|
|
1414
|
+
'manufacturerId'?: string | null;
|
|
1415
|
+
/**
|
|
1416
|
+
* Unique code forwarded to the embossing house; the code identifies the plastic layout to be used for printing the new card. Ensure beforehand, the selected embossing house is aligned with the code used for each layout.
|
|
1417
|
+
* @type {string}
|
|
1418
|
+
* @memberof UpdatePlasticBody
|
|
1419
|
+
*/
|
|
1420
|
+
'externalLayoutCode'?: string;
|
|
1421
|
+
}
|
|
1422
|
+
/**
|
|
1423
|
+
* CreateCardApi - axios parameter creator
|
|
1424
|
+
* @export
|
|
1425
|
+
*/
|
|
1426
|
+
export declare const CreateCardApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1427
|
+
/**
|
|
1428
|
+
* Send a request to this endpoint to create a new card.
|
|
1429
|
+
* @summary Create Card
|
|
1430
|
+
* @param {CreateCardRequest} createCardRequest
|
|
1431
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1432
|
+
* @param {string} [xIdempotencyKey] Idempotency key for the request.
|
|
1433
|
+
* @param {*} [options] Override http request option.
|
|
1434
|
+
* @throws {RequiredError}
|
|
1435
|
+
*/
|
|
1436
|
+
createCard: (createCardRequest: CreateCardRequest, xAuditUser?: string, xIdempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1437
|
+
};
|
|
1438
|
+
/**
|
|
1439
|
+
* CreateCardApi - functional programming interface
|
|
1440
|
+
* @export
|
|
1441
|
+
*/
|
|
1442
|
+
export declare const CreateCardApiFp: (configuration?: Configuration) => {
|
|
1443
|
+
/**
|
|
1444
|
+
* Send a request to this endpoint to create a new card.
|
|
1445
|
+
* @summary Create Card
|
|
1446
|
+
* @param {CreateCardRequest} createCardRequest
|
|
1447
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1448
|
+
* @param {string} [xIdempotencyKey] Idempotency key for the request.
|
|
1449
|
+
* @param {*} [options] Override http request option.
|
|
1450
|
+
* @throws {RequiredError}
|
|
1451
|
+
*/
|
|
1452
|
+
createCard(createCardRequest: CreateCardRequest, xAuditUser?: string, xIdempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCard201Response>>;
|
|
1453
|
+
};
|
|
1454
|
+
/**
|
|
1455
|
+
* CreateCardApi - factory interface
|
|
1456
|
+
* @export
|
|
1457
|
+
*/
|
|
1458
|
+
export declare const CreateCardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1459
|
+
/**
|
|
1460
|
+
* Send a request to this endpoint to create a new card.
|
|
1461
|
+
* @summary Create Card
|
|
1462
|
+
* @param {CreateCardRequest} createCardRequest
|
|
1463
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1464
|
+
* @param {string} [xIdempotencyKey] Idempotency key for the request.
|
|
1465
|
+
* @param {*} [options] Override http request option.
|
|
1466
|
+
* @throws {RequiredError}
|
|
1467
|
+
*/
|
|
1468
|
+
createCard(createCardRequest: CreateCardRequest, xAuditUser?: string, xIdempotencyKey?: string, options?: RawAxiosRequestConfig): AxiosPromise<CreateCard201Response>;
|
|
1469
|
+
};
|
|
1470
|
+
/**
|
|
1471
|
+
* CreateCardApi - object-oriented interface
|
|
1472
|
+
* @export
|
|
1473
|
+
* @class CreateCardApi
|
|
1474
|
+
* @extends {BaseAPI}
|
|
1475
|
+
*/
|
|
1476
|
+
export declare class CreateCardApi extends BaseAPI {
|
|
1477
|
+
/**
|
|
1478
|
+
* Send a request to this endpoint to create a new card.
|
|
1479
|
+
* @summary Create Card
|
|
1480
|
+
* @param {CreateCardRequest} createCardRequest
|
|
1481
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1482
|
+
* @param {string} [xIdempotencyKey] Idempotency key for the request.
|
|
1483
|
+
* @param {*} [options] Override http request option.
|
|
1484
|
+
* @throws {RequiredError}
|
|
1485
|
+
* @memberof CreateCardApi
|
|
1486
|
+
*/
|
|
1487
|
+
createCard(createCardRequest: CreateCardRequest, xAuditUser?: string, xIdempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCard201Response, any, {}>>;
|
|
1488
|
+
}
|
|
1489
|
+
/**
|
|
1490
|
+
* CreatePINControlAccessTokenApi - axios parameter creator
|
|
1491
|
+
* @export
|
|
1492
|
+
*/
|
|
1493
|
+
export declare const CreatePINControlAccessTokenApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1494
|
+
/**
|
|
1495
|
+
* Send a request to this endpoint to generate a PIN control access token for a specific card version. The requested `scope` determines which PIN operation the token authorises: `VIEW_PIN`, `SET_PIN` or `CHANGE_PIN`. If no `sequenceNumber` is provided, the latest card version is used. A successful response returns the token `id`, a `pinUrl` for the mobile device webview and a `pinFrameUrl` for the desktop browser iframe. Both URLs are specific to the requested `scope`. The token is valid for 30 seconds. For the mobile webview flow, the device sends another API request — a `POST` to the `pinUrl`, including the token `id` in a parameter named `controlId`. For the desktop browser flow, open an iframe to the `pinFrameUrl`. After the iframe has loaded, the browser makes a `window.postMessage()` call to the iframe. The message object contains an `operation` field (`view-pin` for the `VIEW_PIN` scope, `set-pin` for the `SET_PIN` and `CHANGE_PIN` scopes) and a `controlId` field (the token `id`). Note that you must use `set-pin` as the `operation` for the `CHANGE_PIN` scope as well.
|
|
1496
|
+
* @summary Request PIN Control Access Token
|
|
1497
|
+
* @param {string} id Unique identifier of the card for which you want to access the PIN.
|
|
1498
|
+
* @param {PinControlInfoRequestBody} pinControlInfoRequestBody
|
|
1499
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1500
|
+
* @param {*} [options] Override http request option.
|
|
1501
|
+
* @throws {RequiredError}
|
|
1502
|
+
*/
|
|
1503
|
+
createPinControl: (id: string, pinControlInfoRequestBody: PinControlInfoRequestBody, xAuditUser?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1504
|
+
};
|
|
1505
|
+
/**
|
|
1506
|
+
* CreatePINControlAccessTokenApi - functional programming interface
|
|
1507
|
+
* @export
|
|
1508
|
+
*/
|
|
1509
|
+
export declare const CreatePINControlAccessTokenApiFp: (configuration?: Configuration) => {
|
|
1510
|
+
/**
|
|
1511
|
+
* Send a request to this endpoint to generate a PIN control access token for a specific card version. The requested `scope` determines which PIN operation the token authorises: `VIEW_PIN`, `SET_PIN` or `CHANGE_PIN`. If no `sequenceNumber` is provided, the latest card version is used. A successful response returns the token `id`, a `pinUrl` for the mobile device webview and a `pinFrameUrl` for the desktop browser iframe. Both URLs are specific to the requested `scope`. The token is valid for 30 seconds. For the mobile webview flow, the device sends another API request — a `POST` to the `pinUrl`, including the token `id` in a parameter named `controlId`. For the desktop browser flow, open an iframe to the `pinFrameUrl`. After the iframe has loaded, the browser makes a `window.postMessage()` call to the iframe. The message object contains an `operation` field (`view-pin` for the `VIEW_PIN` scope, `set-pin` for the `SET_PIN` and `CHANGE_PIN` scopes) and a `controlId` field (the token `id`). Note that you must use `set-pin` as the `operation` for the `CHANGE_PIN` scope as well.
|
|
1512
|
+
* @summary Request PIN Control Access Token
|
|
1513
|
+
* @param {string} id Unique identifier of the card for which you want to access the PIN.
|
|
1514
|
+
* @param {PinControlInfoRequestBody} pinControlInfoRequestBody
|
|
1515
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1516
|
+
* @param {*} [options] Override http request option.
|
|
1517
|
+
* @throws {RequiredError}
|
|
1518
|
+
*/
|
|
1519
|
+
createPinControl(id: string, pinControlInfoRequestBody: PinControlInfoRequestBody, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PinControlInfoResponseBody>>;
|
|
1520
|
+
};
|
|
1521
|
+
/**
|
|
1522
|
+
* CreatePINControlAccessTokenApi - factory interface
|
|
1523
|
+
* @export
|
|
1524
|
+
*/
|
|
1525
|
+
export declare const CreatePINControlAccessTokenApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1526
|
+
/**
|
|
1527
|
+
* Send a request to this endpoint to generate a PIN control access token for a specific card version. The requested `scope` determines which PIN operation the token authorises: `VIEW_PIN`, `SET_PIN` or `CHANGE_PIN`. If no `sequenceNumber` is provided, the latest card version is used. A successful response returns the token `id`, a `pinUrl` for the mobile device webview and a `pinFrameUrl` for the desktop browser iframe. Both URLs are specific to the requested `scope`. The token is valid for 30 seconds. For the mobile webview flow, the device sends another API request — a `POST` to the `pinUrl`, including the token `id` in a parameter named `controlId`. For the desktop browser flow, open an iframe to the `pinFrameUrl`. After the iframe has loaded, the browser makes a `window.postMessage()` call to the iframe. The message object contains an `operation` field (`view-pin` for the `VIEW_PIN` scope, `set-pin` for the `SET_PIN` and `CHANGE_PIN` scopes) and a `controlId` field (the token `id`). Note that you must use `set-pin` as the `operation` for the `CHANGE_PIN` scope as well.
|
|
1528
|
+
* @summary Request PIN Control Access Token
|
|
1529
|
+
* @param {string} id Unique identifier of the card for which you want to access the PIN.
|
|
1530
|
+
* @param {PinControlInfoRequestBody} pinControlInfoRequestBody
|
|
1531
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1532
|
+
* @param {*} [options] Override http request option.
|
|
1533
|
+
* @throws {RequiredError}
|
|
1534
|
+
*/
|
|
1535
|
+
createPinControl(id: string, pinControlInfoRequestBody: PinControlInfoRequestBody, xAuditUser?: string, options?: RawAxiosRequestConfig): AxiosPromise<PinControlInfoResponseBody>;
|
|
1536
|
+
};
|
|
1537
|
+
/**
|
|
1538
|
+
* CreatePINControlAccessTokenApi - object-oriented interface
|
|
1539
|
+
* @export
|
|
1540
|
+
* @class CreatePINControlAccessTokenApi
|
|
1541
|
+
* @extends {BaseAPI}
|
|
1542
|
+
*/
|
|
1543
|
+
export declare class CreatePINControlAccessTokenApi extends BaseAPI {
|
|
1544
|
+
/**
|
|
1545
|
+
* Send a request to this endpoint to generate a PIN control access token for a specific card version. The requested `scope` determines which PIN operation the token authorises: `VIEW_PIN`, `SET_PIN` or `CHANGE_PIN`. If no `sequenceNumber` is provided, the latest card version is used. A successful response returns the token `id`, a `pinUrl` for the mobile device webview and a `pinFrameUrl` for the desktop browser iframe. Both URLs are specific to the requested `scope`. The token is valid for 30 seconds. For the mobile webview flow, the device sends another API request — a `POST` to the `pinUrl`, including the token `id` in a parameter named `controlId`. For the desktop browser flow, open an iframe to the `pinFrameUrl`. After the iframe has loaded, the browser makes a `window.postMessage()` call to the iframe. The message object contains an `operation` field (`view-pin` for the `VIEW_PIN` scope, `set-pin` for the `SET_PIN` and `CHANGE_PIN` scopes) and a `controlId` field (the token `id`). Note that you must use `set-pin` as the `operation` for the `CHANGE_PIN` scope as well.
|
|
1546
|
+
* @summary Request PIN Control Access Token
|
|
1547
|
+
* @param {string} id Unique identifier of the card for which you want to access the PIN.
|
|
1548
|
+
* @param {PinControlInfoRequestBody} pinControlInfoRequestBody
|
|
1549
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1550
|
+
* @param {*} [options] Override http request option.
|
|
1551
|
+
* @throws {RequiredError}
|
|
1552
|
+
* @memberof CreatePINControlAccessTokenApi
|
|
1553
|
+
*/
|
|
1554
|
+
createPinControl(id: string, pinControlInfoRequestBody: PinControlInfoRequestBody, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PinControlInfoResponseBody, any, {}>>;
|
|
1555
|
+
}
|
|
1556
|
+
/**
|
|
1557
|
+
* GetCardApi - axios parameter creator
|
|
1558
|
+
* @export
|
|
1559
|
+
*/
|
|
1560
|
+
export declare const GetCardApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1561
|
+
/**
|
|
1562
|
+
*
|
|
1563
|
+
* @summary Get Card
|
|
1564
|
+
* @param {string} id Unique identifier of the card you want to retrieve.
|
|
1565
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1566
|
+
* @param {*} [options] Override http request option.
|
|
1567
|
+
* @throws {RequiredError}
|
|
1568
|
+
*/
|
|
1569
|
+
getCard: (id: string, xAuditUser?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1570
|
+
/**
|
|
1571
|
+
* Send a request to this endpoint when the cardholder wants to retrieve card data, such as PAN, expiry and CVV2/CVC2. If no sequence number is specified, the latest card version is used by default. Only card versions not in CLOSED status are allowed.
|
|
1572
|
+
* @summary Initiate Card Data Retrieval
|
|
1573
|
+
* @param {string} id Unique identifier of the card.
|
|
1574
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1575
|
+
* @param {ControlTokenRequestBody} [controlTokenRequestBody]
|
|
1576
|
+
* @param {*} [options] Override http request option.
|
|
1577
|
+
* @throws {RequiredError}
|
|
1578
|
+
*/
|
|
1579
|
+
getCardDataControlToken: (id: string, xAuditUser?: string, controlTokenRequestBody?: ControlTokenRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1580
|
+
/**
|
|
1581
|
+
* Send a request to this endpoint to return all card applications for a specific main card. If the main card does not exist, an empty array is returned.
|
|
1582
|
+
* @summary Get Card Applications for Main Card
|
|
1583
|
+
* @param {string} mainCardId Unique identifier of the main card for which you want to retrieve the list of card applications.
|
|
1584
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1585
|
+
* @param {*} [options] Override http request option.
|
|
1586
|
+
* @throws {RequiredError}
|
|
1587
|
+
*/
|
|
1588
|
+
getCards: (mainCardId: string, xAuditUser?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1589
|
+
};
|
|
1590
|
+
/**
|
|
1591
|
+
* GetCardApi - functional programming interface
|
|
1592
|
+
* @export
|
|
1593
|
+
*/
|
|
1594
|
+
export declare const GetCardApiFp: (configuration?: Configuration) => {
|
|
1595
|
+
/**
|
|
1596
|
+
*
|
|
1597
|
+
* @summary Get Card
|
|
1598
|
+
* @param {string} id Unique identifier of the card you want to retrieve.
|
|
1599
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1600
|
+
* @param {*} [options] Override http request option.
|
|
1601
|
+
* @throws {RequiredError}
|
|
1602
|
+
*/
|
|
1603
|
+
getCard(id: string, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CardResponse>>;
|
|
1604
|
+
/**
|
|
1605
|
+
* Send a request to this endpoint when the cardholder wants to retrieve card data, such as PAN, expiry and CVV2/CVC2. If no sequence number is specified, the latest card version is used by default. Only card versions not in CLOSED status are allowed.
|
|
1606
|
+
* @summary Initiate Card Data Retrieval
|
|
1607
|
+
* @param {string} id Unique identifier of the card.
|
|
1608
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1609
|
+
* @param {ControlTokenRequestBody} [controlTokenRequestBody]
|
|
1610
|
+
* @param {*} [options] Override http request option.
|
|
1611
|
+
* @throws {RequiredError}
|
|
1612
|
+
*/
|
|
1613
|
+
getCardDataControlToken(id: string, xAuditUser?: string, controlTokenRequestBody?: ControlTokenRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CardDataControlTokenResponseBody>>;
|
|
1614
|
+
/**
|
|
1615
|
+
* Send a request to this endpoint to return all card applications for a specific main card. If the main card does not exist, an empty array is returned.
|
|
1616
|
+
* @summary Get Card Applications for Main Card
|
|
1617
|
+
* @param {string} mainCardId Unique identifier of the main card for which you want to retrieve the list of card applications.
|
|
1618
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1619
|
+
* @param {*} [options] Override http request option.
|
|
1620
|
+
* @throws {RequiredError}
|
|
1621
|
+
*/
|
|
1622
|
+
getCards(mainCardId: string, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CardResponse>>>;
|
|
1623
|
+
};
|
|
1624
|
+
/**
|
|
1625
|
+
* GetCardApi - factory interface
|
|
1626
|
+
* @export
|
|
1627
|
+
*/
|
|
1628
|
+
export declare const GetCardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1629
|
+
/**
|
|
1630
|
+
*
|
|
1631
|
+
* @summary Get Card
|
|
1632
|
+
* @param {string} id Unique identifier of the card you want to retrieve.
|
|
1633
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1634
|
+
* @param {*} [options] Override http request option.
|
|
1635
|
+
* @throws {RequiredError}
|
|
1636
|
+
*/
|
|
1637
|
+
getCard(id: string, xAuditUser?: string, options?: RawAxiosRequestConfig): AxiosPromise<CardResponse>;
|
|
1638
|
+
/**
|
|
1639
|
+
* Send a request to this endpoint when the cardholder wants to retrieve card data, such as PAN, expiry and CVV2/CVC2. If no sequence number is specified, the latest card version is used by default. Only card versions not in CLOSED status are allowed.
|
|
1640
|
+
* @summary Initiate Card Data Retrieval
|
|
1641
|
+
* @param {string} id Unique identifier of the card.
|
|
1642
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1643
|
+
* @param {ControlTokenRequestBody} [controlTokenRequestBody]
|
|
1644
|
+
* @param {*} [options] Override http request option.
|
|
1645
|
+
* @throws {RequiredError}
|
|
1646
|
+
*/
|
|
1647
|
+
getCardDataControlToken(id: string, xAuditUser?: string, controlTokenRequestBody?: ControlTokenRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<CardDataControlTokenResponseBody>;
|
|
1648
|
+
/**
|
|
1649
|
+
* Send a request to this endpoint to return all card applications for a specific main card. If the main card does not exist, an empty array is returned.
|
|
1650
|
+
* @summary Get Card Applications for Main Card
|
|
1651
|
+
* @param {string} mainCardId Unique identifier of the main card for which you want to retrieve the list of card applications.
|
|
1652
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1653
|
+
* @param {*} [options] Override http request option.
|
|
1654
|
+
* @throws {RequiredError}
|
|
1655
|
+
*/
|
|
1656
|
+
getCards(mainCardId: string, xAuditUser?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CardResponse>>;
|
|
1657
|
+
};
|
|
1658
|
+
/**
|
|
1659
|
+
* GetCardApi - object-oriented interface
|
|
1660
|
+
* @export
|
|
1661
|
+
* @class GetCardApi
|
|
1662
|
+
* @extends {BaseAPI}
|
|
1663
|
+
*/
|
|
1664
|
+
export declare class GetCardApi extends BaseAPI {
|
|
1665
|
+
/**
|
|
1666
|
+
*
|
|
1667
|
+
* @summary Get Card
|
|
1668
|
+
* @param {string} id Unique identifier of the card you want to retrieve.
|
|
1669
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1670
|
+
* @param {*} [options] Override http request option.
|
|
1671
|
+
* @throws {RequiredError}
|
|
1672
|
+
* @memberof GetCardApi
|
|
1673
|
+
*/
|
|
1674
|
+
getCard(id: string, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CardResponse, any, {}>>;
|
|
1675
|
+
/**
|
|
1676
|
+
* Send a request to this endpoint when the cardholder wants to retrieve card data, such as PAN, expiry and CVV2/CVC2. If no sequence number is specified, the latest card version is used by default. Only card versions not in CLOSED status are allowed.
|
|
1677
|
+
* @summary Initiate Card Data Retrieval
|
|
1678
|
+
* @param {string} id Unique identifier of the card.
|
|
1679
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1680
|
+
* @param {ControlTokenRequestBody} [controlTokenRequestBody]
|
|
1681
|
+
* @param {*} [options] Override http request option.
|
|
1682
|
+
* @throws {RequiredError}
|
|
1683
|
+
* @memberof GetCardApi
|
|
1684
|
+
*/
|
|
1685
|
+
getCardDataControlToken(id: string, xAuditUser?: string, controlTokenRequestBody?: ControlTokenRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CardDataControlTokenResponseBody, any, {}>>;
|
|
1686
|
+
/**
|
|
1687
|
+
* Send a request to this endpoint to return all card applications for a specific main card. If the main card does not exist, an empty array is returned.
|
|
1688
|
+
* @summary Get Card Applications for Main Card
|
|
1689
|
+
* @param {string} mainCardId Unique identifier of the main card for which you want to retrieve the list of card applications.
|
|
1690
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1691
|
+
* @param {*} [options] Override http request option.
|
|
1692
|
+
* @throws {RequiredError}
|
|
1693
|
+
* @memberof GetCardApi
|
|
1694
|
+
*/
|
|
1695
|
+
getCards(mainCardId: string, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CardResponse[], any, {}>>;
|
|
1696
|
+
}
|
|
1697
|
+
/**
|
|
1698
|
+
* GetCardPaymentInfoApi - axios parameter creator
|
|
1699
|
+
* @export
|
|
1700
|
+
*/
|
|
1701
|
+
export declare const GetCardPaymentInfoApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1702
|
+
/**
|
|
1703
|
+
* This is a web service designed to retrieve the card data required for completing e-commerce payments — PAN, CVC2/CVV2, expiry date of the card can be retrieved. The returned payload is encrypted with an asymmetric public key; this enables end-to-end encryption to the card holder device. The parameters that were included in the request are only returned. The caller is responsible of validating the integrity of the public key. <Note><ul><li>Send a request to this endpoint, if you are not using the Enfuce BIN sponsorship.</li><li>Retrieving card data through this endpoint implies PCI DSS compliance of the client with the Scheme. An easier method that you can use is the `Initiate Card Data Retrieval` endpoint — this endpoint enables rendering of card information to the cardholder\'s device without requiring compliance of the client with PCI DSS.</li></ul></Note> ## Example: ```java // ... import java.security.KeyFactory; import java.security.PrivateKey; import java.security.spec.PKCS8EncodedKeySpec; import java.util.Base64; import javax.crypto.Cipher; // ... ## Example of decrypting an encrypted field ```java private String decrypt(String data, String privKeyPEM) throws Exception { ## Example of preparing the key ```java String privKeyString = privKeyPEM.replaceAll(\"\\\\n\", \"\").replace(\"-----BEGIN PRIVATE KEY-----\", \"\").replace(\"-----END PRIVATE KEY-----\", \"\"); byte[] encodedKey = Base64.getDecoder().decode(privKeyString); PKCS8EncodedKeySpec spec = new PKCS8EncodedKeySpec(encodedKey); KeyFactory kf = KeyFactory.getInstance(\"RSA\"); PrivateKey privateKey = kf.generatePrivate(spec); ## Example of preparing the decryption ```java Cipher cipher = Cipher.getInstance(\"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\"); cipher.init(Cipher.DECRYPT_MODE, privateKey); ## Example of preparing the data ```java byte[] cryptogram = Base64.getDecoder().decode(data); ## Example of decryption ```java byte[] decryptedBytes = cipher.doFinal(cryptogram); return new String(decryptedBytes);
|
|
1704
|
+
* @summary Retrieve Card Data | Additional Method
|
|
1705
|
+
* @param {string} id Unique identifier of the card whose details you want to retrieve.
|
|
1706
|
+
* @param {EncryptCardPaymentInfoRequestBody} encryptCardPaymentInfoRequestBody
|
|
1707
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1708
|
+
* @param {*} [options] Override http request option.
|
|
1709
|
+
* @throws {RequiredError}
|
|
1710
|
+
*/
|
|
1711
|
+
encryptCardPaymentInfo: (id: string, encryptCardPaymentInfoRequestBody: EncryptCardPaymentInfoRequestBody, xAuditUser?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1712
|
+
};
|
|
1713
|
+
/**
|
|
1714
|
+
* GetCardPaymentInfoApi - functional programming interface
|
|
1715
|
+
* @export
|
|
1716
|
+
*/
|
|
1717
|
+
export declare const GetCardPaymentInfoApiFp: (configuration?: Configuration) => {
|
|
1718
|
+
/**
|
|
1719
|
+
* This is a web service designed to retrieve the card data required for completing e-commerce payments — PAN, CVC2/CVV2, expiry date of the card can be retrieved. The returned payload is encrypted with an asymmetric public key; this enables end-to-end encryption to the card holder device. The parameters that were included in the request are only returned. The caller is responsible of validating the integrity of the public key. <Note><ul><li>Send a request to this endpoint, if you are not using the Enfuce BIN sponsorship.</li><li>Retrieving card data through this endpoint implies PCI DSS compliance of the client with the Scheme. An easier method that you can use is the `Initiate Card Data Retrieval` endpoint — this endpoint enables rendering of card information to the cardholder\'s device without requiring compliance of the client with PCI DSS.</li></ul></Note> ## Example: ```java // ... import java.security.KeyFactory; import java.security.PrivateKey; import java.security.spec.PKCS8EncodedKeySpec; import java.util.Base64; import javax.crypto.Cipher; // ... ## Example of decrypting an encrypted field ```java private String decrypt(String data, String privKeyPEM) throws Exception { ## Example of preparing the key ```java String privKeyString = privKeyPEM.replaceAll(\"\\\\n\", \"\").replace(\"-----BEGIN PRIVATE KEY-----\", \"\").replace(\"-----END PRIVATE KEY-----\", \"\"); byte[] encodedKey = Base64.getDecoder().decode(privKeyString); PKCS8EncodedKeySpec spec = new PKCS8EncodedKeySpec(encodedKey); KeyFactory kf = KeyFactory.getInstance(\"RSA\"); PrivateKey privateKey = kf.generatePrivate(spec); ## Example of preparing the decryption ```java Cipher cipher = Cipher.getInstance(\"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\"); cipher.init(Cipher.DECRYPT_MODE, privateKey); ## Example of preparing the data ```java byte[] cryptogram = Base64.getDecoder().decode(data); ## Example of decryption ```java byte[] decryptedBytes = cipher.doFinal(cryptogram); return new String(decryptedBytes);
|
|
1720
|
+
* @summary Retrieve Card Data | Additional Method
|
|
1721
|
+
* @param {string} id Unique identifier of the card whose details you want to retrieve.
|
|
1722
|
+
* @param {EncryptCardPaymentInfoRequestBody} encryptCardPaymentInfoRequestBody
|
|
1723
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1724
|
+
* @param {*} [options] Override http request option.
|
|
1725
|
+
* @throws {RequiredError}
|
|
1726
|
+
*/
|
|
1727
|
+
encryptCardPaymentInfo(id: string, encryptCardPaymentInfoRequestBody: EncryptCardPaymentInfoRequestBody, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EncryptCardPaymentInfoResponseBody>>;
|
|
1728
|
+
};
|
|
1729
|
+
/**
|
|
1730
|
+
* GetCardPaymentInfoApi - factory interface
|
|
1731
|
+
* @export
|
|
1732
|
+
*/
|
|
1733
|
+
export declare const GetCardPaymentInfoApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1734
|
+
/**
|
|
1735
|
+
* This is a web service designed to retrieve the card data required for completing e-commerce payments — PAN, CVC2/CVV2, expiry date of the card can be retrieved. The returned payload is encrypted with an asymmetric public key; this enables end-to-end encryption to the card holder device. The parameters that were included in the request are only returned. The caller is responsible of validating the integrity of the public key. <Note><ul><li>Send a request to this endpoint, if you are not using the Enfuce BIN sponsorship.</li><li>Retrieving card data through this endpoint implies PCI DSS compliance of the client with the Scheme. An easier method that you can use is the `Initiate Card Data Retrieval` endpoint — this endpoint enables rendering of card information to the cardholder\'s device without requiring compliance of the client with PCI DSS.</li></ul></Note> ## Example: ```java // ... import java.security.KeyFactory; import java.security.PrivateKey; import java.security.spec.PKCS8EncodedKeySpec; import java.util.Base64; import javax.crypto.Cipher; // ... ## Example of decrypting an encrypted field ```java private String decrypt(String data, String privKeyPEM) throws Exception { ## Example of preparing the key ```java String privKeyString = privKeyPEM.replaceAll(\"\\\\n\", \"\").replace(\"-----BEGIN PRIVATE KEY-----\", \"\").replace(\"-----END PRIVATE KEY-----\", \"\"); byte[] encodedKey = Base64.getDecoder().decode(privKeyString); PKCS8EncodedKeySpec spec = new PKCS8EncodedKeySpec(encodedKey); KeyFactory kf = KeyFactory.getInstance(\"RSA\"); PrivateKey privateKey = kf.generatePrivate(spec); ## Example of preparing the decryption ```java Cipher cipher = Cipher.getInstance(\"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\"); cipher.init(Cipher.DECRYPT_MODE, privateKey); ## Example of preparing the data ```java byte[] cryptogram = Base64.getDecoder().decode(data); ## Example of decryption ```java byte[] decryptedBytes = cipher.doFinal(cryptogram); return new String(decryptedBytes);
|
|
1736
|
+
* @summary Retrieve Card Data | Additional Method
|
|
1737
|
+
* @param {string} id Unique identifier of the card whose details you want to retrieve.
|
|
1738
|
+
* @param {EncryptCardPaymentInfoRequestBody} encryptCardPaymentInfoRequestBody
|
|
1739
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1740
|
+
* @param {*} [options] Override http request option.
|
|
1741
|
+
* @throws {RequiredError}
|
|
1742
|
+
*/
|
|
1743
|
+
encryptCardPaymentInfo(id: string, encryptCardPaymentInfoRequestBody: EncryptCardPaymentInfoRequestBody, xAuditUser?: string, options?: RawAxiosRequestConfig): AxiosPromise<EncryptCardPaymentInfoResponseBody>;
|
|
1744
|
+
};
|
|
1745
|
+
/**
|
|
1746
|
+
* GetCardPaymentInfoApi - object-oriented interface
|
|
1747
|
+
* @export
|
|
1748
|
+
* @class GetCardPaymentInfoApi
|
|
1749
|
+
* @extends {BaseAPI}
|
|
1750
|
+
*/
|
|
1751
|
+
export declare class GetCardPaymentInfoApi extends BaseAPI {
|
|
1752
|
+
/**
|
|
1753
|
+
* This is a web service designed to retrieve the card data required for completing e-commerce payments — PAN, CVC2/CVV2, expiry date of the card can be retrieved. The returned payload is encrypted with an asymmetric public key; this enables end-to-end encryption to the card holder device. The parameters that were included in the request are only returned. The caller is responsible of validating the integrity of the public key. <Note><ul><li>Send a request to this endpoint, if you are not using the Enfuce BIN sponsorship.</li><li>Retrieving card data through this endpoint implies PCI DSS compliance of the client with the Scheme. An easier method that you can use is the `Initiate Card Data Retrieval` endpoint — this endpoint enables rendering of card information to the cardholder\'s device without requiring compliance of the client with PCI DSS.</li></ul></Note> ## Example: ```java // ... import java.security.KeyFactory; import java.security.PrivateKey; import java.security.spec.PKCS8EncodedKeySpec; import java.util.Base64; import javax.crypto.Cipher; // ... ## Example of decrypting an encrypted field ```java private String decrypt(String data, String privKeyPEM) throws Exception { ## Example of preparing the key ```java String privKeyString = privKeyPEM.replaceAll(\"\\\\n\", \"\").replace(\"-----BEGIN PRIVATE KEY-----\", \"\").replace(\"-----END PRIVATE KEY-----\", \"\"); byte[] encodedKey = Base64.getDecoder().decode(privKeyString); PKCS8EncodedKeySpec spec = new PKCS8EncodedKeySpec(encodedKey); KeyFactory kf = KeyFactory.getInstance(\"RSA\"); PrivateKey privateKey = kf.generatePrivate(spec); ## Example of preparing the decryption ```java Cipher cipher = Cipher.getInstance(\"RSA/ECB/OAEPWithSHA-256AndMGF1Padding\"); cipher.init(Cipher.DECRYPT_MODE, privateKey); ## Example of preparing the data ```java byte[] cryptogram = Base64.getDecoder().decode(data); ## Example of decryption ```java byte[] decryptedBytes = cipher.doFinal(cryptogram); return new String(decryptedBytes);
|
|
1754
|
+
* @summary Retrieve Card Data | Additional Method
|
|
1755
|
+
* @param {string} id Unique identifier of the card whose details you want to retrieve.
|
|
1756
|
+
* @param {EncryptCardPaymentInfoRequestBody} encryptCardPaymentInfoRequestBody
|
|
1757
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1758
|
+
* @param {*} [options] Override http request option.
|
|
1759
|
+
* @throws {RequiredError}
|
|
1760
|
+
* @memberof GetCardPaymentInfoApi
|
|
1761
|
+
*/
|
|
1762
|
+
encryptCardPaymentInfo(id: string, encryptCardPaymentInfoRequestBody: EncryptCardPaymentInfoRequestBody, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EncryptCardPaymentInfoResponseBody, any, {}>>;
|
|
1763
|
+
}
|
|
1764
|
+
/**
|
|
1765
|
+
* GetPlasticManufacturingHistoryApi - axios parameter creator
|
|
1766
|
+
* @export
|
|
1767
|
+
*/
|
|
1768
|
+
export declare const GetPlasticManufacturingHistoryApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1769
|
+
/**
|
|
1770
|
+
* Send a request to this endpoint to retrieve a detailed list of all past occurrences when the card has been physically manufactured.
|
|
1771
|
+
* @summary Retrieve Manufacturing History of Card
|
|
1772
|
+
* @param {string} id Unique identifier of the card for which you want to retrieve the manufacturing history.
|
|
1773
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1774
|
+
* @param {*} [options] Override http request option.
|
|
1775
|
+
* @throws {RequiredError}
|
|
1776
|
+
*/
|
|
1777
|
+
manufacturingHistory: (id: string, xAuditUser?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1778
|
+
};
|
|
1779
|
+
/**
|
|
1780
|
+
* GetPlasticManufacturingHistoryApi - functional programming interface
|
|
1781
|
+
* @export
|
|
1782
|
+
*/
|
|
1783
|
+
export declare const GetPlasticManufacturingHistoryApiFp: (configuration?: Configuration) => {
|
|
1784
|
+
/**
|
|
1785
|
+
* Send a request to this endpoint to retrieve a detailed list of all past occurrences when the card has been physically manufactured.
|
|
1786
|
+
* @summary Retrieve Manufacturing History of Card
|
|
1787
|
+
* @param {string} id Unique identifier of the card for which you want to retrieve the manufacturing history.
|
|
1788
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1789
|
+
* @param {*} [options] Override http request option.
|
|
1790
|
+
* @throws {RequiredError}
|
|
1791
|
+
*/
|
|
1792
|
+
manufacturingHistory(id: string, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlasticManufacturingHistoryResponse>>;
|
|
1793
|
+
};
|
|
1794
|
+
/**
|
|
1795
|
+
* GetPlasticManufacturingHistoryApi - factory interface
|
|
1796
|
+
* @export
|
|
1797
|
+
*/
|
|
1798
|
+
export declare const GetPlasticManufacturingHistoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1799
|
+
/**
|
|
1800
|
+
* Send a request to this endpoint to retrieve a detailed list of all past occurrences when the card has been physically manufactured.
|
|
1801
|
+
* @summary Retrieve Manufacturing History of Card
|
|
1802
|
+
* @param {string} id Unique identifier of the card for which you want to retrieve the manufacturing history.
|
|
1803
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1804
|
+
* @param {*} [options] Override http request option.
|
|
1805
|
+
* @throws {RequiredError}
|
|
1806
|
+
*/
|
|
1807
|
+
manufacturingHistory(id: string, xAuditUser?: string, options?: RawAxiosRequestConfig): AxiosPromise<PlasticManufacturingHistoryResponse>;
|
|
1808
|
+
};
|
|
1809
|
+
/**
|
|
1810
|
+
* GetPlasticManufacturingHistoryApi - object-oriented interface
|
|
1811
|
+
* @export
|
|
1812
|
+
* @class GetPlasticManufacturingHistoryApi
|
|
1813
|
+
* @extends {BaseAPI}
|
|
1814
|
+
*/
|
|
1815
|
+
export declare class GetPlasticManufacturingHistoryApi extends BaseAPI {
|
|
1816
|
+
/**
|
|
1817
|
+
* Send a request to this endpoint to retrieve a detailed list of all past occurrences when the card has been physically manufactured.
|
|
1818
|
+
* @summary Retrieve Manufacturing History of Card
|
|
1819
|
+
* @param {string} id Unique identifier of the card for which you want to retrieve the manufacturing history.
|
|
1820
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1821
|
+
* @param {*} [options] Override http request option.
|
|
1822
|
+
* @throws {RequiredError}
|
|
1823
|
+
* @memberof GetPlasticManufacturingHistoryApi
|
|
1824
|
+
*/
|
|
1825
|
+
manufacturingHistory(id: string, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PlasticManufacturingHistoryResponse, any, {}>>;
|
|
1826
|
+
}
|
|
1827
|
+
/**
|
|
1828
|
+
* UpdateCardApi - axios parameter creator
|
|
1829
|
+
* @export
|
|
1830
|
+
*/
|
|
1831
|
+
export declare const UpdateCardApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1832
|
+
/**
|
|
1833
|
+
* To change the latest card version status from `INITIAL` to `ACTIVE`, send a request to this endpoint.
|
|
1834
|
+
* @summary Activate Card
|
|
1835
|
+
* @param {string} id Unique ID of the card that you want to activate.
|
|
1836
|
+
* @param {string} [xIdempotencyKey] Idempotency key of the request
|
|
1837
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1838
|
+
* @param {*} [options] Override http request option.
|
|
1839
|
+
* @throws {RequiredError}
|
|
1840
|
+
*/
|
|
1841
|
+
activateCard: (id: string, xIdempotencyKey?: string, xAuditUser?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1842
|
+
/**
|
|
1843
|
+
* Send a request to this endpoint when you want to update details of a specific card.
|
|
1844
|
+
* @summary Partially Update Card
|
|
1845
|
+
* @param {string} id Unique identifier of the card that you want to update.
|
|
1846
|
+
* @param {UpdateCardBody} updateCardBody Details of the card that you want to update.
|
|
1847
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1848
|
+
* @param {*} [options] Override http request option.
|
|
1849
|
+
* @throws {RequiredError}
|
|
1850
|
+
*/
|
|
1851
|
+
patchCard: (id: string, updateCardBody: UpdateCardBody, xAuditUser?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1852
|
+
/**
|
|
1853
|
+
* Send a request to this endpoint when you want to reissue a card.
|
|
1854
|
+
* @summary Reissue Card
|
|
1855
|
+
* @param {string} id Unique identifier of the card that you want to reissue.
|
|
1856
|
+
* @param {string} [xIdempotencyKey] Idempotency key of the request
|
|
1857
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1858
|
+
* @param {ReissueCardBody} [reissueCardBody]
|
|
1859
|
+
* @param {*} [options] Override http request option.
|
|
1860
|
+
* @throws {RequiredError}
|
|
1861
|
+
*/
|
|
1862
|
+
reissueCard: (id: string, xIdempotencyKey?: string, xAuditUser?: string, reissueCardBody?: ReissueCardBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1863
|
+
/**
|
|
1864
|
+
* Send a request to this endpoint when you want to reorder existing PIN for a plastic card, if the cardholder has forgotten it. The PIN is delivered to the `preferredPinAddress`. If `preferredPinAddress` is absent, the PIN is delivered to the `preferredCardAddress`.
|
|
1865
|
+
* @summary Reorder PIN for Card
|
|
1866
|
+
* @param {string} id Unique identifier of the card for which you want to reorder PIN.
|
|
1867
|
+
* @param {string} [xIdempotencyKey] Idempotency key of the request.
|
|
1868
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1869
|
+
* @param {*} [options] Override http request option.
|
|
1870
|
+
* @throws {RequiredError}
|
|
1871
|
+
*/
|
|
1872
|
+
reorderPin: (id: string, xIdempotencyKey?: string, xAuditUser?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1873
|
+
/**
|
|
1874
|
+
* Send a request to this endpoint when you want to replace the current card. The old card is closed and a new card is issued, where the PAN and the expiry date are updated.
|
|
1875
|
+
* @summary Replace Card
|
|
1876
|
+
* @param {string} id Unique identifier of the card to be replaced.
|
|
1877
|
+
* @param {string} [xIdempotencyKey] Idempotency key of the request.
|
|
1878
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1879
|
+
* @param {ReplaceCardBody} [replaceCardBody]
|
|
1880
|
+
* @param {*} [options] Override http request option.
|
|
1881
|
+
* @throws {RequiredError}
|
|
1882
|
+
*/
|
|
1883
|
+
replaceCard: (id: string, xIdempotencyKey?: string, xAuditUser?: string, replaceCardBody?: ReplaceCardBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1884
|
+
};
|
|
1885
|
+
/**
|
|
1886
|
+
* UpdateCardApi - functional programming interface
|
|
1887
|
+
* @export
|
|
1888
|
+
*/
|
|
1889
|
+
export declare const UpdateCardApiFp: (configuration?: Configuration) => {
|
|
1890
|
+
/**
|
|
1891
|
+
* To change the latest card version status from `INITIAL` to `ACTIVE`, send a request to this endpoint.
|
|
1892
|
+
* @summary Activate Card
|
|
1893
|
+
* @param {string} id Unique ID of the card that you want to activate.
|
|
1894
|
+
* @param {string} [xIdempotencyKey] Idempotency key of the request
|
|
1895
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1896
|
+
* @param {*} [options] Override http request option.
|
|
1897
|
+
* @throws {RequiredError}
|
|
1898
|
+
*/
|
|
1899
|
+
activateCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceResponse>>;
|
|
1900
|
+
/**
|
|
1901
|
+
* Send a request to this endpoint when you want to update details of a specific card.
|
|
1902
|
+
* @summary Partially Update Card
|
|
1903
|
+
* @param {string} id Unique identifier of the card that you want to update.
|
|
1904
|
+
* @param {UpdateCardBody} updateCardBody Details of the card that you want to update.
|
|
1905
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1906
|
+
* @param {*} [options] Override http request option.
|
|
1907
|
+
* @throws {RequiredError}
|
|
1908
|
+
*/
|
|
1909
|
+
patchCard(id: string, updateCardBody: UpdateCardBody, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceResponse>>;
|
|
1910
|
+
/**
|
|
1911
|
+
* Send a request to this endpoint when you want to reissue a card.
|
|
1912
|
+
* @summary Reissue Card
|
|
1913
|
+
* @param {string} id Unique identifier of the card that you want to reissue.
|
|
1914
|
+
* @param {string} [xIdempotencyKey] Idempotency key of the request
|
|
1915
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1916
|
+
* @param {ReissueCardBody} [reissueCardBody]
|
|
1917
|
+
* @param {*} [options] Override http request option.
|
|
1918
|
+
* @throws {RequiredError}
|
|
1919
|
+
*/
|
|
1920
|
+
reissueCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, reissueCardBody?: ReissueCardBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceResponse>>;
|
|
1921
|
+
/**
|
|
1922
|
+
* Send a request to this endpoint when you want to reorder existing PIN for a plastic card, if the cardholder has forgotten it. The PIN is delivered to the `preferredPinAddress`. If `preferredPinAddress` is absent, the PIN is delivered to the `preferredCardAddress`.
|
|
1923
|
+
* @summary Reorder PIN for Card
|
|
1924
|
+
* @param {string} id Unique identifier of the card for which you want to reorder PIN.
|
|
1925
|
+
* @param {string} [xIdempotencyKey] Idempotency key of the request.
|
|
1926
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1927
|
+
* @param {*} [options] Override http request option.
|
|
1928
|
+
* @throws {RequiredError}
|
|
1929
|
+
*/
|
|
1930
|
+
reorderPin(id: string, xIdempotencyKey?: string, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceResponse>>;
|
|
1931
|
+
/**
|
|
1932
|
+
* Send a request to this endpoint when you want to replace the current card. The old card is closed and a new card is issued, where the PAN and the expiry date are updated.
|
|
1933
|
+
* @summary Replace Card
|
|
1934
|
+
* @param {string} id Unique identifier of the card to be replaced.
|
|
1935
|
+
* @param {string} [xIdempotencyKey] Idempotency key of the request.
|
|
1936
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1937
|
+
* @param {ReplaceCardBody} [replaceCardBody]
|
|
1938
|
+
* @param {*} [options] Override http request option.
|
|
1939
|
+
* @throws {RequiredError}
|
|
1940
|
+
*/
|
|
1941
|
+
replaceCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, replaceCardBody?: ReplaceCardBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceResponse>>;
|
|
1942
|
+
};
|
|
1943
|
+
/**
|
|
1944
|
+
* UpdateCardApi - factory interface
|
|
1945
|
+
* @export
|
|
1946
|
+
*/
|
|
1947
|
+
export declare const UpdateCardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1948
|
+
/**
|
|
1949
|
+
* To change the latest card version status from `INITIAL` to `ACTIVE`, send a request to this endpoint.
|
|
1950
|
+
* @summary Activate Card
|
|
1951
|
+
* @param {string} id Unique ID of the card that you want to activate.
|
|
1952
|
+
* @param {string} [xIdempotencyKey] Idempotency key of the request
|
|
1953
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1954
|
+
* @param {*} [options] Override http request option.
|
|
1955
|
+
* @throws {RequiredError}
|
|
1956
|
+
*/
|
|
1957
|
+
activateCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, options?: RawAxiosRequestConfig): AxiosPromise<ResourceResponse>;
|
|
1958
|
+
/**
|
|
1959
|
+
* Send a request to this endpoint when you want to update details of a specific card.
|
|
1960
|
+
* @summary Partially Update Card
|
|
1961
|
+
* @param {string} id Unique identifier of the card that you want to update.
|
|
1962
|
+
* @param {UpdateCardBody} updateCardBody Details of the card that you want to update.
|
|
1963
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1964
|
+
* @param {*} [options] Override http request option.
|
|
1965
|
+
* @throws {RequiredError}
|
|
1966
|
+
*/
|
|
1967
|
+
patchCard(id: string, updateCardBody: UpdateCardBody, xAuditUser?: string, options?: RawAxiosRequestConfig): AxiosPromise<ResourceResponse>;
|
|
1968
|
+
/**
|
|
1969
|
+
* Send a request to this endpoint when you want to reissue a card.
|
|
1970
|
+
* @summary Reissue Card
|
|
1971
|
+
* @param {string} id Unique identifier of the card that you want to reissue.
|
|
1972
|
+
* @param {string} [xIdempotencyKey] Idempotency key of the request
|
|
1973
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1974
|
+
* @param {ReissueCardBody} [reissueCardBody]
|
|
1975
|
+
* @param {*} [options] Override http request option.
|
|
1976
|
+
* @throws {RequiredError}
|
|
1977
|
+
*/
|
|
1978
|
+
reissueCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, reissueCardBody?: ReissueCardBody, options?: RawAxiosRequestConfig): AxiosPromise<ResourceResponse>;
|
|
1979
|
+
/**
|
|
1980
|
+
* Send a request to this endpoint when you want to reorder existing PIN for a plastic card, if the cardholder has forgotten it. The PIN is delivered to the `preferredPinAddress`. If `preferredPinAddress` is absent, the PIN is delivered to the `preferredCardAddress`.
|
|
1981
|
+
* @summary Reorder PIN for Card
|
|
1982
|
+
* @param {string} id Unique identifier of the card for which you want to reorder PIN.
|
|
1983
|
+
* @param {string} [xIdempotencyKey] Idempotency key of the request.
|
|
1984
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1985
|
+
* @param {*} [options] Override http request option.
|
|
1986
|
+
* @throws {RequiredError}
|
|
1987
|
+
*/
|
|
1988
|
+
reorderPin(id: string, xIdempotencyKey?: string, xAuditUser?: string, options?: RawAxiosRequestConfig): AxiosPromise<ResourceResponse>;
|
|
1989
|
+
/**
|
|
1990
|
+
* Send a request to this endpoint when you want to replace the current card. The old card is closed and a new card is issued, where the PAN and the expiry date are updated.
|
|
1991
|
+
* @summary Replace Card
|
|
1992
|
+
* @param {string} id Unique identifier of the card to be replaced.
|
|
1993
|
+
* @param {string} [xIdempotencyKey] Idempotency key of the request.
|
|
1994
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
1995
|
+
* @param {ReplaceCardBody} [replaceCardBody]
|
|
1996
|
+
* @param {*} [options] Override http request option.
|
|
1997
|
+
* @throws {RequiredError}
|
|
1998
|
+
*/
|
|
1999
|
+
replaceCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, replaceCardBody?: ReplaceCardBody, options?: RawAxiosRequestConfig): AxiosPromise<ResourceResponse>;
|
|
2000
|
+
};
|
|
2001
|
+
/**
|
|
2002
|
+
* UpdateCardApi - object-oriented interface
|
|
2003
|
+
* @export
|
|
2004
|
+
* @class UpdateCardApi
|
|
2005
|
+
* @extends {BaseAPI}
|
|
2006
|
+
*/
|
|
2007
|
+
export declare class UpdateCardApi extends BaseAPI {
|
|
2008
|
+
/**
|
|
2009
|
+
* To change the latest card version status from `INITIAL` to `ACTIVE`, send a request to this endpoint.
|
|
2010
|
+
* @summary Activate Card
|
|
2011
|
+
* @param {string} id Unique ID of the card that you want to activate.
|
|
2012
|
+
* @param {string} [xIdempotencyKey] Idempotency key of the request
|
|
2013
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
2014
|
+
* @param {*} [options] Override http request option.
|
|
2015
|
+
* @throws {RequiredError}
|
|
2016
|
+
* @memberof UpdateCardApi
|
|
2017
|
+
*/
|
|
2018
|
+
activateCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResourceResponse, any, {}>>;
|
|
2019
|
+
/**
|
|
2020
|
+
* Send a request to this endpoint when you want to update details of a specific card.
|
|
2021
|
+
* @summary Partially Update Card
|
|
2022
|
+
* @param {string} id Unique identifier of the card that you want to update.
|
|
2023
|
+
* @param {UpdateCardBody} updateCardBody Details of the card that you want to update.
|
|
2024
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
2025
|
+
* @param {*} [options] Override http request option.
|
|
2026
|
+
* @throws {RequiredError}
|
|
2027
|
+
* @memberof UpdateCardApi
|
|
2028
|
+
*/
|
|
2029
|
+
patchCard(id: string, updateCardBody: UpdateCardBody, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResourceResponse, any, {}>>;
|
|
2030
|
+
/**
|
|
2031
|
+
* Send a request to this endpoint when you want to reissue a card.
|
|
2032
|
+
* @summary Reissue Card
|
|
2033
|
+
* @param {string} id Unique identifier of the card that you want to reissue.
|
|
2034
|
+
* @param {string} [xIdempotencyKey] Idempotency key of the request
|
|
2035
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
2036
|
+
* @param {ReissueCardBody} [reissueCardBody]
|
|
2037
|
+
* @param {*} [options] Override http request option.
|
|
2038
|
+
* @throws {RequiredError}
|
|
2039
|
+
* @memberof UpdateCardApi
|
|
2040
|
+
*/
|
|
2041
|
+
reissueCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, reissueCardBody?: ReissueCardBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResourceResponse, any, {}>>;
|
|
2042
|
+
/**
|
|
2043
|
+
* Send a request to this endpoint when you want to reorder existing PIN for a plastic card, if the cardholder has forgotten it. The PIN is delivered to the `preferredPinAddress`. If `preferredPinAddress` is absent, the PIN is delivered to the `preferredCardAddress`.
|
|
2044
|
+
* @summary Reorder PIN for Card
|
|
2045
|
+
* @param {string} id Unique identifier of the card for which you want to reorder PIN.
|
|
2046
|
+
* @param {string} [xIdempotencyKey] Idempotency key of the request.
|
|
2047
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
2048
|
+
* @param {*} [options] Override http request option.
|
|
2049
|
+
* @throws {RequiredError}
|
|
2050
|
+
* @memberof UpdateCardApi
|
|
2051
|
+
*/
|
|
2052
|
+
reorderPin(id: string, xIdempotencyKey?: string, xAuditUser?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResourceResponse, any, {}>>;
|
|
2053
|
+
/**
|
|
2054
|
+
* Send a request to this endpoint when you want to replace the current card. The old card is closed and a new card is issued, where the PAN and the expiry date are updated.
|
|
2055
|
+
* @summary Replace Card
|
|
2056
|
+
* @param {string} id Unique identifier of the card to be replaced.
|
|
2057
|
+
* @param {string} [xIdempotencyKey] Idempotency key of the request.
|
|
2058
|
+
* @param {string} [xAuditUser] Optional audit user header
|
|
2059
|
+
* @param {ReplaceCardBody} [replaceCardBody]
|
|
2060
|
+
* @param {*} [options] Override http request option.
|
|
2061
|
+
* @throws {RequiredError}
|
|
2062
|
+
* @memberof UpdateCardApi
|
|
2063
|
+
*/
|
|
2064
|
+
replaceCard(id: string, xIdempotencyKey?: string, xAuditUser?: string, replaceCardBody?: ReplaceCardBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ResourceResponse, any, {}>>;
|
|
2065
|
+
}
|