increase 0.7.1 → 0.8.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/CHANGELOG.md +71 -0
- package/README.md +8 -4
- package/_shims/ReadableStream.d.ts +38 -0
- package/_shims/ReadableStream.js +5 -0
- package/_shims/ReadableStream.mjs +7 -0
- package/_shims/ReadableStream.node.d.ts +6 -0
- package/_shims/ReadableStream.node.d.ts.map +1 -0
- package/_shims/ReadableStream.node.js +14 -0
- package/_shims/ReadableStream.node.js.map +1 -0
- package/_shims/ReadableStream.node.mjs +3 -0
- package/_shims/ReadableStream.node.mjs.map +1 -0
- package/_shims/fetch.js +1 -1
- package/core.d.ts +11 -10
- package/core.d.ts.map +1 -1
- package/core.js +123 -60
- package/core.js.map +1 -1
- package/core.mjs +113 -20
- package/core.mjs.map +1 -1
- package/error.d.ts +1 -0
- package/error.d.ts.map +1 -1
- package/error.js +12 -3
- package/error.js.map +1 -1
- package/error.mjs +12 -3
- package/error.mjs.map +1 -1
- package/index.d.mts +9 -5
- package/index.d.ts +9 -5
- package/index.d.ts.map +1 -1
- package/index.js +15 -11
- package/index.js.map +1 -1
- package/index.mjs +15 -11
- package/index.mjs.map +1 -1
- package/package.json +4 -4
- package/resources/account-numbers.d.ts.map +1 -1
- package/resources/account-statements.d.ts.map +1 -1
- package/resources/account-transfers.d.ts.map +1 -1
- package/resources/accounts.d.ts.map +1 -1
- package/resources/ach-prenotifications.d.ts.map +1 -1
- package/resources/ach-transfers.d.ts.map +1 -1
- package/resources/balance-lookups.d.ts.map +1 -1
- package/resources/bookkeeping-accounts.d.ts.map +1 -1
- package/resources/bookkeeping-entries.d.ts.map +1 -1
- package/resources/bookkeeping-entry-sets.d.ts.map +1 -1
- package/resources/card-disputes.d.ts.map +1 -1
- package/resources/card-profiles.d.ts +17 -4
- package/resources/card-profiles.d.ts.map +1 -1
- package/resources/card-profiles.js.map +1 -1
- package/resources/card-profiles.mjs.map +1 -1
- package/resources/card-purchase-supplements.d.ts +270 -0
- package/resources/card-purchase-supplements.d.ts.map +1 -0
- package/resources/card-purchase-supplements.js +28 -0
- package/resources/card-purchase-supplements.js.map +1 -0
- package/resources/card-purchase-supplements.mjs +21 -0
- package/resources/card-purchase-supplements.mjs.map +1 -0
- package/resources/cards.d.ts.map +1 -1
- package/resources/check-deposits.d.ts.map +1 -1
- package/resources/check-transfers.d.ts +184 -98
- package/resources/check-transfers.d.ts.map +1 -1
- package/resources/check-transfers.js.map +1 -1
- package/resources/check-transfers.mjs.map +1 -1
- package/resources/declined-transactions.d.ts +9 -7
- package/resources/declined-transactions.d.ts.map +1 -1
- package/resources/declined-transactions.js.map +1 -1
- package/resources/declined-transactions.mjs.map +1 -1
- package/resources/digital-wallet-tokens.d.ts.map +1 -1
- package/resources/documents.d.ts.map +1 -1
- package/resources/entities/beneficial-owners.d.ts +219 -0
- package/resources/entities/beneficial-owners.d.ts.map +1 -0
- package/resources/entities/beneficial-owners.js +18 -0
- package/resources/entities/beneficial-owners.js.map +1 -0
- package/resources/entities/beneficial-owners.mjs +12 -0
- package/resources/entities/beneficial-owners.mjs.map +1 -0
- package/resources/entities/entities.d.ts +4 -0
- package/resources/entities/entities.d.ts.map +1 -1
- package/resources/entities/entities.js +3 -0
- package/resources/entities/entities.js.map +1 -1
- package/resources/entities/entities.mjs +3 -0
- package/resources/entities/entities.mjs.map +1 -1
- package/resources/entities/index.d.ts +1 -0
- package/resources/entities/index.d.ts.map +1 -1
- package/resources/entities/index.js +8 -0
- package/resources/entities/index.js.map +1 -1
- package/resources/entities/index.mjs +1 -0
- package/resources/entities/index.mjs.map +1 -1
- package/resources/entities/supplemental-documents.d.ts.map +1 -1
- package/resources/event-subscriptions.d.ts.map +1 -1
- package/resources/events.d.ts.map +1 -1
- package/resources/exports.d.ts.map +1 -1
- package/resources/external-accounts.d.ts.map +1 -1
- package/resources/files.d.ts.map +1 -1
- package/resources/groups.d.ts.map +1 -1
- package/resources/inbound-ach-transfer-returns.d.ts.map +1 -1
- package/resources/inbound-wire-drawdown-requests.d.ts.map +1 -1
- package/resources/index.d.ts +6 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +18 -3
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/limits.d.ts +2 -2
- package/resources/limits.d.ts.map +1 -1
- package/resources/oauth-connections.d.ts.map +1 -1
- package/resources/pending-transactions.d.ts +11 -7
- package/resources/pending-transactions.d.ts.map +1 -1
- package/resources/pending-transactions.js.map +1 -1
- package/resources/pending-transactions.mjs.map +1 -1
- package/resources/programs.d.ts.map +1 -1
- package/resources/real-time-decisions.d.ts +49 -7
- package/resources/real-time-decisions.d.ts.map +1 -1
- package/resources/real-time-decisions.js.map +1 -1
- package/resources/real-time-decisions.mjs.map +1 -1
- package/resources/real-time-payments-transfers.d.ts.map +1 -1
- package/resources/routing-numbers.d.ts.map +1 -1
- package/resources/shared.d.ts +2 -0
- package/resources/shared.d.ts.map +1 -1
- package/resources/simulations/account-statements.d.ts.map +1 -1
- package/resources/simulations/ach-transfers.d.ts +952 -26
- package/resources/simulations/ach-transfers.d.ts.map +1 -1
- package/resources/simulations/ach-transfers.js.map +1 -1
- package/resources/simulations/ach-transfers.mjs.map +1 -1
- package/resources/simulations/card-disputes.d.ts.map +1 -1
- package/resources/simulations/card-refunds.d.ts.map +1 -1
- package/resources/simulations/cards.d.ts +20 -14
- package/resources/simulations/cards.d.ts.map +1 -1
- package/resources/simulations/cards.js.map +1 -1
- package/resources/simulations/cards.mjs.map +1 -1
- package/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -1
- package/resources/simulations/documents.d.ts.map +1 -1
- package/resources/simulations/inbound-funds-holds.d.ts +4 -0
- package/resources/simulations/inbound-funds-holds.d.ts.map +1 -1
- package/resources/simulations/inbound-funds-holds.js.map +1 -1
- package/resources/simulations/inbound-funds-holds.mjs.map +1 -1
- package/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -1
- package/resources/simulations/interest-payments.d.ts +951 -19
- package/resources/simulations/interest-payments.d.ts.map +1 -1
- package/resources/simulations/interest-payments.js.map +1 -1
- package/resources/simulations/interest-payments.mjs.map +1 -1
- package/resources/simulations/programs.d.ts.map +1 -1
- package/resources/simulations/real-time-payments-transfers.d.ts +952 -26
- package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
- package/resources/simulations/real-time-payments-transfers.js.map +1 -1
- package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
- package/resources/simulations/simulations.d.ts.map +1 -1
- package/resources/simulations/simulations.js.map +1 -1
- package/resources/simulations/wire-transfers.d.ts +943 -19
- package/resources/simulations/wire-transfers.d.ts.map +1 -1
- package/resources/simulations/wire-transfers.js.map +1 -1
- package/resources/simulations/wire-transfers.mjs.map +1 -1
- package/resources/transactions.d.ts +943 -20
- package/resources/transactions.d.ts.map +1 -1
- package/resources/transactions.js.map +1 -1
- package/resources/transactions.mjs.map +1 -1
- package/resources/wire-drawdown-requests.d.ts.map +1 -1
- package/resources/wire-transfers.d.ts.map +1 -1
- package/src/_shims/ReadableStream.d.ts +38 -0
- package/src/_shims/ReadableStream.js +5 -0
- package/src/_shims/ReadableStream.mjs +7 -0
- package/src/_shims/ReadableStream.node.ts +6 -0
- package/src/_shims/fetch.deno.ts +23 -0
- package/src/_shims/fetch.js +1 -1
- package/src/_shims/formdata.deno.ts +16 -0
- package/src/core.ts +130 -21
- package/src/error.ts +11 -1
- package/src/index.ts +23 -16
- package/src/resources/account-numbers.ts +1 -1
- package/src/resources/account-statements.ts +1 -1
- package/src/resources/account-transfers.ts +1 -1
- package/src/resources/accounts.ts +1 -1
- package/src/resources/ach-prenotifications.ts +1 -1
- package/src/resources/ach-transfers.ts +1 -1
- package/src/resources/balance-lookups.ts +1 -1
- package/src/resources/bookkeeping-accounts.ts +1 -1
- package/src/resources/bookkeeping-entries.ts +1 -1
- package/src/resources/bookkeeping-entry-sets.ts +1 -1
- package/src/resources/card-disputes.ts +1 -1
- package/src/resources/card-profiles.ts +19 -5
- package/src/resources/card-purchase-supplements.ts +331 -0
- package/src/resources/cards.ts +1 -1
- package/src/resources/check-deposits.ts +1 -1
- package/src/resources/check-transfers.ts +208 -113
- package/src/resources/declined-transactions.ts +11 -9
- package/src/resources/digital-wallet-tokens.ts +1 -1
- package/src/resources/documents.ts +1 -1
- package/src/resources/entities/beneficial-owners.ts +255 -0
- package/src/resources/entities/entities.ts +6 -1
- package/src/resources/entities/index.ts +1 -0
- package/src/resources/entities/supplemental-documents.ts +1 -1
- package/src/resources/event-subscriptions.ts +1 -1
- package/src/resources/events.ts +1 -1
- package/src/resources/exports.ts +1 -1
- package/src/resources/external-accounts.ts +1 -1
- package/src/resources/files.ts +1 -1
- package/src/resources/groups.ts +1 -1
- package/src/resources/inbound-ach-transfer-returns.ts +1 -1
- package/src/resources/inbound-wire-drawdown-requests.ts +1 -1
- package/src/resources/index.ts +6 -0
- package/src/resources/limits.ts +3 -3
- package/src/resources/oauth-connections.ts +1 -1
- package/src/resources/pending-transactions.ts +14 -9
- package/src/resources/programs.ts +1 -1
- package/src/resources/real-time-decisions.ts +57 -9
- package/src/resources/real-time-payments-transfers.ts +1 -1
- package/src/resources/routing-numbers.ts +1 -1
- package/src/resources/shared.ts +2 -0
- package/src/resources/simulations/account-statements.ts +1 -1
- package/src/resources/simulations/ach-transfers.ts +1091 -30
- package/src/resources/simulations/card-disputes.ts +1 -1
- package/src/resources/simulations/card-refunds.ts +1 -1
- package/src/resources/simulations/cards.ts +24 -17
- package/src/resources/simulations/digital-wallet-token-requests.ts +1 -1
- package/src/resources/simulations/documents.ts +1 -1
- package/src/resources/simulations/inbound-funds-holds.ts +6 -1
- package/src/resources/simulations/inbound-wire-drawdown-requests.ts +1 -1
- package/src/resources/simulations/interest-payments.ts +1091 -22
- package/src/resources/simulations/programs.ts +1 -1
- package/src/resources/simulations/real-time-payments-transfers.ts +1091 -30
- package/src/resources/simulations/simulations.ts +1 -1
- package/src/resources/simulations/wire-transfers.ts +1081 -22
- package/src/resources/transactions.ts +1081 -23
- package/src/resources/wire-drawdown-requests.ts +1 -1
- package/src/resources/wire-transfers.ts +1 -1
- package/src/uploads.ts +7 -6
- package/src/version.ts +1 -1
- package/uploads.d.ts +5 -4
- package/uploads.d.ts.map +1 -1
- package/uploads.js +2 -2
- package/uploads.js.map +1 -1
- package/uploads.mjs +2 -2
- package/uploads.mjs.map +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -227,6 +227,7 @@ export declare namespace ACHTransferSimulation {
|
|
|
227
227
|
* - `group_locked` - Your account is inactive.
|
|
228
228
|
* - `insufficient_funds` - Your account contains insufficient funds.
|
|
229
229
|
* - `misrouted_return` - Other.
|
|
230
|
+
* - `return_of_erroneous_or_reversing_debit` - Other.
|
|
230
231
|
* - `no_ach_route` - The account number that was debited does not exist.
|
|
231
232
|
* - `originator_request` - Other.
|
|
232
233
|
* - `transaction_not_allowed` - The transaction is not allowed per Increase's
|
|
@@ -242,6 +243,7 @@ export declare namespace ACHTransferSimulation {
|
|
|
242
243
|
| 'group_locked'
|
|
243
244
|
| 'insufficient_funds'
|
|
244
245
|
| 'misrouted_return'
|
|
246
|
+
| 'return_of_erroneous_or_reversing_debit'
|
|
245
247
|
| 'no_ach_route'
|
|
246
248
|
| 'originator_request'
|
|
247
249
|
| 'transaction_not_allowed';
|
|
@@ -302,12 +304,6 @@ export declare namespace ACHTransferSimulation {
|
|
|
302
304
|
* The state the merchant resides in.
|
|
303
305
|
*/
|
|
304
306
|
merchant_state: string | null;
|
|
305
|
-
/**
|
|
306
|
-
* The payment network used to process this card authorization
|
|
307
|
-
*
|
|
308
|
-
* - `visa` - Visa
|
|
309
|
-
*/
|
|
310
|
-
network: 'visa';
|
|
311
307
|
/**
|
|
312
308
|
* Fields specific to the `network`
|
|
313
309
|
*/
|
|
@@ -365,10 +361,16 @@ export declare namespace ACHTransferSimulation {
|
|
|
365
361
|
* Fields specific to the `network`
|
|
366
362
|
*/
|
|
367
363
|
interface NetworkDetails {
|
|
364
|
+
/**
|
|
365
|
+
* The payment network used to process this card authorization
|
|
366
|
+
*
|
|
367
|
+
* - `visa` - Visa
|
|
368
|
+
*/
|
|
369
|
+
category: 'visa';
|
|
368
370
|
/**
|
|
369
371
|
* Fields specific to the `visa` network
|
|
370
372
|
*/
|
|
371
|
-
visa: NetworkDetails.Visa;
|
|
373
|
+
visa: NetworkDetails.Visa | null;
|
|
372
374
|
}
|
|
373
375
|
namespace NetworkDetails {
|
|
374
376
|
/**
|
|
@@ -781,8 +783,6 @@ export declare namespace ACHTransferSimulation {
|
|
|
781
783
|
* Deposit object. Details will be under the `check_transfer_deposit` object.
|
|
782
784
|
* - `check_transfer_intention` - The Transaction was created by a Check Transfer
|
|
783
785
|
* Intention object. Details will be under the `check_transfer_intention` object.
|
|
784
|
-
* - `check_transfer_rejection` - The Transaction was created by a Check Transfer
|
|
785
|
-
* Rejection object. Details will be under the `check_transfer_rejection` object.
|
|
786
786
|
* - `check_transfer_stop_payment_request` - The Transaction was created by a Check
|
|
787
787
|
* Transfer Stop Payment Request object. Details will be under the
|
|
788
788
|
* `check_transfer_stop_payment_request` object.
|
|
@@ -839,7 +839,6 @@ export declare namespace ACHTransferSimulation {
|
|
|
839
839
|
| 'check_deposit_return'
|
|
840
840
|
| 'check_transfer_deposit'
|
|
841
841
|
| 'check_transfer_intention'
|
|
842
|
-
| 'check_transfer_rejection'
|
|
843
842
|
| 'check_transfer_stop_payment_request'
|
|
844
843
|
| 'fee_payment'
|
|
845
844
|
| 'inbound_ach_transfer'
|
|
@@ -878,11 +877,6 @@ export declare namespace ACHTransferSimulation {
|
|
|
878
877
|
* response if and only if `category` is equal to `check_transfer_intention`.
|
|
879
878
|
*/
|
|
880
879
|
check_transfer_intention: Source.CheckTransferIntention | null;
|
|
881
|
-
/**
|
|
882
|
-
* A Check Transfer Rejection object. This field will be present in the JSON
|
|
883
|
-
* response if and only if `category` is equal to `check_transfer_rejection`.
|
|
884
|
-
*/
|
|
885
|
-
check_transfer_rejection: Source.CheckTransferRejection | null;
|
|
886
880
|
/**
|
|
887
881
|
* A Check Transfer Stop Payment Request object. This field will be present in the
|
|
888
882
|
* JSON response if and only if `category` is equal to
|
|
@@ -1350,6 +1344,11 @@ export declare namespace ACHTransferSimulation {
|
|
|
1350
1344
|
* The state the merchant resides in.
|
|
1351
1345
|
*/
|
|
1352
1346
|
merchant_state: string | null;
|
|
1347
|
+
/**
|
|
1348
|
+
* Additional details about the card purchase, such as tax and industry-specific
|
|
1349
|
+
* fields.
|
|
1350
|
+
*/
|
|
1351
|
+
purchase_details: CardRefund.PurchaseDetails | null;
|
|
1353
1352
|
/**
|
|
1354
1353
|
* The identifier of the Transaction associated with this Transaction.
|
|
1355
1354
|
*/
|
|
@@ -1360,6 +1359,468 @@ export declare namespace ACHTransferSimulation {
|
|
|
1360
1359
|
*/
|
|
1361
1360
|
type: 'card_refund';
|
|
1362
1361
|
}
|
|
1362
|
+
namespace CardRefund {
|
|
1363
|
+
/**
|
|
1364
|
+
* Additional details about the card purchase, such as tax and industry-specific
|
|
1365
|
+
* fields.
|
|
1366
|
+
*/
|
|
1367
|
+
interface PurchaseDetails {
|
|
1368
|
+
/**
|
|
1369
|
+
* Fields specific to car rentals.
|
|
1370
|
+
*/
|
|
1371
|
+
car_rental: PurchaseDetails.CarRental | null;
|
|
1372
|
+
/**
|
|
1373
|
+
* An identifier from the merchant for the customer or consumer.
|
|
1374
|
+
*/
|
|
1375
|
+
customer_reference_identifier: string | null;
|
|
1376
|
+
/**
|
|
1377
|
+
* The state or provincial tax amount in minor units.
|
|
1378
|
+
*/
|
|
1379
|
+
local_tax_amount: number | null;
|
|
1380
|
+
/**
|
|
1381
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
|
|
1382
|
+
* assessed.
|
|
1383
|
+
*/
|
|
1384
|
+
local_tax_currency: string | null;
|
|
1385
|
+
/**
|
|
1386
|
+
* Fields specific to lodging.
|
|
1387
|
+
*/
|
|
1388
|
+
lodging: PurchaseDetails.Lodging | null;
|
|
1389
|
+
/**
|
|
1390
|
+
* The national tax amount in minor units.
|
|
1391
|
+
*/
|
|
1392
|
+
national_tax_amount: number | null;
|
|
1393
|
+
/**
|
|
1394
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
|
|
1395
|
+
* assessed.
|
|
1396
|
+
*/
|
|
1397
|
+
national_tax_currency: string | null;
|
|
1398
|
+
/**
|
|
1399
|
+
* An identifier from the merchant for the purchase to the issuer and cardholder.
|
|
1400
|
+
*/
|
|
1401
|
+
purchase_identifier: string | null;
|
|
1402
|
+
/**
|
|
1403
|
+
* The format of the purchase identifier.
|
|
1404
|
+
*
|
|
1405
|
+
* - `free_text` - Free text
|
|
1406
|
+
* - `order_number` - Order number
|
|
1407
|
+
* - `rental_agreement_number` - Rental agreement number
|
|
1408
|
+
* - `hotel_folio_number` - Hotel folio number
|
|
1409
|
+
* - `invoice_number` - Invoice number
|
|
1410
|
+
*/
|
|
1411
|
+
purchase_identifier_format:
|
|
1412
|
+
| 'free_text'
|
|
1413
|
+
| 'order_number'
|
|
1414
|
+
| 'rental_agreement_number'
|
|
1415
|
+
| 'hotel_folio_number'
|
|
1416
|
+
| 'invoice_number'
|
|
1417
|
+
| null;
|
|
1418
|
+
/**
|
|
1419
|
+
* Fields specific to travel.
|
|
1420
|
+
*/
|
|
1421
|
+
travel: PurchaseDetails.Travel | null;
|
|
1422
|
+
}
|
|
1423
|
+
namespace PurchaseDetails {
|
|
1424
|
+
/**
|
|
1425
|
+
* Fields specific to car rentals.
|
|
1426
|
+
*/
|
|
1427
|
+
interface CarRental {
|
|
1428
|
+
/**
|
|
1429
|
+
* Code indicating the vehicle's class.
|
|
1430
|
+
*/
|
|
1431
|
+
car_class_code: string | null;
|
|
1432
|
+
/**
|
|
1433
|
+
* Date the customer picked up the car or, in the case of a no-show or pre-pay
|
|
1434
|
+
* transaction, the scheduled pick up date.
|
|
1435
|
+
*/
|
|
1436
|
+
checkout_date: string | null;
|
|
1437
|
+
/**
|
|
1438
|
+
* Daily rate being charged for the vehicle.
|
|
1439
|
+
*/
|
|
1440
|
+
daily_rental_rate_amount: number | null;
|
|
1441
|
+
/**
|
|
1442
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
|
|
1443
|
+
* rate.
|
|
1444
|
+
*/
|
|
1445
|
+
daily_rental_rate_currency: string | null;
|
|
1446
|
+
/**
|
|
1447
|
+
* Number of days the vehicle was rented.
|
|
1448
|
+
*/
|
|
1449
|
+
days_rented: number | null;
|
|
1450
|
+
/**
|
|
1451
|
+
* Additional charges (gas, late fee, etc.) being billed.
|
|
1452
|
+
*
|
|
1453
|
+
* - `no_extra_charge` - No extra charge
|
|
1454
|
+
* - `gas` - Gas
|
|
1455
|
+
* - `extra_mileage` - Extra mileage
|
|
1456
|
+
* - `late_return` - Late return
|
|
1457
|
+
* - `one_way_service_fee` - One way service fee
|
|
1458
|
+
* - `parking_violation` - Parking violation
|
|
1459
|
+
*/
|
|
1460
|
+
extra_charges:
|
|
1461
|
+
| 'no_extra_charge'
|
|
1462
|
+
| 'gas'
|
|
1463
|
+
| 'extra_mileage'
|
|
1464
|
+
| 'late_return'
|
|
1465
|
+
| 'one_way_service_fee'
|
|
1466
|
+
| 'parking_violation'
|
|
1467
|
+
| null;
|
|
1468
|
+
/**
|
|
1469
|
+
* Fuel charges for the vehicle.
|
|
1470
|
+
*/
|
|
1471
|
+
fuel_charges_amount: number | null;
|
|
1472
|
+
/**
|
|
1473
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
|
|
1474
|
+
* assessed.
|
|
1475
|
+
*/
|
|
1476
|
+
fuel_charges_currency: string | null;
|
|
1477
|
+
/**
|
|
1478
|
+
* Any insurance being charged for the vehicle.
|
|
1479
|
+
*/
|
|
1480
|
+
insurance_charges_amount: number | null;
|
|
1481
|
+
/**
|
|
1482
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
|
|
1483
|
+
* charges assessed.
|
|
1484
|
+
*/
|
|
1485
|
+
insurance_charges_currency: string | null;
|
|
1486
|
+
/**
|
|
1487
|
+
* An indicator that the cardholder is being billed for a reserved vehicle that was
|
|
1488
|
+
* not actually rented (that is, a "no-show" charge).
|
|
1489
|
+
*
|
|
1490
|
+
* - `not_applicable` - Not applicable
|
|
1491
|
+
* - `no_show_for_specialized_vehicle` - No show for specialized vehicle
|
|
1492
|
+
*/
|
|
1493
|
+
no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
|
|
1494
|
+
/**
|
|
1495
|
+
* Charges for returning the vehicle at a different location than where it was
|
|
1496
|
+
* picked up.
|
|
1497
|
+
*/
|
|
1498
|
+
one_way_drop_off_charges_amount: number | null;
|
|
1499
|
+
/**
|
|
1500
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
|
|
1501
|
+
* drop-off charges assessed.
|
|
1502
|
+
*/
|
|
1503
|
+
one_way_drop_off_charges_currency: string | null;
|
|
1504
|
+
/**
|
|
1505
|
+
* Name of the person renting the vehicle.
|
|
1506
|
+
*/
|
|
1507
|
+
renter_name: string | null;
|
|
1508
|
+
/**
|
|
1509
|
+
* Weekly rate being charged for the vehicle.
|
|
1510
|
+
*/
|
|
1511
|
+
weekly_rental_rate_amount: number | null;
|
|
1512
|
+
/**
|
|
1513
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
|
|
1514
|
+
* rental rate.
|
|
1515
|
+
*/
|
|
1516
|
+
weekly_rental_rate_currency: string | null;
|
|
1517
|
+
}
|
|
1518
|
+
/**
|
|
1519
|
+
* Fields specific to lodging.
|
|
1520
|
+
*/
|
|
1521
|
+
interface Lodging {
|
|
1522
|
+
/**
|
|
1523
|
+
* Date the customer checked in.
|
|
1524
|
+
*/
|
|
1525
|
+
check_in_date: string | null;
|
|
1526
|
+
/**
|
|
1527
|
+
* Daily rate being charged for the room.
|
|
1528
|
+
*/
|
|
1529
|
+
daily_room_rate_amount: number | null;
|
|
1530
|
+
/**
|
|
1531
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
|
|
1532
|
+
* rate.
|
|
1533
|
+
*/
|
|
1534
|
+
daily_room_rate_currency: string | null;
|
|
1535
|
+
/**
|
|
1536
|
+
* Additional charges (phone, late check-out, etc.) being billed.
|
|
1537
|
+
*
|
|
1538
|
+
* - `no_extra_charge` - No extra charge
|
|
1539
|
+
* - `restaurant` - Restaurant
|
|
1540
|
+
* - `gift_shop` - Gift shop
|
|
1541
|
+
* - `mini_bar` - Mini bar
|
|
1542
|
+
* - `telephone` - Telephone
|
|
1543
|
+
* - `other` - Other
|
|
1544
|
+
* - `laundry` - Laundry
|
|
1545
|
+
*/
|
|
1546
|
+
extra_charges:
|
|
1547
|
+
| 'no_extra_charge'
|
|
1548
|
+
| 'restaurant'
|
|
1549
|
+
| 'gift_shop'
|
|
1550
|
+
| 'mini_bar'
|
|
1551
|
+
| 'telephone'
|
|
1552
|
+
| 'other'
|
|
1553
|
+
| 'laundry'
|
|
1554
|
+
| null;
|
|
1555
|
+
/**
|
|
1556
|
+
* Folio cash advances for the room.
|
|
1557
|
+
*/
|
|
1558
|
+
folio_cash_advances_amount: number | null;
|
|
1559
|
+
/**
|
|
1560
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
|
|
1561
|
+
* advances.
|
|
1562
|
+
*/
|
|
1563
|
+
folio_cash_advances_currency: string | null;
|
|
1564
|
+
/**
|
|
1565
|
+
* Food and beverage charges for the room.
|
|
1566
|
+
*/
|
|
1567
|
+
food_beverage_charges_amount: number | null;
|
|
1568
|
+
/**
|
|
1569
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
|
|
1570
|
+
* beverage charges.
|
|
1571
|
+
*/
|
|
1572
|
+
food_beverage_charges_currency: string | null;
|
|
1573
|
+
/**
|
|
1574
|
+
* Indicator that the cardholder is being billed for a reserved room that was not
|
|
1575
|
+
* actually used.
|
|
1576
|
+
*
|
|
1577
|
+
* - `not_applicable` - Not applicable
|
|
1578
|
+
* - `no_show` - No show
|
|
1579
|
+
*/
|
|
1580
|
+
no_show_indicator: 'not_applicable' | 'no_show' | null;
|
|
1581
|
+
/**
|
|
1582
|
+
* Prepaid expenses being charged for the room.
|
|
1583
|
+
*/
|
|
1584
|
+
prepaid_expenses_amount: number | null;
|
|
1585
|
+
/**
|
|
1586
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
|
|
1587
|
+
* expenses.
|
|
1588
|
+
*/
|
|
1589
|
+
prepaid_expenses_currency: string | null;
|
|
1590
|
+
/**
|
|
1591
|
+
* Number of nights the room was rented.
|
|
1592
|
+
*/
|
|
1593
|
+
room_nights: number | null;
|
|
1594
|
+
/**
|
|
1595
|
+
* Total room tax being charged.
|
|
1596
|
+
*/
|
|
1597
|
+
total_room_tax_amount: number | null;
|
|
1598
|
+
/**
|
|
1599
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
|
|
1600
|
+
* tax.
|
|
1601
|
+
*/
|
|
1602
|
+
total_room_tax_currency: string | null;
|
|
1603
|
+
/**
|
|
1604
|
+
* Total tax being charged for the room.
|
|
1605
|
+
*/
|
|
1606
|
+
total_tax_amount: number | null;
|
|
1607
|
+
/**
|
|
1608
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
|
|
1609
|
+
* assessed.
|
|
1610
|
+
*/
|
|
1611
|
+
total_tax_currency: string | null;
|
|
1612
|
+
}
|
|
1613
|
+
/**
|
|
1614
|
+
* Fields specific to travel.
|
|
1615
|
+
*/
|
|
1616
|
+
interface Travel {
|
|
1617
|
+
/**
|
|
1618
|
+
* Ancillary purchases in addition to the airfare.
|
|
1619
|
+
*/
|
|
1620
|
+
ancillary: Travel.Ancillary | null;
|
|
1621
|
+
/**
|
|
1622
|
+
* Indicates the computerized reservation system used to book the ticket.
|
|
1623
|
+
*/
|
|
1624
|
+
computerized_reservation_system: string | null;
|
|
1625
|
+
/**
|
|
1626
|
+
* Indicates the reason for a credit to the cardholder.
|
|
1627
|
+
*
|
|
1628
|
+
* - `no_credit` - No credit
|
|
1629
|
+
* - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
|
|
1630
|
+
* ancillary purchase cancellation
|
|
1631
|
+
* - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
|
|
1632
|
+
* Airline ticket and passenger transport ancillary purchase cancellation
|
|
1633
|
+
* - `airline_ticket_cancellation` - Airline ticket cancellation
|
|
1634
|
+
* - `other` - Other
|
|
1635
|
+
* - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
|
|
1636
|
+
*/
|
|
1637
|
+
credit_reason_indicator:
|
|
1638
|
+
| 'no_credit'
|
|
1639
|
+
| 'passenger_transport_ancillary_purchase_cancellation'
|
|
1640
|
+
| 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
|
|
1641
|
+
| 'airline_ticket_cancellation'
|
|
1642
|
+
| 'other'
|
|
1643
|
+
| 'partial_refund_of_airline_ticket'
|
|
1644
|
+
| null;
|
|
1645
|
+
/**
|
|
1646
|
+
* Date of departure.
|
|
1647
|
+
*/
|
|
1648
|
+
departure_date: string | null;
|
|
1649
|
+
/**
|
|
1650
|
+
* Code for the originating city or airport.
|
|
1651
|
+
*/
|
|
1652
|
+
origination_city_airport_code: string | null;
|
|
1653
|
+
/**
|
|
1654
|
+
* Name of the passenger.
|
|
1655
|
+
*/
|
|
1656
|
+
passenger_name: string | null;
|
|
1657
|
+
/**
|
|
1658
|
+
* Indicates whether this ticket is non-refundable.
|
|
1659
|
+
*
|
|
1660
|
+
* - `no_restrictions` - No restrictions
|
|
1661
|
+
* - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
|
|
1662
|
+
*/
|
|
1663
|
+
restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
|
|
1664
|
+
/**
|
|
1665
|
+
* Indicates why a ticket was changed.
|
|
1666
|
+
*
|
|
1667
|
+
* - `none` - None
|
|
1668
|
+
* - `change_to_existing_ticket` - Change to existing ticket
|
|
1669
|
+
* - `new_ticket` - New ticket
|
|
1670
|
+
*/
|
|
1671
|
+
ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
|
|
1672
|
+
/**
|
|
1673
|
+
* Ticket number.
|
|
1674
|
+
*/
|
|
1675
|
+
ticket_number: string | null;
|
|
1676
|
+
/**
|
|
1677
|
+
* Code for the travel agency if the ticket was issued by a travel agency.
|
|
1678
|
+
*/
|
|
1679
|
+
travel_agency_code: string | null;
|
|
1680
|
+
/**
|
|
1681
|
+
* Name of the travel agency if the ticket was issued by a travel agency.
|
|
1682
|
+
*/
|
|
1683
|
+
travel_agency_name: string | null;
|
|
1684
|
+
/**
|
|
1685
|
+
* Fields specific to each leg of the journey.
|
|
1686
|
+
*/
|
|
1687
|
+
trip_legs: Array<Travel.TripLeg> | null;
|
|
1688
|
+
}
|
|
1689
|
+
namespace Travel {
|
|
1690
|
+
/**
|
|
1691
|
+
* Ancillary purchases in addition to the airfare.
|
|
1692
|
+
*/
|
|
1693
|
+
interface Ancillary {
|
|
1694
|
+
/**
|
|
1695
|
+
* If this purchase has a connection or relationship to another purchase, such as a
|
|
1696
|
+
* baggage fee for a passenger transport ticket, this field should contain the
|
|
1697
|
+
* ticket document number for the other purchase.
|
|
1698
|
+
*/
|
|
1699
|
+
connected_ticket_document_number: string | null;
|
|
1700
|
+
/**
|
|
1701
|
+
* Indicates the reason for a credit to the cardholder.
|
|
1702
|
+
*
|
|
1703
|
+
* - `no_credit` - No credit
|
|
1704
|
+
* - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
|
|
1705
|
+
* ancillary purchase cancellation
|
|
1706
|
+
* - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
|
|
1707
|
+
* Airline ticket and passenger transport ancillary purchase cancellation
|
|
1708
|
+
* - `other` - Other
|
|
1709
|
+
*/
|
|
1710
|
+
credit_reason_indicator:
|
|
1711
|
+
| 'no_credit'
|
|
1712
|
+
| 'passenger_transport_ancillary_purchase_cancellation'
|
|
1713
|
+
| 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
|
|
1714
|
+
| 'other'
|
|
1715
|
+
| null;
|
|
1716
|
+
/**
|
|
1717
|
+
* Name of the passenger or description of the ancillary purchase.
|
|
1718
|
+
*/
|
|
1719
|
+
passenger_name_or_description: string | null;
|
|
1720
|
+
/**
|
|
1721
|
+
* Additional travel charges, such as baggage fees.
|
|
1722
|
+
*/
|
|
1723
|
+
services: Array<Ancillary.Service>;
|
|
1724
|
+
/**
|
|
1725
|
+
* Ticket document number.
|
|
1726
|
+
*/
|
|
1727
|
+
ticket_document_number: string | null;
|
|
1728
|
+
}
|
|
1729
|
+
namespace Ancillary {
|
|
1730
|
+
interface Service {
|
|
1731
|
+
/**
|
|
1732
|
+
* Category of the ancillary service.
|
|
1733
|
+
*
|
|
1734
|
+
* - `none` - None
|
|
1735
|
+
* - `bundled_service` - Bundled service
|
|
1736
|
+
* - `baggage_fee` - Baggage fee
|
|
1737
|
+
* - `change_fee` - Change fee
|
|
1738
|
+
* - `cargo` - Cargo
|
|
1739
|
+
* - `carbon_offset` - Carbon offset
|
|
1740
|
+
* - `frequent_flyer` - Frequent flyer
|
|
1741
|
+
* - `gift_card` - Gift card
|
|
1742
|
+
* - `ground_transport` - Ground transport
|
|
1743
|
+
* - `in_flight_entertainment` - In-flight entertainment
|
|
1744
|
+
* - `lounge` - Lounge
|
|
1745
|
+
* - `medical` - Medical
|
|
1746
|
+
* - `meal_beverage` - Meal beverage
|
|
1747
|
+
* - `other` - Other
|
|
1748
|
+
* - `passenger_assist_fee` - Passenger assist fee
|
|
1749
|
+
* - `pets` - Pets
|
|
1750
|
+
* - `seat_fees` - Seat fees
|
|
1751
|
+
* - `standby` - Standby
|
|
1752
|
+
* - `service_fee` - Service fee
|
|
1753
|
+
* - `store` - Store
|
|
1754
|
+
* - `travel_service` - Travel service
|
|
1755
|
+
* - `unaccompanied_travel` - Unaccompanied travel
|
|
1756
|
+
* - `upgrades` - Upgrades
|
|
1757
|
+
* - `wifi` - Wi-fi
|
|
1758
|
+
*/
|
|
1759
|
+
category:
|
|
1760
|
+
| 'none'
|
|
1761
|
+
| 'bundled_service'
|
|
1762
|
+
| 'baggage_fee'
|
|
1763
|
+
| 'change_fee'
|
|
1764
|
+
| 'cargo'
|
|
1765
|
+
| 'carbon_offset'
|
|
1766
|
+
| 'frequent_flyer'
|
|
1767
|
+
| 'gift_card'
|
|
1768
|
+
| 'ground_transport'
|
|
1769
|
+
| 'in_flight_entertainment'
|
|
1770
|
+
| 'lounge'
|
|
1771
|
+
| 'medical'
|
|
1772
|
+
| 'meal_beverage'
|
|
1773
|
+
| 'other'
|
|
1774
|
+
| 'passenger_assist_fee'
|
|
1775
|
+
| 'pets'
|
|
1776
|
+
| 'seat_fees'
|
|
1777
|
+
| 'standby'
|
|
1778
|
+
| 'service_fee'
|
|
1779
|
+
| 'store'
|
|
1780
|
+
| 'travel_service'
|
|
1781
|
+
| 'unaccompanied_travel'
|
|
1782
|
+
| 'upgrades'
|
|
1783
|
+
| 'wifi'
|
|
1784
|
+
| null;
|
|
1785
|
+
/**
|
|
1786
|
+
* Sub-category of the ancillary service, free-form.
|
|
1787
|
+
*/
|
|
1788
|
+
sub_category: string | null;
|
|
1789
|
+
}
|
|
1790
|
+
}
|
|
1791
|
+
interface TripLeg {
|
|
1792
|
+
/**
|
|
1793
|
+
* Carrier code (e.g., United Airlines, Jet Blue, etc.).
|
|
1794
|
+
*/
|
|
1795
|
+
carrier_code: string | null;
|
|
1796
|
+
/**
|
|
1797
|
+
* Code for the destination city or airport.
|
|
1798
|
+
*/
|
|
1799
|
+
destination_city_airport_code: string | null;
|
|
1800
|
+
/**
|
|
1801
|
+
* Fare basis code.
|
|
1802
|
+
*/
|
|
1803
|
+
fare_basis_code: string | null;
|
|
1804
|
+
/**
|
|
1805
|
+
* Flight number.
|
|
1806
|
+
*/
|
|
1807
|
+
flight_number: string | null;
|
|
1808
|
+
/**
|
|
1809
|
+
* Service class (e.g., first class, business class, etc.).
|
|
1810
|
+
*/
|
|
1811
|
+
service_class: string | null;
|
|
1812
|
+
/**
|
|
1813
|
+
* Indicates whether a stopover is allowed on this ticket.
|
|
1814
|
+
*
|
|
1815
|
+
* - `none` - None
|
|
1816
|
+
* - `stop_over_allowed` - Stop over allowed
|
|
1817
|
+
* - `stop_over_not_allowed` - Stop over not allowed
|
|
1818
|
+
*/
|
|
1819
|
+
stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
|
|
1820
|
+
}
|
|
1821
|
+
}
|
|
1822
|
+
}
|
|
1823
|
+
}
|
|
1363
1824
|
/**
|
|
1364
1825
|
* A Card Revenue Payment object. This field will be present in the JSON response
|
|
1365
1826
|
* if and only if `category` is equal to `card_revenue_payment`.
|
|
@@ -1464,6 +1925,11 @@ export declare namespace ACHTransferSimulation {
|
|
|
1464
1925
|
* transaction's presentment currency.
|
|
1465
1926
|
*/
|
|
1466
1927
|
presentment_currency: string;
|
|
1928
|
+
/**
|
|
1929
|
+
* Additional details about the card purchase, such as tax and industry-specific
|
|
1930
|
+
* fields.
|
|
1931
|
+
*/
|
|
1932
|
+
purchase_details: CardSettlement.PurchaseDetails | null;
|
|
1467
1933
|
/**
|
|
1468
1934
|
* The identifier of the Transaction associated with this Transaction.
|
|
1469
1935
|
*/
|
|
@@ -1474,6 +1940,468 @@ export declare namespace ACHTransferSimulation {
|
|
|
1474
1940
|
*/
|
|
1475
1941
|
type: 'card_settlement';
|
|
1476
1942
|
}
|
|
1943
|
+
namespace CardSettlement {
|
|
1944
|
+
/**
|
|
1945
|
+
* Additional details about the card purchase, such as tax and industry-specific
|
|
1946
|
+
* fields.
|
|
1947
|
+
*/
|
|
1948
|
+
interface PurchaseDetails {
|
|
1949
|
+
/**
|
|
1950
|
+
* Fields specific to car rentals.
|
|
1951
|
+
*/
|
|
1952
|
+
car_rental: PurchaseDetails.CarRental | null;
|
|
1953
|
+
/**
|
|
1954
|
+
* An identifier from the merchant for the customer or consumer.
|
|
1955
|
+
*/
|
|
1956
|
+
customer_reference_identifier: string | null;
|
|
1957
|
+
/**
|
|
1958
|
+
* The state or provincial tax amount in minor units.
|
|
1959
|
+
*/
|
|
1960
|
+
local_tax_amount: number | null;
|
|
1961
|
+
/**
|
|
1962
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
|
|
1963
|
+
* assessed.
|
|
1964
|
+
*/
|
|
1965
|
+
local_tax_currency: string | null;
|
|
1966
|
+
/**
|
|
1967
|
+
* Fields specific to lodging.
|
|
1968
|
+
*/
|
|
1969
|
+
lodging: PurchaseDetails.Lodging | null;
|
|
1970
|
+
/**
|
|
1971
|
+
* The national tax amount in minor units.
|
|
1972
|
+
*/
|
|
1973
|
+
national_tax_amount: number | null;
|
|
1974
|
+
/**
|
|
1975
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
|
|
1976
|
+
* assessed.
|
|
1977
|
+
*/
|
|
1978
|
+
national_tax_currency: string | null;
|
|
1979
|
+
/**
|
|
1980
|
+
* An identifier from the merchant for the purchase to the issuer and cardholder.
|
|
1981
|
+
*/
|
|
1982
|
+
purchase_identifier: string | null;
|
|
1983
|
+
/**
|
|
1984
|
+
* The format of the purchase identifier.
|
|
1985
|
+
*
|
|
1986
|
+
* - `free_text` - Free text
|
|
1987
|
+
* - `order_number` - Order number
|
|
1988
|
+
* - `rental_agreement_number` - Rental agreement number
|
|
1989
|
+
* - `hotel_folio_number` - Hotel folio number
|
|
1990
|
+
* - `invoice_number` - Invoice number
|
|
1991
|
+
*/
|
|
1992
|
+
purchase_identifier_format:
|
|
1993
|
+
| 'free_text'
|
|
1994
|
+
| 'order_number'
|
|
1995
|
+
| 'rental_agreement_number'
|
|
1996
|
+
| 'hotel_folio_number'
|
|
1997
|
+
| 'invoice_number'
|
|
1998
|
+
| null;
|
|
1999
|
+
/**
|
|
2000
|
+
* Fields specific to travel.
|
|
2001
|
+
*/
|
|
2002
|
+
travel: PurchaseDetails.Travel | null;
|
|
2003
|
+
}
|
|
2004
|
+
namespace PurchaseDetails {
|
|
2005
|
+
/**
|
|
2006
|
+
* Fields specific to car rentals.
|
|
2007
|
+
*/
|
|
2008
|
+
interface CarRental {
|
|
2009
|
+
/**
|
|
2010
|
+
* Code indicating the vehicle's class.
|
|
2011
|
+
*/
|
|
2012
|
+
car_class_code: string | null;
|
|
2013
|
+
/**
|
|
2014
|
+
* Date the customer picked up the car or, in the case of a no-show or pre-pay
|
|
2015
|
+
* transaction, the scheduled pick up date.
|
|
2016
|
+
*/
|
|
2017
|
+
checkout_date: string | null;
|
|
2018
|
+
/**
|
|
2019
|
+
* Daily rate being charged for the vehicle.
|
|
2020
|
+
*/
|
|
2021
|
+
daily_rental_rate_amount: number | null;
|
|
2022
|
+
/**
|
|
2023
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
|
|
2024
|
+
* rate.
|
|
2025
|
+
*/
|
|
2026
|
+
daily_rental_rate_currency: string | null;
|
|
2027
|
+
/**
|
|
2028
|
+
* Number of days the vehicle was rented.
|
|
2029
|
+
*/
|
|
2030
|
+
days_rented: number | null;
|
|
2031
|
+
/**
|
|
2032
|
+
* Additional charges (gas, late fee, etc.) being billed.
|
|
2033
|
+
*
|
|
2034
|
+
* - `no_extra_charge` - No extra charge
|
|
2035
|
+
* - `gas` - Gas
|
|
2036
|
+
* - `extra_mileage` - Extra mileage
|
|
2037
|
+
* - `late_return` - Late return
|
|
2038
|
+
* - `one_way_service_fee` - One way service fee
|
|
2039
|
+
* - `parking_violation` - Parking violation
|
|
2040
|
+
*/
|
|
2041
|
+
extra_charges:
|
|
2042
|
+
| 'no_extra_charge'
|
|
2043
|
+
| 'gas'
|
|
2044
|
+
| 'extra_mileage'
|
|
2045
|
+
| 'late_return'
|
|
2046
|
+
| 'one_way_service_fee'
|
|
2047
|
+
| 'parking_violation'
|
|
2048
|
+
| null;
|
|
2049
|
+
/**
|
|
2050
|
+
* Fuel charges for the vehicle.
|
|
2051
|
+
*/
|
|
2052
|
+
fuel_charges_amount: number | null;
|
|
2053
|
+
/**
|
|
2054
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
|
|
2055
|
+
* assessed.
|
|
2056
|
+
*/
|
|
2057
|
+
fuel_charges_currency: string | null;
|
|
2058
|
+
/**
|
|
2059
|
+
* Any insurance being charged for the vehicle.
|
|
2060
|
+
*/
|
|
2061
|
+
insurance_charges_amount: number | null;
|
|
2062
|
+
/**
|
|
2063
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
|
|
2064
|
+
* charges assessed.
|
|
2065
|
+
*/
|
|
2066
|
+
insurance_charges_currency: string | null;
|
|
2067
|
+
/**
|
|
2068
|
+
* An indicator that the cardholder is being billed for a reserved vehicle that was
|
|
2069
|
+
* not actually rented (that is, a "no-show" charge).
|
|
2070
|
+
*
|
|
2071
|
+
* - `not_applicable` - Not applicable
|
|
2072
|
+
* - `no_show_for_specialized_vehicle` - No show for specialized vehicle
|
|
2073
|
+
*/
|
|
2074
|
+
no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
|
|
2075
|
+
/**
|
|
2076
|
+
* Charges for returning the vehicle at a different location than where it was
|
|
2077
|
+
* picked up.
|
|
2078
|
+
*/
|
|
2079
|
+
one_way_drop_off_charges_amount: number | null;
|
|
2080
|
+
/**
|
|
2081
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
|
|
2082
|
+
* drop-off charges assessed.
|
|
2083
|
+
*/
|
|
2084
|
+
one_way_drop_off_charges_currency: string | null;
|
|
2085
|
+
/**
|
|
2086
|
+
* Name of the person renting the vehicle.
|
|
2087
|
+
*/
|
|
2088
|
+
renter_name: string | null;
|
|
2089
|
+
/**
|
|
2090
|
+
* Weekly rate being charged for the vehicle.
|
|
2091
|
+
*/
|
|
2092
|
+
weekly_rental_rate_amount: number | null;
|
|
2093
|
+
/**
|
|
2094
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
|
|
2095
|
+
* rental rate.
|
|
2096
|
+
*/
|
|
2097
|
+
weekly_rental_rate_currency: string | null;
|
|
2098
|
+
}
|
|
2099
|
+
/**
|
|
2100
|
+
* Fields specific to lodging.
|
|
2101
|
+
*/
|
|
2102
|
+
interface Lodging {
|
|
2103
|
+
/**
|
|
2104
|
+
* Date the customer checked in.
|
|
2105
|
+
*/
|
|
2106
|
+
check_in_date: string | null;
|
|
2107
|
+
/**
|
|
2108
|
+
* Daily rate being charged for the room.
|
|
2109
|
+
*/
|
|
2110
|
+
daily_room_rate_amount: number | null;
|
|
2111
|
+
/**
|
|
2112
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
|
|
2113
|
+
* rate.
|
|
2114
|
+
*/
|
|
2115
|
+
daily_room_rate_currency: string | null;
|
|
2116
|
+
/**
|
|
2117
|
+
* Additional charges (phone, late check-out, etc.) being billed.
|
|
2118
|
+
*
|
|
2119
|
+
* - `no_extra_charge` - No extra charge
|
|
2120
|
+
* - `restaurant` - Restaurant
|
|
2121
|
+
* - `gift_shop` - Gift shop
|
|
2122
|
+
* - `mini_bar` - Mini bar
|
|
2123
|
+
* - `telephone` - Telephone
|
|
2124
|
+
* - `other` - Other
|
|
2125
|
+
* - `laundry` - Laundry
|
|
2126
|
+
*/
|
|
2127
|
+
extra_charges:
|
|
2128
|
+
| 'no_extra_charge'
|
|
2129
|
+
| 'restaurant'
|
|
2130
|
+
| 'gift_shop'
|
|
2131
|
+
| 'mini_bar'
|
|
2132
|
+
| 'telephone'
|
|
2133
|
+
| 'other'
|
|
2134
|
+
| 'laundry'
|
|
2135
|
+
| null;
|
|
2136
|
+
/**
|
|
2137
|
+
* Folio cash advances for the room.
|
|
2138
|
+
*/
|
|
2139
|
+
folio_cash_advances_amount: number | null;
|
|
2140
|
+
/**
|
|
2141
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
|
|
2142
|
+
* advances.
|
|
2143
|
+
*/
|
|
2144
|
+
folio_cash_advances_currency: string | null;
|
|
2145
|
+
/**
|
|
2146
|
+
* Food and beverage charges for the room.
|
|
2147
|
+
*/
|
|
2148
|
+
food_beverage_charges_amount: number | null;
|
|
2149
|
+
/**
|
|
2150
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
|
|
2151
|
+
* beverage charges.
|
|
2152
|
+
*/
|
|
2153
|
+
food_beverage_charges_currency: string | null;
|
|
2154
|
+
/**
|
|
2155
|
+
* Indicator that the cardholder is being billed for a reserved room that was not
|
|
2156
|
+
* actually used.
|
|
2157
|
+
*
|
|
2158
|
+
* - `not_applicable` - Not applicable
|
|
2159
|
+
* - `no_show` - No show
|
|
2160
|
+
*/
|
|
2161
|
+
no_show_indicator: 'not_applicable' | 'no_show' | null;
|
|
2162
|
+
/**
|
|
2163
|
+
* Prepaid expenses being charged for the room.
|
|
2164
|
+
*/
|
|
2165
|
+
prepaid_expenses_amount: number | null;
|
|
2166
|
+
/**
|
|
2167
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
|
|
2168
|
+
* expenses.
|
|
2169
|
+
*/
|
|
2170
|
+
prepaid_expenses_currency: string | null;
|
|
2171
|
+
/**
|
|
2172
|
+
* Number of nights the room was rented.
|
|
2173
|
+
*/
|
|
2174
|
+
room_nights: number | null;
|
|
2175
|
+
/**
|
|
2176
|
+
* Total room tax being charged.
|
|
2177
|
+
*/
|
|
2178
|
+
total_room_tax_amount: number | null;
|
|
2179
|
+
/**
|
|
2180
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
|
|
2181
|
+
* tax.
|
|
2182
|
+
*/
|
|
2183
|
+
total_room_tax_currency: string | null;
|
|
2184
|
+
/**
|
|
2185
|
+
* Total tax being charged for the room.
|
|
2186
|
+
*/
|
|
2187
|
+
total_tax_amount: number | null;
|
|
2188
|
+
/**
|
|
2189
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
|
|
2190
|
+
* assessed.
|
|
2191
|
+
*/
|
|
2192
|
+
total_tax_currency: string | null;
|
|
2193
|
+
}
|
|
2194
|
+
/**
|
|
2195
|
+
* Fields specific to travel.
|
|
2196
|
+
*/
|
|
2197
|
+
interface Travel {
|
|
2198
|
+
/**
|
|
2199
|
+
* Ancillary purchases in addition to the airfare.
|
|
2200
|
+
*/
|
|
2201
|
+
ancillary: Travel.Ancillary | null;
|
|
2202
|
+
/**
|
|
2203
|
+
* Indicates the computerized reservation system used to book the ticket.
|
|
2204
|
+
*/
|
|
2205
|
+
computerized_reservation_system: string | null;
|
|
2206
|
+
/**
|
|
2207
|
+
* Indicates the reason for a credit to the cardholder.
|
|
2208
|
+
*
|
|
2209
|
+
* - `no_credit` - No credit
|
|
2210
|
+
* - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
|
|
2211
|
+
* ancillary purchase cancellation
|
|
2212
|
+
* - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
|
|
2213
|
+
* Airline ticket and passenger transport ancillary purchase cancellation
|
|
2214
|
+
* - `airline_ticket_cancellation` - Airline ticket cancellation
|
|
2215
|
+
* - `other` - Other
|
|
2216
|
+
* - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
|
|
2217
|
+
*/
|
|
2218
|
+
credit_reason_indicator:
|
|
2219
|
+
| 'no_credit'
|
|
2220
|
+
| 'passenger_transport_ancillary_purchase_cancellation'
|
|
2221
|
+
| 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
|
|
2222
|
+
| 'airline_ticket_cancellation'
|
|
2223
|
+
| 'other'
|
|
2224
|
+
| 'partial_refund_of_airline_ticket'
|
|
2225
|
+
| null;
|
|
2226
|
+
/**
|
|
2227
|
+
* Date of departure.
|
|
2228
|
+
*/
|
|
2229
|
+
departure_date: string | null;
|
|
2230
|
+
/**
|
|
2231
|
+
* Code for the originating city or airport.
|
|
2232
|
+
*/
|
|
2233
|
+
origination_city_airport_code: string | null;
|
|
2234
|
+
/**
|
|
2235
|
+
* Name of the passenger.
|
|
2236
|
+
*/
|
|
2237
|
+
passenger_name: string | null;
|
|
2238
|
+
/**
|
|
2239
|
+
* Indicates whether this ticket is non-refundable.
|
|
2240
|
+
*
|
|
2241
|
+
* - `no_restrictions` - No restrictions
|
|
2242
|
+
* - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
|
|
2243
|
+
*/
|
|
2244
|
+
restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
|
|
2245
|
+
/**
|
|
2246
|
+
* Indicates why a ticket was changed.
|
|
2247
|
+
*
|
|
2248
|
+
* - `none` - None
|
|
2249
|
+
* - `change_to_existing_ticket` - Change to existing ticket
|
|
2250
|
+
* - `new_ticket` - New ticket
|
|
2251
|
+
*/
|
|
2252
|
+
ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
|
|
2253
|
+
/**
|
|
2254
|
+
* Ticket number.
|
|
2255
|
+
*/
|
|
2256
|
+
ticket_number: string | null;
|
|
2257
|
+
/**
|
|
2258
|
+
* Code for the travel agency if the ticket was issued by a travel agency.
|
|
2259
|
+
*/
|
|
2260
|
+
travel_agency_code: string | null;
|
|
2261
|
+
/**
|
|
2262
|
+
* Name of the travel agency if the ticket was issued by a travel agency.
|
|
2263
|
+
*/
|
|
2264
|
+
travel_agency_name: string | null;
|
|
2265
|
+
/**
|
|
2266
|
+
* Fields specific to each leg of the journey.
|
|
2267
|
+
*/
|
|
2268
|
+
trip_legs: Array<Travel.TripLeg> | null;
|
|
2269
|
+
}
|
|
2270
|
+
namespace Travel {
|
|
2271
|
+
/**
|
|
2272
|
+
* Ancillary purchases in addition to the airfare.
|
|
2273
|
+
*/
|
|
2274
|
+
interface Ancillary {
|
|
2275
|
+
/**
|
|
2276
|
+
* If this purchase has a connection or relationship to another purchase, such as a
|
|
2277
|
+
* baggage fee for a passenger transport ticket, this field should contain the
|
|
2278
|
+
* ticket document number for the other purchase.
|
|
2279
|
+
*/
|
|
2280
|
+
connected_ticket_document_number: string | null;
|
|
2281
|
+
/**
|
|
2282
|
+
* Indicates the reason for a credit to the cardholder.
|
|
2283
|
+
*
|
|
2284
|
+
* - `no_credit` - No credit
|
|
2285
|
+
* - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
|
|
2286
|
+
* ancillary purchase cancellation
|
|
2287
|
+
* - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
|
|
2288
|
+
* Airline ticket and passenger transport ancillary purchase cancellation
|
|
2289
|
+
* - `other` - Other
|
|
2290
|
+
*/
|
|
2291
|
+
credit_reason_indicator:
|
|
2292
|
+
| 'no_credit'
|
|
2293
|
+
| 'passenger_transport_ancillary_purchase_cancellation'
|
|
2294
|
+
| 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
|
|
2295
|
+
| 'other'
|
|
2296
|
+
| null;
|
|
2297
|
+
/**
|
|
2298
|
+
* Name of the passenger or description of the ancillary purchase.
|
|
2299
|
+
*/
|
|
2300
|
+
passenger_name_or_description: string | null;
|
|
2301
|
+
/**
|
|
2302
|
+
* Additional travel charges, such as baggage fees.
|
|
2303
|
+
*/
|
|
2304
|
+
services: Array<Ancillary.Service>;
|
|
2305
|
+
/**
|
|
2306
|
+
* Ticket document number.
|
|
2307
|
+
*/
|
|
2308
|
+
ticket_document_number: string | null;
|
|
2309
|
+
}
|
|
2310
|
+
namespace Ancillary {
|
|
2311
|
+
interface Service {
|
|
2312
|
+
/**
|
|
2313
|
+
* Category of the ancillary service.
|
|
2314
|
+
*
|
|
2315
|
+
* - `none` - None
|
|
2316
|
+
* - `bundled_service` - Bundled service
|
|
2317
|
+
* - `baggage_fee` - Baggage fee
|
|
2318
|
+
* - `change_fee` - Change fee
|
|
2319
|
+
* - `cargo` - Cargo
|
|
2320
|
+
* - `carbon_offset` - Carbon offset
|
|
2321
|
+
* - `frequent_flyer` - Frequent flyer
|
|
2322
|
+
* - `gift_card` - Gift card
|
|
2323
|
+
* - `ground_transport` - Ground transport
|
|
2324
|
+
* - `in_flight_entertainment` - In-flight entertainment
|
|
2325
|
+
* - `lounge` - Lounge
|
|
2326
|
+
* - `medical` - Medical
|
|
2327
|
+
* - `meal_beverage` - Meal beverage
|
|
2328
|
+
* - `other` - Other
|
|
2329
|
+
* - `passenger_assist_fee` - Passenger assist fee
|
|
2330
|
+
* - `pets` - Pets
|
|
2331
|
+
* - `seat_fees` - Seat fees
|
|
2332
|
+
* - `standby` - Standby
|
|
2333
|
+
* - `service_fee` - Service fee
|
|
2334
|
+
* - `store` - Store
|
|
2335
|
+
* - `travel_service` - Travel service
|
|
2336
|
+
* - `unaccompanied_travel` - Unaccompanied travel
|
|
2337
|
+
* - `upgrades` - Upgrades
|
|
2338
|
+
* - `wifi` - Wi-fi
|
|
2339
|
+
*/
|
|
2340
|
+
category:
|
|
2341
|
+
| 'none'
|
|
2342
|
+
| 'bundled_service'
|
|
2343
|
+
| 'baggage_fee'
|
|
2344
|
+
| 'change_fee'
|
|
2345
|
+
| 'cargo'
|
|
2346
|
+
| 'carbon_offset'
|
|
2347
|
+
| 'frequent_flyer'
|
|
2348
|
+
| 'gift_card'
|
|
2349
|
+
| 'ground_transport'
|
|
2350
|
+
| 'in_flight_entertainment'
|
|
2351
|
+
| 'lounge'
|
|
2352
|
+
| 'medical'
|
|
2353
|
+
| 'meal_beverage'
|
|
2354
|
+
| 'other'
|
|
2355
|
+
| 'passenger_assist_fee'
|
|
2356
|
+
| 'pets'
|
|
2357
|
+
| 'seat_fees'
|
|
2358
|
+
| 'standby'
|
|
2359
|
+
| 'service_fee'
|
|
2360
|
+
| 'store'
|
|
2361
|
+
| 'travel_service'
|
|
2362
|
+
| 'unaccompanied_travel'
|
|
2363
|
+
| 'upgrades'
|
|
2364
|
+
| 'wifi'
|
|
2365
|
+
| null;
|
|
2366
|
+
/**
|
|
2367
|
+
* Sub-category of the ancillary service, free-form.
|
|
2368
|
+
*/
|
|
2369
|
+
sub_category: string | null;
|
|
2370
|
+
}
|
|
2371
|
+
}
|
|
2372
|
+
interface TripLeg {
|
|
2373
|
+
/**
|
|
2374
|
+
* Carrier code (e.g., United Airlines, Jet Blue, etc.).
|
|
2375
|
+
*/
|
|
2376
|
+
carrier_code: string | null;
|
|
2377
|
+
/**
|
|
2378
|
+
* Code for the destination city or airport.
|
|
2379
|
+
*/
|
|
2380
|
+
destination_city_airport_code: string | null;
|
|
2381
|
+
/**
|
|
2382
|
+
* Fare basis code.
|
|
2383
|
+
*/
|
|
2384
|
+
fare_basis_code: string | null;
|
|
2385
|
+
/**
|
|
2386
|
+
* Flight number.
|
|
2387
|
+
*/
|
|
2388
|
+
flight_number: string | null;
|
|
2389
|
+
/**
|
|
2390
|
+
* Service class (e.g., first class, business class, etc.).
|
|
2391
|
+
*/
|
|
2392
|
+
service_class: string | null;
|
|
2393
|
+
/**
|
|
2394
|
+
* Indicates whether a stopover is allowed on this ticket.
|
|
2395
|
+
*
|
|
2396
|
+
* - `none` - None
|
|
2397
|
+
* - `stop_over_allowed` - Stop over allowed
|
|
2398
|
+
* - `stop_over_not_allowed` - Stop over not allowed
|
|
2399
|
+
*/
|
|
2400
|
+
stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
|
|
2401
|
+
}
|
|
2402
|
+
}
|
|
2403
|
+
}
|
|
2404
|
+
}
|
|
1477
2405
|
/**
|
|
1478
2406
|
* A Check Deposit Acceptance object. This field will be present in the JSON
|
|
1479
2407
|
* response if and only if `category` is equal to `check_deposit_acceptance`.
|
|
@@ -1662,16 +2590,6 @@ export declare namespace ACHTransferSimulation {
|
|
|
1662
2590
|
*/
|
|
1663
2591
|
transfer_id: string;
|
|
1664
2592
|
}
|
|
1665
|
-
/**
|
|
1666
|
-
* A Check Transfer Rejection object. This field will be present in the JSON
|
|
1667
|
-
* response if and only if `category` is equal to `check_transfer_rejection`.
|
|
1668
|
-
*/
|
|
1669
|
-
interface CheckTransferRejection {
|
|
1670
|
-
/**
|
|
1671
|
-
* The identifier of the Check Transfer that led to this Transaction.
|
|
1672
|
-
*/
|
|
1673
|
-
transfer_id: string;
|
|
1674
|
-
}
|
|
1675
2593
|
/**
|
|
1676
2594
|
* A Check Transfer Stop Payment Request object. This field will be present in the
|
|
1677
2595
|
* JSON response if and only if `category` is equal to
|
|
@@ -1682,9 +2600,11 @@ export declare namespace ACHTransferSimulation {
|
|
|
1682
2600
|
* The reason why this transfer was stopped.
|
|
1683
2601
|
*
|
|
1684
2602
|
* - `mail_delivery_failed` - The check could not be delivered.
|
|
2603
|
+
* - `rejected_by_increase` - The check was cancelled by an Increase operator who
|
|
2604
|
+
* will provide details out-of-band.
|
|
1685
2605
|
* - `unknown` - The check was stopped for another reason.
|
|
1686
2606
|
*/
|
|
1687
|
-
reason: 'mail_delivery_failed' | 'unknown';
|
|
2607
|
+
reason: 'mail_delivery_failed' | 'rejected_by_increase' | 'unknown';
|
|
1688
2608
|
/**
|
|
1689
2609
|
* The time the stop-payment was requested.
|
|
1690
2610
|
*/
|
|
@@ -1721,6 +2641,10 @@ export declare namespace ACHTransferSimulation {
|
|
|
1721
2641
|
* - `USD` - US Dollar (USD)
|
|
1722
2642
|
*/
|
|
1723
2643
|
currency: 'CAD' | 'CHF' | 'EUR' | 'GBP' | 'JPY' | 'USD';
|
|
2644
|
+
/**
|
|
2645
|
+
* The start of this payment's fee period, usually the first day of a month.
|
|
2646
|
+
*/
|
|
2647
|
+
fee_period_start: string;
|
|
1724
2648
|
}
|
|
1725
2649
|
/**
|
|
1726
2650
|
* A Inbound ACH Transfer object. This field will be present in the JSON response
|
|
@@ -2088,6 +3012,7 @@ export declare namespace ACHTransferSimulation {
|
|
|
2088
3012
|
* - `account_closure` - Account closure
|
|
2089
3013
|
* - `bank_migration` - Bank migration
|
|
2090
3014
|
* - `cashback` - Cashback
|
|
3015
|
+
* - `check_adjustment` - Check adjustment
|
|
2091
3016
|
* - `collection_receivable` - Collection receivable
|
|
2092
3017
|
* - `empyreal_adjustment` - Empyreal adjustment
|
|
2093
3018
|
* - `error` - Error
|
|
@@ -2102,6 +3027,7 @@ export declare namespace ACHTransferSimulation {
|
|
|
2102
3027
|
| 'account_closure'
|
|
2103
3028
|
| 'bank_migration'
|
|
2104
3029
|
| 'cashback'
|
|
3030
|
+
| 'check_adjustment'
|
|
2105
3031
|
| 'collection_receivable'
|
|
2106
3032
|
| 'empyreal_adjustment'
|
|
2107
3033
|
| 'error'
|