-
Notifications
You must be signed in to change notification settings - Fork 724
/
Authorizations.d.ts
493 lines (410 loc) · 18.5 KB
/
Authorizations.d.ts
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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
// File generated from our OpenAPI spec
declare module 'stripe' {
namespace Stripe {
namespace Issuing {
/**
* When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`
* object is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the
* purchase to be completed successfully.
*
* Related guide: [Issued Card Authorizations](https://stripe.com/docs/issuing/purchases/authorizations).
*/
interface Authorization {
/**
* Unique identifier for the object.
*/
id: string;
/**
* String representing the object's type. Objects of the same type share the same value.
*/
object: 'issuing.authorization';
/**
* The total amount that was authorized or rejected. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
*/
amount: number;
/**
* Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
*/
amount_details: Authorization.AmountDetails | null;
/**
* Whether the authorization has been approved.
*/
approved: boolean;
/**
* How the card details were provided.
*/
authorization_method: Authorization.AuthorizationMethod;
/**
* List of balance transactions associated with this authorization.
*/
balance_transactions: Array<Stripe.BalanceTransaction>;
/**
* You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders.
*/
card: Stripe.Issuing.Card;
/**
* The cardholder to whom this authorization belongs.
*/
cardholder: string | Stripe.Issuing.Cardholder | null;
/**
* Time at which the object was created. Measured in seconds since the Unix epoch.
*/
created: number;
/**
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
*/
currency: string;
/**
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
*/
livemode: boolean;
/**
* The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
*/
merchant_amount: number;
/**
* The currency that was presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
*/
merchant_currency: string;
merchant_data: Authorization.MerchantData;
/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
*/
metadata: Stripe.Metadata;
/**
* Details about the authorization, such as identifiers, set by the card network.
*/
network_data: Authorization.NetworkData | null;
/**
* The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook.
*/
pending_request: Authorization.PendingRequest | null;
/**
* History of every time `pending_request` was approved/denied, either by you directly or by Stripe (e.g. based on your `spending_controls`). If the merchant changes the authorization by performing an [incremental authorization](https://stripe.com/docs/issuing/purchases/authorizations), you can look at this field to see the previous requests for the authorization.
*/
request_history: Array<Authorization.RequestHistory>;
/**
* The current status of the authorization in its lifecycle.
*/
status: Authorization.Status;
/**
* List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization.
*/
transactions: Array<Stripe.Issuing.Transaction>;
/**
* [Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts).
*/
treasury?: Authorization.Treasury | null;
verification_data: Authorization.VerificationData;
/**
* The digital wallet used for this authorization. One of `apple_pay`, `google_pay`, or `samsung_pay`.
*/
wallet: string | null;
}
namespace Authorization {
interface AmountDetails {
/**
* The fee charged by the ATM for the cash withdrawal.
*/
atm_fee: number | null;
}
type AuthorizationMethod =
| 'chip'
| 'contactless'
| 'keyed_in'
| 'online'
| 'swipe';
interface MerchantData {
/**
* A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.
*/
category: string;
/**
* The merchant category code for the seller's business
*/
category_code: string;
/**
* City where the seller is located
*/
city: string | null;
/**
* Country where the seller is located
*/
country: string | null;
/**
* Name of the seller
*/
name: string | null;
/**
* Identifier assigned to the seller by the card brand
*/
network_id: string;
/**
* Postal code where the seller is located
*/
postal_code: string | null;
/**
* State where the seller is located
*/
state: string | null;
}
interface NetworkData {
/**
* ID from the network that identifies the acquiring financial institution. For Visa and Mastercard credit transactions this is as 6 digit code. For Maestro debit transactions this is a 9 digit code. Uncommonly, acquiring institution ID is not provided. When this occurs, the value will be null.
*/
acquiring_institution_id: string | null;
}
interface PendingRequest {
/**
* The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
*/
amount: number;
/**
* Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
*/
amount_details: PendingRequest.AmountDetails | null;
/**
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
*/
currency: string;
/**
* If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.
*/
is_amount_controllable: boolean;
/**
* The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
*/
merchant_amount: number;
/**
* The local currency the merchant is requesting to authorize.
*/
merchant_currency: string;
}
namespace PendingRequest {
interface AmountDetails {
/**
* The fee charged by the ATM for the cash withdrawal.
*/
atm_fee: number | null;
}
}
interface RequestHistory {
/**
* The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved.
*/
amount: number;
/**
* Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
*/
amount_details: RequestHistory.AmountDetails | null;
/**
* Whether this request was approved.
*/
approved: boolean;
/**
* Time at which the object was created. Measured in seconds since the Unix epoch.
*/
created: number;
/**
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
*/
currency: string;
/**
* The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
*/
merchant_amount: number;
/**
* The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
*/
merchant_currency: string;
/**
* The reason for the approval or decline.
*/
reason: RequestHistory.Reason;
}
namespace RequestHistory {
interface AmountDetails {
/**
* The fee charged by the ATM for the cash withdrawal.
*/
atm_fee: number | null;
}
type Reason =
| 'account_disabled'
| 'card_active'
| 'card_inactive'
| 'cardholder_inactive'
| 'cardholder_verification_required'
| 'insufficient_funds'
| 'not_allowed'
| 'spending_controls'
| 'suspected_fraud'
| 'verification_failed'
| 'webhook_approved'
| 'webhook_declined'
| 'webhook_timeout';
}
type Status = 'closed' | 'pending' | 'reversed';
interface Treasury {
/**
* The array of [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) associated with this authorization
*/
received_credits: Array<string>;
/**
* The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization
*/
received_debits: Array<string>;
/**
* The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization
*/
transaction: string | null;
}
interface VerificationData {
/**
* Whether the cardholder provided an address first line and if it matched the cardholder's `billing.address.line1`.
*/
address_line1_check: VerificationData.AddressLine1Check;
/**
* Whether the cardholder provided a postal code and if it matched the cardholder's `billing.address.postal_code`.
*/
address_postal_code_check: VerificationData.AddressPostalCodeCheck;
/**
* Whether the cardholder provided a CVC and if it matched Stripe's record.
*/
cvc_check: VerificationData.CvcCheck;
/**
* Whether the cardholder provided an expiry date and if it matched Stripe's record.
*/
expiry_check: VerificationData.ExpiryCheck;
}
namespace VerificationData {
type AddressLine1Check = 'match' | 'mismatch' | 'not_provided';
type AddressPostalCodeCheck = 'match' | 'mismatch' | 'not_provided';
type CvcCheck = 'match' | 'mismatch' | 'not_provided';
type ExpiryCheck = 'match' | 'mismatch' | 'not_provided';
}
}
interface AuthorizationRetrieveParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
}
interface AuthorizationUpdateParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
}
interface AuthorizationListParams extends PaginationParams {
/**
* Only return authorizations that belong to the given card.
*/
card?: string;
/**
* Only return authorizations that belong to the given cardholder.
*/
cardholder?: string;
/**
* Only return authorizations that were created during the given date interval.
*/
created?: Stripe.RangeQueryParam | number;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`.
*/
status?: AuthorizationListParams.Status;
}
namespace AuthorizationListParams {
type Status = 'closed' | 'pending' | 'reversed';
}
interface AuthorizationApproveParams {
/**
* If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request).
*/
amount?: number;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
}
interface AuthorizationDeclineParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
}
class AuthorizationsResource {
/**
* Retrieves an Issuing Authorization object.
*/
retrieve(
id: string,
params?: AuthorizationRetrieveParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Issuing.Authorization>>;
retrieve(
id: string,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Issuing.Authorization>>;
/**
* Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
*/
update(
id: string,
params?: AuthorizationUpdateParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Issuing.Authorization>>;
/**
* Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
*/
list(
params?: AuthorizationListParams,
options?: RequestOptions
): ApiListPromise<Stripe.Issuing.Authorization>;
list(
options?: RequestOptions
): ApiListPromise<Stripe.Issuing.Authorization>;
/**
* Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow.
*/
approve(
id: string,
params?: AuthorizationApproveParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Issuing.Authorization>>;
approve(
id: string,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Issuing.Authorization>>;
/**
* Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow.
*/
decline(
id: string,
params?: AuthorizationDeclineParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Issuing.Authorization>>;
decline(
id: string,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Issuing.Authorization>>;
}
}
}
}