-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
PaymentTokenInterface.php
252 lines (229 loc) · 4.69 KB
/
PaymentTokenInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Vault\Api\Data;
/**
* Gateway vault payment token interface.
*
* @api
* @since 100.1.0
*/
interface PaymentTokenInterface
{
/**#@+
* Constants for keys of data array. Identical to the name of the getter in snake case.
*/
/*
* Entity ID.
*/
const ENTITY_ID = 'entity_id';
/*
* Customer ID.
*/
const CUSTOMER_ID = 'customer_id';
/*
* Unique hash for frontend.
*/
const PUBLIC_HASH = 'public_hash';
/*
* Payment method code.
*/
const PAYMENT_METHOD_CODE = 'payment_method_code';
/*
* Token type.
*/
const TYPE = 'type';
/*
* Token creation timestamp.
*/
const CREATED_AT = 'created_at';
/*
* Token expiration timestamp.
*/
const EXPIRES_AT = 'expires_at';
/*
* Gateway token ID.
*/
const GATEWAY_TOKEN = 'gateway_token';
/*
* Additional details.
*/
const DETAILS = 'details';
/*
* Is vault payment record active.
*/
const IS_ACTIVE = 'is_active';
/*
* Is vault payment token visible.
*/
const IS_VISIBLE = 'is_visible';
/**
* Gets the entity ID.
*
* @return int|null Entity ID.
* @since 100.1.0
*/
public function getEntityId();
/**
* Sets entity ID.
*
* @param int $entityId
* @return $this
* @since 100.1.0
*/
public function setEntityId($entityId);
/**
* Gets the customer ID.
*
* @return int|null Customer ID.
* @since 100.1.0
*/
public function getCustomerId();
/**
* Sets customer ID.
*
* @param int $customerId
* @return $this
* @since 100.1.0
*/
public function setCustomerId($customerId);
/**
* Get public hash
*
* @return string
* @since 100.1.0
*/
public function getPublicHash();
/**
* Set public hash
*
* @param string $hash
* @return $this
* @since 100.1.0
*/
public function setPublicHash($hash);
/**
* Get payment method code
*
* @return string
* @since 100.1.0
*/
public function getPaymentMethodCode();
/**
* Set payment method code
*
* @param string $code
* @return $this
* @since 100.1.0
*/
public function setPaymentMethodCode($code);
/**
* Get type
*
* @return string
* @since 100.1.0
*/
public function getType();
/**
* Set type
*
* @param string $type
* @return $this
* @since 100.1.0
*/
public function setType($type);
/**
* Get token creation timestamp
*
* @return string|null
* @since 100.1.0
*/
public function getCreatedAt();
/**
* Set token creation timestamp
*
* @param string $timestamp
* @return $this
* @since 100.1.0
*/
public function setCreatedAt($timestamp);
/**
* Get token expiration timestamp
*
* @return string|null
* @since 100.1.0
*/
public function getExpiresAt();
/**
* Set token expiration timestamp
*
* @param string $timestamp
* @return $this
* @since 100.1.0
*/
public function setExpiresAt($timestamp);
/**
* Get gateway token ID
*
* @return string
* @since 100.1.0
*/
public function getGatewayToken();
/**
* Set gateway token ID
*
* @param string $token
* @return $this
* @since 100.1.0
*/
public function setGatewayToken($token);
/**
* Get token details
*
* @return string
* @since 100.1.0
*/
public function getTokenDetails();
/**
* Set token details
*
* @param string $details
* @return $this
* @since 100.1.0
*/
public function setTokenDetails($details);
/**
* Gets is vault payment record active.
*
* @return bool Is active.
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
* @since 100.1.0
*/
public function getIsActive();
/**
* Sets is vault payment record active.
*
* @param bool $isActive
* @return $this
* @since 100.1.0
*/
public function setIsActive($isActive);
/**
* Gets is vault payment record visible.
*
* @return bool Is visible.
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
* @since 100.1.0
*/
public function getIsVisible();
/**
* Sets is vault payment record visible.
*
* @param bool $isVisible
* @return $this
* @since 100.1.0
*/
public function setIsVisible($isVisible);
}