increase 0.377.0 → 0.378.0
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 +180 -4442
- package/README.md +115 -50
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/bin/cli +46 -0
- package/bin/migration-config.json +6 -0
- package/client.d.mts +382 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +382 -0
- package/client.d.ts.map +1 -0
- package/client.js +650 -0
- package/client.js.map +1 -0
- package/client.mjs +646 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +145 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +145 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +280 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +253 -0
- package/core/error.mjs.map +1 -0
- package/core/pagination.d.mts +67 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +67 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +101 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +95 -0
- package/core/pagination.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +1 -145
- package/error.d.ts.map +1 -1
- package/error.js +3 -277
- package/error.js.map +1 -1
- package/error.mjs +1 -252
- package/error.mjs.map +1 -1
- package/index.d.mts +7 -320
- package/index.d.mts.map +1 -0
- package/index.d.ts +6 -319
- package/index.d.ts.map +1 -1
- package/index.js +14 -358
- package/index.js.map +1 -1
- package/index.mjs +6 -331
- package/index.mjs.map +1 -1
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +35 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +32 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/qs/formats.d.mts +7 -0
- package/internal/qs/formats.d.mts.map +1 -0
- package/internal/qs/formats.d.ts +1 -0
- package/internal/qs/formats.d.ts.map +1 -1
- package/internal/qs/formats.js +4 -2
- package/internal/qs/formats.js.map +1 -1
- package/internal/qs/formats.mjs +2 -1
- package/internal/qs/formats.mjs.map +1 -1
- package/internal/qs/index.d.mts +10 -0
- package/internal/qs/index.d.mts.map +1 -0
- package/internal/qs/index.d.ts.map +1 -1
- package/internal/qs/stringify.d.mts +3 -0
- package/internal/qs/stringify.d.mts.map +1 -0
- package/internal/qs/stringify.d.ts.map +1 -1
- package/internal/qs/stringify.js +16 -19
- package/internal/qs/stringify.js.map +1 -1
- package/internal/qs/stringify.mjs +17 -19
- package/internal/qs/stringify.mjs.map +1 -1
- package/internal/qs/types.d.mts +57 -0
- package/internal/qs/types.d.mts.map +1 -0
- package/internal/qs/utils.d.mts +15 -0
- package/internal/qs/utils.d.mts.map +1 -0
- package/internal/qs/utils.d.ts +1 -0
- package/internal/qs/utils.d.ts.map +1 -1
- package/internal/qs/utils.js +22 -21
- package/internal/qs/utils.js.map +1 -1
- package/internal/qs/utils.mjs +12 -12
- package/internal/qs/utils.mjs.map +1 -1
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +85 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +79 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +114 -66
- package/pagination.d.mts +2 -0
- package/pagination.d.mts.map +1 -0
- package/pagination.d.ts +1 -30
- package/pagination.d.ts.map +1 -1
- package/pagination.js +3 -37
- package/pagination.js.map +1 -1
- package/pagination.mjs +1 -35
- package/pagination.mjs.map +1 -1
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +1 -5
- package/resource.d.ts.map +1 -1
- package/resource.js +3 -8
- package/resource.js.map +1 -1
- package/resource.mjs +1 -6
- package/resource.mjs.map +1 -1
- package/resources/account-numbers.d.mts +309 -0
- package/resources/account-numbers.d.mts.map +1 -0
- package/resources/account-numbers.d.ts +10 -11
- package/resources/account-numbers.d.ts.map +1 -1
- package/resources/account-numbers.js +20 -16
- package/resources/account-numbers.js.map +1 -1
- package/resources/account-numbers.mjs +19 -14
- package/resources/account-numbers.mjs.map +1 -1
- package/resources/account-statements.d.mts +113 -0
- package/resources/account-statements.d.mts.map +1 -0
- package/resources/account-statements.d.ts +8 -9
- package/resources/account-statements.d.ts.map +1 -1
- package/resources/account-statements.js +18 -14
- package/resources/account-statements.js.map +1 -1
- package/resources/account-statements.mjs +17 -12
- package/resources/account-statements.mjs.map +1 -1
- package/resources/account-transfers.d.mts +325 -0
- package/resources/account-transfers.d.mts.map +1 -0
- package/resources/account-transfers.d.ts +11 -12
- package/resources/account-transfers.d.ts.map +1 -1
- package/resources/account-transfers.js +22 -18
- package/resources/account-transfers.js.map +1 -1
- package/resources/account-transfers.mjs +21 -16
- package/resources/account-transfers.mjs.map +1 -1
- package/resources/accounts.d.mts +291 -0
- package/resources/accounts.d.mts.map +1 -0
- package/resources/accounts.d.ts +12 -14
- package/resources/accounts.d.ts.map +1 -1
- package/resources/accounts.js +35 -23
- package/resources/accounts.js.map +1 -1
- package/resources/accounts.mjs +34 -21
- package/resources/accounts.mjs.map +1 -1
- package/resources/ach-prenotifications.d.mts +473 -0
- package/resources/ach-prenotifications.d.mts.map +1 -0
- package/resources/ach-prenotifications.d.ts +9 -10
- package/resources/ach-prenotifications.d.ts.map +1 -1
- package/resources/ach-prenotifications.js +18 -14
- package/resources/ach-prenotifications.js.map +1 -1
- package/resources/ach-prenotifications.mjs +17 -12
- package/resources/ach-prenotifications.mjs.map +1 -1
- package/resources/ach-transfers.d.mts +1091 -0
- package/resources/ach-transfers.d.mts.map +1 -0
- package/resources/ach-transfers.d.ts +11 -12
- package/resources/ach-transfers.d.ts.map +1 -1
- package/resources/ach-transfers.js +22 -18
- package/resources/ach-transfers.js.map +1 -1
- package/resources/ach-transfers.mjs +21 -16
- package/resources/ach-transfers.mjs.map +1 -1
- package/resources/bookkeeping-accounts.d.mts +164 -0
- package/resources/bookkeeping-accounts.d.mts.map +1 -0
- package/resources/bookkeeping-accounts.d.ts +10 -12
- package/resources/bookkeeping-accounts.d.ts.map +1 -1
- package/resources/bookkeeping-accounts.js +34 -19
- package/resources/bookkeeping-accounts.js.map +1 -1
- package/resources/bookkeeping-accounts.mjs +33 -17
- package/resources/bookkeeping-accounts.mjs.map +1 -1
- package/resources/bookkeeping-entries.d.mts +74 -0
- package/resources/bookkeeping-entries.d.mts.map +1 -0
- package/resources/bookkeeping-entries.d.ts +8 -9
- package/resources/bookkeeping-entries.d.ts.map +1 -1
- package/resources/bookkeeping-entries.js +18 -14
- package/resources/bookkeeping-entries.js.map +1 -1
- package/resources/bookkeeping-entries.mjs +17 -12
- package/resources/bookkeeping-entries.mjs.map +1 -1
- package/resources/bookkeeping-entry-sets.d.mts +156 -0
- package/resources/bookkeeping-entry-sets.d.mts.map +1 -0
- package/resources/bookkeeping-entry-sets.d.ts +9 -10
- package/resources/bookkeeping-entry-sets.d.ts.map +1 -1
- package/resources/bookkeeping-entry-sets.js +18 -14
- package/resources/bookkeeping-entry-sets.js.map +1 -1
- package/resources/bookkeeping-entry-sets.mjs +17 -12
- package/resources/bookkeeping-entry-sets.mjs.map +1 -1
- package/resources/card-disputes.d.mts +5657 -0
- package/resources/card-disputes.d.mts.map +1 -0
- package/resources/card-disputes.d.ts +11 -12
- package/resources/card-disputes.d.ts.map +1 -1
- package/resources/card-disputes.js +25 -18
- package/resources/card-disputes.js.map +1 -1
- package/resources/card-disputes.mjs +24 -16
- package/resources/card-disputes.mjs.map +1 -1
- package/resources/card-payments.d.mts +4523 -0
- package/resources/card-payments.d.mts.map +1 -0
- package/resources/card-payments.d.ts +8 -9
- package/resources/card-payments.d.ts.map +1 -1
- package/resources/card-payments.js +18 -14
- package/resources/card-payments.js.map +1 -1
- package/resources/card-payments.mjs +17 -12
- package/resources/card-payments.mjs.map +1 -1
- package/resources/card-purchase-supplements.d.mts +266 -0
- package/resources/card-purchase-supplements.d.mts.map +1 -0
- package/resources/card-purchase-supplements.d.ts +8 -9
- package/resources/card-purchase-supplements.d.ts.map +1 -1
- package/resources/card-purchase-supplements.js +18 -14
- package/resources/card-purchase-supplements.js.map +1 -1
- package/resources/card-purchase-supplements.mjs +17 -12
- package/resources/card-purchase-supplements.mjs.map +1 -1
- package/resources/card-push-transfers.d.mts +992 -0
- package/resources/card-push-transfers.d.mts.map +1 -0
- package/resources/card-push-transfers.d.ts +11 -12
- package/resources/card-push-transfers.d.ts.map +1 -1
- package/resources/card-push-transfers.js +22 -18
- package/resources/card-push-transfers.js.map +1 -1
- package/resources/card-push-transfers.mjs +21 -16
- package/resources/card-push-transfers.mjs.map +1 -1
- package/resources/card-tokens.d.mts +153 -0
- package/resources/card-tokens.d.mts.map +1 -0
- package/resources/card-tokens.d.ts +9 -10
- package/resources/card-tokens.d.ts.map +1 -1
- package/resources/card-tokens.js +20 -16
- package/resources/card-tokens.js.map +1 -1
- package/resources/card-tokens.mjs +19 -14
- package/resources/card-tokens.mjs.map +1 -1
- package/resources/card-validations.d.mts +513 -0
- package/resources/card-validations.d.mts.map +1 -0
- package/resources/card-validations.d.ts +9 -10
- package/resources/card-validations.d.ts.map +1 -1
- package/resources/card-validations.js +18 -14
- package/resources/card-validations.js.map +1 -1
- package/resources/card-validations.mjs +17 -12
- package/resources/card-validations.mjs.map +1 -1
- package/resources/cards.d.mts +486 -0
- package/resources/cards.d.mts.map +1 -0
- package/resources/cards.d.ts +13 -14
- package/resources/cards.d.ts.map +1 -1
- package/resources/cards.js +26 -22
- package/resources/cards.js.map +1 -1
- package/resources/cards.mjs +25 -20
- package/resources/cards.mjs.map +1 -1
- package/resources/check-deposits.d.mts +453 -0
- package/resources/check-deposits.d.mts.map +1 -0
- package/resources/check-deposits.d.ts +9 -10
- package/resources/check-deposits.d.ts.map +1 -1
- package/resources/check-deposits.js +18 -14
- package/resources/check-deposits.js.map +1 -1
- package/resources/check-deposits.mjs +17 -12
- package/resources/check-deposits.mjs.map +1 -1
- package/resources/check-transfers.d.mts +874 -0
- package/resources/check-transfers.d.mts.map +1 -0
- package/resources/check-transfers.d.ts +12 -13
- package/resources/check-transfers.d.ts.map +1 -1
- package/resources/check-transfers.js +24 -20
- package/resources/check-transfers.js.map +1 -1
- package/resources/check-transfers.mjs +23 -18
- package/resources/check-transfers.mjs.map +1 -1
- package/resources/declined-transactions.d.mts +1161 -0
- package/resources/declined-transactions.d.mts.map +1 -0
- package/resources/declined-transactions.d.ts +8 -9
- package/resources/declined-transactions.d.ts.map +1 -1
- package/resources/declined-transactions.js +21 -14
- package/resources/declined-transactions.js.map +1 -1
- package/resources/declined-transactions.mjs +20 -12
- package/resources/declined-transactions.mjs.map +1 -1
- package/resources/digital-card-profiles.d.mts +303 -0
- package/resources/digital-card-profiles.d.mts.map +1 -0
- package/resources/digital-card-profiles.d.ts +11 -12
- package/resources/digital-card-profiles.d.ts.map +1 -1
- package/resources/digital-card-profiles.js +25 -18
- package/resources/digital-card-profiles.js.map +1 -1
- package/resources/digital-card-profiles.mjs +24 -16
- package/resources/digital-card-profiles.mjs.map +1 -1
- package/resources/digital-wallet-tokens.d.mts +181 -0
- package/resources/digital-wallet-tokens.d.mts.map +1 -0
- package/resources/digital-wallet-tokens.d.ts +8 -9
- package/resources/digital-wallet-tokens.d.ts.map +1 -1
- package/resources/digital-wallet-tokens.js +18 -14
- package/resources/digital-wallet-tokens.js.map +1 -1
- package/resources/digital-wallet-tokens.mjs +17 -12
- package/resources/digital-wallet-tokens.mjs.map +1 -1
- package/resources/documents.d.mts +213 -0
- package/resources/documents.d.mts.map +1 -0
- package/resources/documents.d.ts +9 -10
- package/resources/documents.d.ts.map +1 -1
- package/resources/documents.js +18 -14
- package/resources/documents.js.map +1 -1
- package/resources/documents.mjs +17 -12
- package/resources/documents.mjs.map +1 -1
- package/resources/entities.d.mts +2759 -0
- package/resources/entities.d.mts.map +1 -0
- package/resources/entities.d.ts +17 -18
- package/resources/entities.d.ts.map +1 -1
- package/resources/entities.js +37 -30
- package/resources/entities.js.map +1 -1
- package/resources/entities.mjs +36 -28
- package/resources/entities.mjs.map +1 -1
- package/resources/event-subscriptions.d.mts +471 -0
- package/resources/event-subscriptions.d.mts.map +1 -0
- package/resources/event-subscriptions.d.ts +10 -11
- package/resources/event-subscriptions.d.ts.map +1 -1
- package/resources/event-subscriptions.js +20 -16
- package/resources/event-subscriptions.js.map +1 -1
- package/resources/event-subscriptions.mjs +19 -14
- package/resources/event-subscriptions.mjs.map +1 -1
- package/resources/events.d.mts +261 -0
- package/resources/events.d.mts.map +1 -0
- package/resources/events.d.ts +8 -9
- package/resources/events.d.ts.map +1 -1
- package/resources/events.js +18 -14
- package/resources/events.js.map +1 -1
- package/resources/events.mjs +17 -12
- package/resources/events.mjs.map +1 -1
- package/resources/exports.d.mts +440 -0
- package/resources/exports.d.mts.map +1 -0
- package/resources/exports.d.ts +9 -10
- package/resources/exports.d.ts.map +1 -1
- package/resources/exports.js +18 -14
- package/resources/exports.js.map +1 -1
- package/resources/exports.mjs +17 -12
- package/resources/exports.mjs.map +1 -1
- package/resources/external-accounts.d.mts +212 -0
- package/resources/external-accounts.d.mts.map +1 -0
- package/resources/external-accounts.d.ts +10 -11
- package/resources/external-accounts.d.ts.map +1 -1
- package/resources/external-accounts.js +20 -16
- package/resources/external-accounts.js.map +1 -1
- package/resources/external-accounts.mjs +19 -14
- package/resources/external-accounts.mjs.map +1 -1
- package/resources/fednow-transfers.d.mts +474 -0
- package/resources/fednow-transfers.d.mts.map +1 -0
- package/resources/fednow-transfers.d.ts +11 -12
- package/resources/fednow-transfers.d.ts.map +1 -1
- package/resources/fednow-transfers.js +22 -18
- package/resources/fednow-transfers.js.map +1 -1
- package/resources/fednow-transfers.mjs +21 -16
- package/resources/fednow-transfers.mjs.map +1 -1
- package/resources/file-links.d.mts +72 -0
- package/resources/file-links.d.mts.map +1 -0
- package/resources/file-links.d.ts +4 -3
- package/resources/file-links.d.ts.map +1 -1
- package/resources/file-links.js +1 -1
- package/resources/file-links.js.map +1 -1
- package/resources/file-links.mjs +1 -1
- package/resources/file-links.mjs.map +1 -1
- package/resources/files.d.mts +242 -0
- package/resources/files.d.mts.map +1 -0
- package/resources/files.d.ts +11 -11
- package/resources/files.d.ts.map +1 -1
- package/resources/files.js +20 -39
- package/resources/files.js.map +1 -1
- package/resources/files.mjs +19 -14
- package/resources/files.mjs.map +1 -1
- package/resources/groups.d.mts +54 -0
- package/resources/groups.d.mts.map +1 -0
- package/resources/groups.d.ts +4 -3
- package/resources/groups.d.ts.map +1 -1
- package/resources/groups.js +1 -1
- package/resources/groups.js.map +1 -1
- package/resources/groups.mjs +1 -1
- package/resources/groups.mjs.map +1 -1
- package/resources/inbound-ach-transfers.d.mts +704 -0
- package/resources/inbound-ach-transfers.d.mts.map +1 -0
- package/resources/inbound-ach-transfers.d.ts +11 -12
- package/resources/inbound-ach-transfers.d.ts.map +1 -1
- package/resources/inbound-ach-transfers.js +27 -23
- package/resources/inbound-ach-transfers.js.map +1 -1
- package/resources/inbound-ach-transfers.mjs +26 -21
- package/resources/inbound-ach-transfers.mjs.map +1 -1
- package/resources/inbound-check-deposits.d.mts +278 -0
- package/resources/inbound-check-deposits.d.mts.map +1 -0
- package/resources/inbound-check-deposits.d.ts +10 -11
- package/resources/inbound-check-deposits.d.ts.map +1 -1
- package/resources/inbound-check-deposits.js +25 -18
- package/resources/inbound-check-deposits.js.map +1 -1
- package/resources/inbound-check-deposits.mjs +24 -16
- package/resources/inbound-check-deposits.mjs.map +1 -1
- package/resources/inbound-fednow-transfers.d.mts +188 -0
- package/resources/inbound-fednow-transfers.d.mts.map +1 -0
- package/resources/inbound-fednow-transfers.d.ts +8 -9
- package/resources/inbound-fednow-transfers.d.ts.map +1 -1
- package/resources/inbound-fednow-transfers.js +18 -14
- package/resources/inbound-fednow-transfers.js.map +1 -1
- package/resources/inbound-fednow-transfers.mjs +17 -12
- package/resources/inbound-fednow-transfers.mjs.map +1 -1
- package/resources/inbound-mail-items.d.mts +187 -0
- package/resources/inbound-mail-items.d.mts.map +1 -0
- package/resources/inbound-mail-items.d.ts +9 -10
- package/resources/inbound-mail-items.d.ts.map +1 -1
- package/resources/inbound-mail-items.js +20 -16
- package/resources/inbound-mail-items.js.map +1 -1
- package/resources/inbound-mail-items.mjs +19 -14
- package/resources/inbound-mail-items.mjs.map +1 -1
- package/resources/inbound-real-time-payments-transfers.d.mts +192 -0
- package/resources/inbound-real-time-payments-transfers.d.mts.map +1 -0
- package/resources/inbound-real-time-payments-transfers.d.ts +8 -9
- package/resources/inbound-real-time-payments-transfers.d.ts.map +1 -1
- package/resources/inbound-real-time-payments-transfers.js +18 -14
- package/resources/inbound-real-time-payments-transfers.js.map +1 -1
- package/resources/inbound-real-time-payments-transfers.mjs +17 -12
- package/resources/inbound-real-time-payments-transfers.mjs.map +1 -1
- package/resources/inbound-wire-drawdown-requests.d.mts +138 -0
- package/resources/inbound-wire-drawdown-requests.d.mts.map +1 -0
- package/resources/inbound-wire-drawdown-requests.d.ts +8 -9
- package/resources/inbound-wire-drawdown-requests.d.ts.map +1 -1
- package/resources/inbound-wire-drawdown-requests.js +18 -14
- package/resources/inbound-wire-drawdown-requests.js.map +1 -1
- package/resources/inbound-wire-drawdown-requests.mjs +17 -12
- package/resources/inbound-wire-drawdown-requests.mjs.map +1 -1
- package/resources/inbound-wire-transfers.d.mts +245 -0
- package/resources/inbound-wire-transfers.d.mts.map +1 -0
- package/resources/inbound-wire-transfers.d.ts +9 -10
- package/resources/inbound-wire-transfers.d.ts.map +1 -1
- package/resources/inbound-wire-transfers.js +20 -16
- package/resources/inbound-wire-transfers.js.map +1 -1
- package/resources/inbound-wire-transfers.mjs +19 -14
- package/resources/inbound-wire-transfers.mjs.map +1 -1
- package/resources/index.d.mts +58 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +51 -52
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +4 -58
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +51 -52
- package/resources/index.mjs.map +1 -1
- package/resources/intrafi-account-enrollments.d.mts +153 -0
- package/resources/intrafi-account-enrollments.d.mts.map +1 -0
- package/resources/intrafi-account-enrollments.d.ts +10 -11
- package/resources/intrafi-account-enrollments.d.ts.map +1 -1
- package/resources/intrafi-account-enrollments.js +20 -16
- package/resources/intrafi-account-enrollments.js.map +1 -1
- package/resources/intrafi-account-enrollments.mjs +19 -14
- package/resources/intrafi-account-enrollments.mjs.map +1 -1
- package/resources/intrafi-balances.d.mts +101 -0
- package/resources/intrafi-balances.d.mts.map +1 -0
- package/resources/intrafi-balances.d.ts +4 -3
- package/resources/intrafi-balances.d.ts.map +1 -1
- package/resources/intrafi-balances.js +4 -3
- package/resources/intrafi-balances.js.map +1 -1
- package/resources/intrafi-balances.mjs +4 -3
- package/resources/intrafi-balances.mjs.map +1 -1
- package/resources/intrafi-exclusions.d.mts +141 -0
- package/resources/intrafi-exclusions.d.mts.map +1 -0
- package/resources/intrafi-exclusions.d.ts +10 -11
- package/resources/intrafi-exclusions.d.ts.map +1 -1
- package/resources/intrafi-exclusions.js +20 -16
- package/resources/intrafi-exclusions.js.map +1 -1
- package/resources/intrafi-exclusions.mjs +19 -14
- package/resources/intrafi-exclusions.mjs.map +1 -1
- package/resources/lockboxes.d.mts +215 -0
- package/resources/lockboxes.d.mts.map +1 -0
- package/resources/lockboxes.d.ts +10 -11
- package/resources/lockboxes.d.ts.map +1 -1
- package/resources/lockboxes.js +20 -16
- package/resources/lockboxes.js.map +1 -1
- package/resources/lockboxes.mjs +19 -14
- package/resources/lockboxes.mjs.map +1 -1
- package/resources/oauth-applications.d.mts +113 -0
- package/resources/oauth-applications.d.mts.map +1 -0
- package/resources/oauth-applications.d.ts +8 -9
- package/resources/oauth-applications.d.ts.map +1 -1
- package/resources/oauth-applications.js +18 -14
- package/resources/oauth-applications.js.map +1 -1
- package/resources/oauth-applications.mjs +17 -12
- package/resources/oauth-applications.mjs.map +1 -1
- package/resources/oauth-connections.d.mts +94 -0
- package/resources/oauth-connections.d.mts.map +1 -0
- package/resources/oauth-connections.d.ts +8 -9
- package/resources/oauth-connections.d.ts.map +1 -1
- package/resources/oauth-connections.js +18 -14
- package/resources/oauth-connections.js.map +1 -1
- package/resources/oauth-connections.mjs +17 -12
- package/resources/oauth-connections.mjs.map +1 -1
- package/resources/oauth-tokens.d.mts +77 -0
- package/resources/oauth-tokens.d.mts.map +1 -0
- package/resources/oauth-tokens.d.ts +4 -3
- package/resources/oauth-tokens.d.ts.map +1 -1
- package/resources/oauth-tokens.js +1 -1
- package/resources/oauth-tokens.js.map +1 -1
- package/resources/oauth-tokens.mjs +1 -1
- package/resources/oauth-tokens.mjs.map +1 -1
- package/resources/pending-transactions.d.mts +1182 -0
- package/resources/pending-transactions.d.mts.map +1 -0
- package/resources/pending-transactions.d.ts +10 -11
- package/resources/pending-transactions.d.ts.map +1 -1
- package/resources/pending-transactions.js +20 -16
- package/resources/pending-transactions.js.map +1 -1
- package/resources/pending-transactions.mjs +19 -14
- package/resources/pending-transactions.mjs.map +1 -1
- package/resources/physical-card-profiles.d.mts +268 -0
- package/resources/physical-card-profiles.d.mts.map +1 -0
- package/resources/physical-card-profiles.d.ts +11 -12
- package/resources/physical-card-profiles.d.ts.map +1 -1
- package/resources/physical-card-profiles.js +25 -18
- package/resources/physical-card-profiles.js.map +1 -1
- package/resources/physical-card-profiles.mjs +24 -16
- package/resources/physical-card-profiles.mjs.map +1 -1
- package/resources/physical-cards.d.mts +455 -0
- package/resources/physical-cards.d.mts.map +1 -0
- package/resources/physical-cards.d.ts +10 -11
- package/resources/physical-cards.d.ts.map +1 -1
- package/resources/physical-cards.js +20 -16
- package/resources/physical-cards.js.map +1 -1
- package/resources/physical-cards.mjs +19 -14
- package/resources/physical-cards.mjs.map +1 -1
- package/resources/programs.d.mts +89 -0
- package/resources/programs.d.mts.map +1 -0
- package/resources/programs.d.ts +8 -9
- package/resources/programs.d.ts.map +1 -1
- package/resources/programs.js +18 -14
- package/resources/programs.js.map +1 -1
- package/resources/programs.mjs +17 -12
- package/resources/programs.mjs.map +1 -1
- package/resources/real-time-decisions.d.mts +1132 -0
- package/resources/real-time-decisions.d.mts.map +1 -0
- package/resources/real-time-decisions.d.ts +5 -4
- package/resources/real-time-decisions.d.ts.map +1 -1
- package/resources/real-time-decisions.js +6 -5
- package/resources/real-time-decisions.js.map +1 -1
- package/resources/real-time-decisions.mjs +6 -5
- package/resources/real-time-decisions.mjs.map +1 -1
- package/resources/real-time-payments-transfers.d.mts +504 -0
- package/resources/real-time-payments-transfers.d.mts.map +1 -0
- package/resources/real-time-payments-transfers.d.ts +11 -12
- package/resources/real-time-payments-transfers.d.ts.map +1 -1
- package/resources/real-time-payments-transfers.js +22 -18
- package/resources/real-time-payments-transfers.js.map +1 -1
- package/resources/real-time-payments-transfers.mjs +21 -16
- package/resources/real-time-payments-transfers.mjs.map +1 -1
- package/resources/routing-numbers.d.mts +79 -0
- package/resources/routing-numbers.d.mts.map +1 -0
- package/resources/routing-numbers.d.ts +6 -7
- package/resources/routing-numbers.d.ts.map +1 -1
- package/resources/routing-numbers.js +7 -8
- package/resources/routing-numbers.js.map +1 -1
- package/resources/routing-numbers.mjs +6 -6
- package/resources/routing-numbers.mjs.map +1 -1
- package/resources/simulations/account-statements.d.mts +29 -0
- package/resources/simulations/account-statements.d.mts.map +1 -0
- package/resources/simulations/account-statements.d.ts +4 -3
- package/resources/simulations/account-statements.d.ts.map +1 -1
- package/resources/simulations/account-statements.js +1 -1
- package/resources/simulations/account-statements.js.map +1 -1
- package/resources/simulations/account-statements.mjs +1 -1
- package/resources/simulations/account-statements.mjs.map +1 -1
- package/resources/simulations/account-transfers.d.mts +22 -0
- package/resources/simulations/account-transfers.d.mts.map +1 -0
- package/resources/simulations/account-transfers.d.ts +4 -3
- package/resources/simulations/account-transfers.d.ts.map +1 -1
- package/resources/simulations/account-transfers.js +4 -3
- package/resources/simulations/account-transfers.js.map +1 -1
- package/resources/simulations/account-transfers.mjs +4 -3
- package/resources/simulations/account-transfers.mjs.map +1 -1
- package/resources/simulations/ach-transfers.d.mts +307 -0
- package/resources/simulations/ach-transfers.d.mts.map +1 -0
- package/resources/simulations/ach-transfers.d.ts +8 -7
- package/resources/simulations/ach-transfers.d.ts.map +1 -1
- package/resources/simulations/ach-transfers.js +12 -14
- package/resources/simulations/ach-transfers.js.map +1 -1
- package/resources/simulations/ach-transfers.mjs +12 -14
- package/resources/simulations/ach-transfers.mjs.map +1 -1
- package/resources/simulations/card-authorization-expirations.d.mts +30 -0
- package/resources/simulations/card-authorization-expirations.d.mts.map +1 -0
- package/resources/simulations/card-authorization-expirations.d.ts +4 -3
- package/resources/simulations/card-authorization-expirations.d.ts.map +1 -1
- package/resources/simulations/card-authorization-expirations.js +1 -1
- package/resources/simulations/card-authorization-expirations.js.map +1 -1
- package/resources/simulations/card-authorization-expirations.mjs +1 -1
- package/resources/simulations/card-authorization-expirations.mjs.map +1 -1
- package/resources/simulations/card-authorizations.d.mts +244 -0
- package/resources/simulations/card-authorizations.d.mts.map +1 -0
- package/resources/simulations/card-authorizations.d.ts +4 -3
- package/resources/simulations/card-authorizations.d.ts.map +1 -1
- package/resources/simulations/card-authorizations.js +1 -1
- package/resources/simulations/card-authorizations.js.map +1 -1
- package/resources/simulations/card-authorizations.mjs +1 -1
- package/resources/simulations/card-authorizations.mjs.map +1 -1
- package/resources/simulations/card-disputes.d.mts +192 -0
- package/resources/simulations/card-disputes.d.mts.map +1 -0
- package/resources/simulations/card-disputes.d.ts +4 -3
- package/resources/simulations/card-disputes.d.ts.map +1 -1
- package/resources/simulations/card-disputes.js +4 -3
- package/resources/simulations/card-disputes.js.map +1 -1
- package/resources/simulations/card-disputes.mjs +4 -3
- package/resources/simulations/card-disputes.mjs.map +1 -1
- package/resources/simulations/card-fuel-confirmations.d.mts +36 -0
- package/resources/simulations/card-fuel-confirmations.d.mts.map +1 -0
- package/resources/simulations/card-fuel-confirmations.d.ts +4 -3
- package/resources/simulations/card-fuel-confirmations.d.ts.map +1 -1
- package/resources/simulations/card-fuel-confirmations.js +1 -1
- package/resources/simulations/card-fuel-confirmations.js.map +1 -1
- package/resources/simulations/card-fuel-confirmations.mjs +1 -1
- package/resources/simulations/card-fuel-confirmations.mjs.map +1 -1
- package/resources/simulations/card-increments.d.mts +41 -0
- package/resources/simulations/card-increments.d.mts.map +1 -0
- package/resources/simulations/card-increments.d.ts +4 -3
- package/resources/simulations/card-increments.d.ts.map +1 -1
- package/resources/simulations/card-increments.js +1 -1
- package/resources/simulations/card-increments.js.map +1 -1
- package/resources/simulations/card-increments.mjs +1 -1
- package/resources/simulations/card-increments.mjs.map +1 -1
- package/resources/simulations/card-refunds.d.mts +39 -0
- package/resources/simulations/card-refunds.d.mts.map +1 -0
- package/resources/simulations/card-refunds.d.ts +4 -3
- package/resources/simulations/card-refunds.d.ts.map +1 -1
- package/resources/simulations/card-refunds.js +1 -1
- package/resources/simulations/card-refunds.js.map +1 -1
- package/resources/simulations/card-refunds.mjs +1 -1
- package/resources/simulations/card-refunds.mjs.map +1 -1
- package/resources/simulations/card-reversals.d.mts +36 -0
- package/resources/simulations/card-reversals.d.mts.map +1 -0
- package/resources/simulations/card-reversals.d.ts +4 -3
- package/resources/simulations/card-reversals.d.ts.map +1 -1
- package/resources/simulations/card-reversals.js +1 -1
- package/resources/simulations/card-reversals.js.map +1 -1
- package/resources/simulations/card-reversals.mjs +1 -1
- package/resources/simulations/card-reversals.mjs.map +1 -1
- package/resources/simulations/card-settlements.d.mts +44 -0
- package/resources/simulations/card-settlements.d.mts.map +1 -0
- package/resources/simulations/card-settlements.d.ts +4 -3
- package/resources/simulations/card-settlements.d.ts.map +1 -1
- package/resources/simulations/card-settlements.js +1 -1
- package/resources/simulations/card-settlements.js.map +1 -1
- package/resources/simulations/card-settlements.mjs +1 -1
- package/resources/simulations/card-settlements.mjs.map +1 -1
- package/resources/simulations/card-tokens.d.mts +67 -0
- package/resources/simulations/card-tokens.d.mts.map +1 -0
- package/resources/simulations/card-tokens.d.ts +4 -3
- package/resources/simulations/card-tokens.d.ts.map +1 -1
- package/resources/simulations/card-tokens.js +1 -1
- package/resources/simulations/card-tokens.js.map +1 -1
- package/resources/simulations/card-tokens.mjs +1 -1
- package/resources/simulations/card-tokens.mjs.map +1 -1
- package/resources/simulations/check-deposits.d.mts +47 -0
- package/resources/simulations/check-deposits.d.mts.map +1 -0
- package/resources/simulations/check-deposits.d.ts +6 -5
- package/resources/simulations/check-deposits.d.ts.map +1 -1
- package/resources/simulations/check-deposits.js +8 -7
- package/resources/simulations/check-deposits.js.map +1 -1
- package/resources/simulations/check-deposits.mjs +8 -7
- package/resources/simulations/check-deposits.mjs.map +1 -1
- package/resources/simulations/check-transfers.d.mts +22 -0
- package/resources/simulations/check-transfers.d.mts.map +1 -0
- package/resources/simulations/check-transfers.d.ts +4 -3
- package/resources/simulations/check-transfers.d.ts.map +1 -1
- package/resources/simulations/check-transfers.js +4 -3
- package/resources/simulations/check-transfers.js.map +1 -1
- package/resources/simulations/check-transfers.mjs +4 -3
- package/resources/simulations/check-transfers.mjs.map +1 -1
- package/resources/simulations/digital-wallet-token-requests.d.mts +55 -0
- package/resources/simulations/digital-wallet-token-requests.d.mts.map +1 -0
- package/resources/simulations/digital-wallet-token-requests.d.ts +4 -3
- package/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -1
- package/resources/simulations/digital-wallet-token-requests.js +1 -1
- package/resources/simulations/digital-wallet-token-requests.js.map +1 -1
- package/resources/simulations/digital-wallet-token-requests.mjs +1 -1
- package/resources/simulations/digital-wallet-token-requests.mjs.map +1 -1
- package/resources/simulations/documents.d.mts +27 -0
- package/resources/simulations/documents.d.mts.map +1 -0
- package/resources/simulations/documents.d.ts +4 -3
- package/resources/simulations/documents.d.ts.map +1 -1
- package/resources/simulations/documents.js +1 -1
- package/resources/simulations/documents.js.map +1 -1
- package/resources/simulations/documents.mjs +1 -1
- package/resources/simulations/documents.mjs.map +1 -1
- package/resources/simulations/inbound-ach-transfers.d.mts +140 -0
- package/resources/simulations/inbound-ach-transfers.d.mts.map +1 -0
- package/resources/simulations/inbound-ach-transfers.d.ts +4 -3
- package/resources/simulations/inbound-ach-transfers.d.ts.map +1 -1
- package/resources/simulations/inbound-ach-transfers.js +1 -1
- package/resources/simulations/inbound-ach-transfers.js.map +1 -1
- package/resources/simulations/inbound-ach-transfers.mjs +1 -1
- package/resources/simulations/inbound-ach-transfers.mjs.map +1 -1
- package/resources/simulations/inbound-check-deposits.d.mts +56 -0
- package/resources/simulations/inbound-check-deposits.d.mts.map +1 -0
- package/resources/simulations/inbound-check-deposits.d.ts +4 -3
- package/resources/simulations/inbound-check-deposits.d.ts.map +1 -1
- package/resources/simulations/inbound-check-deposits.js +1 -1
- package/resources/simulations/inbound-check-deposits.js.map +1 -1
- package/resources/simulations/inbound-check-deposits.mjs +1 -1
- package/resources/simulations/inbound-check-deposits.mjs.map +1 -1
- package/resources/simulations/inbound-fednow-transfers.d.mts +51 -0
- package/resources/simulations/inbound-fednow-transfers.d.mts.map +1 -0
- package/resources/simulations/inbound-fednow-transfers.d.ts +4 -3
- package/resources/simulations/inbound-fednow-transfers.d.ts.map +1 -1
- package/resources/simulations/inbound-fednow-transfers.js +1 -1
- package/resources/simulations/inbound-fednow-transfers.js.map +1 -1
- package/resources/simulations/inbound-fednow-transfers.mjs +1 -1
- package/resources/simulations/inbound-fednow-transfers.mjs.map +1 -1
- package/resources/simulations/inbound-mail-items.d.mts +39 -0
- package/resources/simulations/inbound-mail-items.d.mts.map +1 -0
- package/resources/simulations/inbound-mail-items.d.ts +4 -3
- package/resources/simulations/inbound-mail-items.d.ts.map +1 -1
- package/resources/simulations/inbound-mail-items.js +1 -1
- package/resources/simulations/inbound-mail-items.js.map +1 -1
- package/resources/simulations/inbound-mail-items.mjs +1 -1
- package/resources/simulations/inbound-mail-items.mjs.map +1 -1
- package/resources/simulations/inbound-real-time-payments-transfers.d.mts +59 -0
- package/resources/simulations/inbound-real-time-payments-transfers.d.mts.map +1 -0
- package/resources/simulations/inbound-real-time-payments-transfers.d.ts +4 -3
- package/resources/simulations/inbound-real-time-payments-transfers.d.ts.map +1 -1
- package/resources/simulations/inbound-real-time-payments-transfers.js +1 -1
- package/resources/simulations/inbound-real-time-payments-transfers.js.map +1 -1
- package/resources/simulations/inbound-real-time-payments-transfers.mjs +1 -1
- package/resources/simulations/inbound-real-time-payments-transfers.mjs.map +1 -1
- package/resources/simulations/inbound-wire-drawdown-requests.d.mts +117 -0
- package/resources/simulations/inbound-wire-drawdown-requests.d.mts.map +1 -0
- package/resources/simulations/inbound-wire-drawdown-requests.d.ts +4 -3
- package/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -1
- package/resources/simulations/inbound-wire-drawdown-requests.js +1 -1
- package/resources/simulations/inbound-wire-drawdown-requests.js.map +1 -1
- package/resources/simulations/inbound-wire-drawdown-requests.mjs +1 -1
- package/resources/simulations/inbound-wire-drawdown-requests.mjs.map +1 -1
- package/resources/simulations/inbound-wire-transfers.d.mts +104 -0
- package/resources/simulations/inbound-wire-transfers.d.mts.map +1 -0
- package/resources/simulations/inbound-wire-transfers.d.ts +4 -3
- package/resources/simulations/inbound-wire-transfers.d.ts.map +1 -1
- package/resources/simulations/inbound-wire-transfers.js +1 -1
- package/resources/simulations/inbound-wire-transfers.js.map +1 -1
- package/resources/simulations/inbound-wire-transfers.mjs +1 -1
- package/resources/simulations/inbound-wire-transfers.mjs.map +1 -1
- package/resources/simulations/index.d.mts +32 -0
- package/resources/simulations/index.d.mts.map +1 -0
- package/resources/simulations/index.d.ts.map +1 -1
- package/resources/simulations/interest-payments.d.mts +46 -0
- package/resources/simulations/interest-payments.d.mts.map +1 -0
- package/resources/simulations/interest-payments.d.ts +4 -3
- package/resources/simulations/interest-payments.d.ts.map +1 -1
- package/resources/simulations/interest-payments.js +1 -1
- package/resources/simulations/interest-payments.js.map +1 -1
- package/resources/simulations/interest-payments.mjs +1 -1
- package/resources/simulations/interest-payments.mjs.map +1 -1
- package/resources/simulations/pending-transactions.d.mts +20 -0
- package/resources/simulations/pending-transactions.d.mts.map +1 -0
- package/resources/simulations/pending-transactions.d.ts +4 -3
- package/resources/simulations/pending-transactions.d.ts.map +1 -1
- package/resources/simulations/pending-transactions.js +4 -3
- package/resources/simulations/pending-transactions.js.map +1 -1
- package/resources/simulations/pending-transactions.mjs +4 -3
- package/resources/simulations/pending-transactions.mjs.map +1 -1
- package/resources/simulations/physical-cards.d.mts +88 -0
- package/resources/simulations/physical-cards.d.mts.map +1 -0
- package/resources/simulations/physical-cards.d.ts +5 -4
- package/resources/simulations/physical-cards.d.ts.map +1 -1
- package/resources/simulations/physical-cards.js +6 -5
- package/resources/simulations/physical-cards.js.map +1 -1
- package/resources/simulations/physical-cards.mjs +6 -5
- package/resources/simulations/physical-cards.mjs.map +1 -1
- package/resources/simulations/programs.d.mts +46 -0
- package/resources/simulations/programs.d.mts.map +1 -0
- package/resources/simulations/programs.d.ts +4 -3
- package/resources/simulations/programs.d.ts.map +1 -1
- package/resources/simulations/programs.js +1 -1
- package/resources/simulations/programs.js.map +1 -1
- package/resources/simulations/programs.mjs +1 -1
- package/resources/simulations/programs.mjs.map +1 -1
- package/resources/simulations/real-time-payments-transfers.d.mts +91 -0
- package/resources/simulations/real-time-payments-transfers.d.mts.map +1 -0
- package/resources/simulations/real-time-payments-transfers.d.ts +4 -3
- package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
- package/resources/simulations/real-time-payments-transfers.js +4 -3
- package/resources/simulations/real-time-payments-transfers.js.map +1 -1
- package/resources/simulations/real-time-payments-transfers.mjs +4 -3
- package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
- package/resources/simulations/simulations.d.mts +126 -0
- package/resources/simulations/simulations.d.mts.map +1 -0
- package/resources/simulations/simulations.d.ts +1 -1
- package/resources/simulations/simulations.d.ts.map +1 -1
- package/resources/simulations/simulations.js +32 -54
- package/resources/simulations/simulations.js.map +1 -1
- package/resources/simulations/simulations.mjs +1 -1
- package/resources/simulations/wire-drawdown-requests.d.mts +31 -0
- package/resources/simulations/wire-drawdown-requests.d.mts.map +1 -0
- package/resources/simulations/wire-drawdown-requests.d.ts +5 -4
- package/resources/simulations/wire-drawdown-requests.d.ts.map +1 -1
- package/resources/simulations/wire-drawdown-requests.js +6 -5
- package/resources/simulations/wire-drawdown-requests.js.map +1 -1
- package/resources/simulations/wire-drawdown-requests.mjs +6 -5
- package/resources/simulations/wire-drawdown-requests.mjs.map +1 -1
- package/resources/simulations/wire-transfers.d.mts +36 -0
- package/resources/simulations/wire-transfers.d.mts.map +1 -0
- package/resources/simulations/wire-transfers.d.ts +5 -4
- package/resources/simulations/wire-transfers.d.ts.map +1 -1
- package/resources/simulations/wire-transfers.js +6 -5
- package/resources/simulations/wire-transfers.js.map +1 -1
- package/resources/simulations/wire-transfers.mjs +6 -5
- package/resources/simulations/wire-transfers.mjs.map +1 -1
- package/resources/simulations.d.mts +2 -0
- package/resources/simulations.d.mts.map +1 -0
- package/resources/simulations.d.ts.map +1 -1
- package/resources/simulations.js +2 -15
- package/resources/simulations.js.map +1 -1
- package/resources/supplemental-documents.d.mts +92 -0
- package/resources/supplemental-documents.d.mts.map +1 -0
- package/resources/supplemental-documents.d.ts +8 -8
- package/resources/supplemental-documents.d.ts.map +1 -1
- package/resources/supplemental-documents.js +4 -8
- package/resources/supplemental-documents.js.map +1 -1
- package/resources/supplemental-documents.mjs +3 -6
- package/resources/supplemental-documents.mjs.map +1 -1
- package/resources/transactions.d.mts +3483 -0
- package/resources/transactions.d.mts.map +1 -0
- package/resources/transactions.d.ts +8 -9
- package/resources/transactions.d.ts.map +1 -1
- package/resources/transactions.js +18 -14
- package/resources/transactions.js.map +1 -1
- package/resources/transactions.mjs +17 -12
- package/resources/transactions.mjs.map +1 -1
- package/resources/wire-drawdown-requests.d.mts +362 -0
- package/resources/wire-drawdown-requests.d.mts.map +1 -0
- package/resources/wire-drawdown-requests.d.ts +9 -10
- package/resources/wire-drawdown-requests.d.ts.map +1 -1
- package/resources/wire-drawdown-requests.js +18 -14
- package/resources/wire-drawdown-requests.js.map +1 -1
- package/resources/wire-drawdown-requests.mjs +17 -12
- package/resources/wire-drawdown-requests.mjs.map +1 -1
- package/resources/wire-transfers.d.mts +751 -0
- package/resources/wire-transfers.d.mts.map +1 -0
- package/resources/wire-transfers.d.ts +11 -12
- package/resources/wire-transfers.d.ts.map +1 -1
- package/resources/wire-transfers.js +22 -18
- package/resources/wire-transfers.js.map +1 -1
- package/resources/wire-transfers.mjs +21 -16
- package/resources/wire-transfers.mjs.map +1 -1
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts.map +1 -1
- package/resources.js +2 -15
- package/resources.js.map +1 -1
- package/src/api-promise.ts +2 -0
- package/src/client.ts +1692 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +443 -0
- package/src/core/pagination.ts +165 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -443
- package/src/index.ts +6 -1199
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +50 -0
- package/src/internal/qs/formats.ts +2 -1
- package/src/internal/qs/stringify.ts +17 -20
- package/src/internal/qs/utils.ts +14 -14
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +126 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +8 -0
- package/src/pagination.ts +2 -68
- package/src/resource.ts +2 -11
- package/src/resources/account-numbers.ts +18 -27
- package/src/resources/account-statements.ts +13 -22
- package/src/resources/account-transfers.ts +18 -27
- package/src/resources/accounts.ts +23 -42
- package/src/resources/ach-prenotifications.ts +14 -26
- package/src/resources/ach-transfers.ts +18 -27
- package/src/resources/bookkeeping-accounts.ts +24 -45
- package/src/resources/bookkeeping-entries.ts +13 -22
- package/src/resources/bookkeeping-entry-sets.ts +14 -29
- package/src/resources/card-disputes.ts +23 -29
- package/src/resources/card-payments.ts +13 -22
- package/src/resources/card-purchase-supplements.ts +13 -25
- package/src/resources/card-push-transfers.ts +18 -30
- package/src/resources/card-tokens.ts +15 -24
- package/src/resources/card-validations.ts +14 -23
- package/src/resources/cards.ts +24 -34
- package/src/resources/check-deposits.ts +14 -23
- package/src/resources/check-transfers.ts +22 -31
- package/src/resources/declined-transactions.ts +16 -25
- package/src/resources/digital-card-profiles.ts +23 -32
- package/src/resources/digital-wallet-tokens.ts +13 -22
- package/src/resources/documents.ts +14 -20
- package/src/resources/entities.ts +43 -50
- package/src/resources/event-subscriptions.ts +18 -30
- package/src/resources/events.ts +13 -19
- package/src/resources/exports.ts +14 -20
- package/src/resources/external-accounts.ts +18 -27
- package/src/resources/fednow-transfers.ts +18 -27
- package/src/resources/file-links.ts +4 -3
- package/src/resources/files.ts +18 -22
- package/src/resources/groups.ts +4 -3
- package/src/resources/inbound-ach-transfers.ts +31 -37
- package/src/resources/inbound-check-deposits.ts +22 -34
- package/src/resources/inbound-fednow-transfers.ts +13 -25
- package/src/resources/inbound-mail-items.ts +17 -26
- package/src/resources/inbound-real-time-payments-transfers.ts +15 -26
- package/src/resources/inbound-wire-drawdown-requests.ts +15 -26
- package/src/resources/inbound-wire-transfers.ts +17 -29
- package/src/resources/index.ts +68 -58
- package/src/resources/intrafi-account-enrollments.ts +24 -32
- package/src/resources/intrafi-balances.ts +6 -4
- package/src/resources/intrafi-exclusions.ts +16 -28
- package/src/resources/lockboxes.ts +16 -26
- package/src/resources/oauth-applications.ts +13 -22
- package/src/resources/oauth-connections.ts +13 -22
- package/src/resources/oauth-tokens.ts +4 -3
- package/src/resources/pending-transactions.ts +16 -28
- package/src/resources/physical-card-profiles.ts +23 -38
- package/src/resources/physical-cards.ts +18 -27
- package/src/resources/programs.ts +13 -19
- package/src/resources/real-time-decisions.ts +10 -8
- package/src/resources/real-time-payments-transfers.ts +29 -37
- package/src/resources/routing-numbers.ts +11 -10
- package/src/resources/simulations/account-statements.ts +5 -4
- package/src/resources/simulations/account-transfers.ts +8 -6
- package/src/resources/simulations/ach-transfers.ts +23 -24
- package/src/resources/simulations/card-authorization-expirations.ts +5 -4
- package/src/resources/simulations/card-authorizations.ts +5 -4
- package/src/resources/simulations/card-disputes.ts +8 -6
- package/src/resources/simulations/card-fuel-confirmations.ts +5 -4
- package/src/resources/simulations/card-increments.ts +4 -6
- package/src/resources/simulations/card-refunds.ts +4 -6
- package/src/resources/simulations/card-reversals.ts +4 -6
- package/src/resources/simulations/card-settlements.ts +5 -4
- package/src/resources/simulations/card-tokens.ts +4 -6
- package/src/resources/simulations/check-deposits.ts +10 -17
- package/src/resources/simulations/check-transfers.ts +6 -7
- package/src/resources/simulations/digital-wallet-token-requests.ts +5 -4
- package/src/resources/simulations/documents.ts +4 -3
- package/src/resources/simulations/inbound-ach-transfers.ts +5 -4
- package/src/resources/simulations/inbound-check-deposits.ts +5 -4
- package/src/resources/simulations/inbound-fednow-transfers.ts +5 -4
- package/src/resources/simulations/inbound-mail-items.ts +5 -4
- package/src/resources/simulations/inbound-real-time-payments-transfers.ts +5 -4
- package/src/resources/simulations/inbound-wire-drawdown-requests.ts +5 -4
- package/src/resources/simulations/inbound-wire-transfers.ts +5 -4
- package/src/resources/simulations/interest-payments.ts +5 -4
- package/src/resources/simulations/pending-transactions.ts +8 -6
- package/src/resources/simulations/physical-cards.ts +12 -10
- package/src/resources/simulations/programs.ts +4 -3
- package/src/resources/simulations/real-time-payments-transfers.ts +8 -6
- package/src/resources/simulations/simulations.ts +1 -1
- package/src/resources/simulations/wire-drawdown-requests.ts +18 -10
- package/src/resources/simulations/wire-transfers.ts +8 -12
- package/src/resources/supplemental-documents.ts +11 -12
- package/src/resources/transactions.ts +13 -22
- package/src/resources/wire-drawdown-requests.ts +14 -29
- package/src/resources/wire-transfers.ts +18 -27
- package/src/tsconfig.json +2 -2
- package/src/uploads.ts +2 -255
- package/src/version.ts +1 -1
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +1 -74
- package/uploads.d.ts.map +1 -1
- package/uploads.js +3 -168
- package/uploads.js.map +1 -1
- package/uploads.mjs +1 -157
- package/uploads.mjs.map +1 -1
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/_shims/MultipartBody.d.ts +0 -9
- package/_shims/MultipartBody.d.ts.map +0 -1
- package/_shims/MultipartBody.js +0 -16
- package/_shims/MultipartBody.js.map +0 -1
- package/_shims/MultipartBody.mjs +0 -12
- package/_shims/MultipartBody.mjs.map +0 -1
- package/_shims/README.md +0 -46
- package/_shims/auto/runtime-bun.d.ts +0 -5
- package/_shims/auto/runtime-bun.d.ts.map +0 -1
- package/_shims/auto/runtime-bun.js +0 -21
- package/_shims/auto/runtime-bun.js.map +0 -1
- package/_shims/auto/runtime-bun.mjs +0 -2
- package/_shims/auto/runtime-bun.mjs.map +0 -1
- package/_shims/auto/runtime-node.d.ts +0 -5
- package/_shims/auto/runtime-node.d.ts.map +0 -1
- package/_shims/auto/runtime-node.js +0 -21
- package/_shims/auto/runtime-node.js.map +0 -1
- package/_shims/auto/runtime-node.mjs +0 -2
- package/_shims/auto/runtime-node.mjs.map +0 -1
- package/_shims/auto/runtime.d.ts +0 -5
- package/_shims/auto/runtime.d.ts.map +0 -1
- package/_shims/auto/runtime.js +0 -21
- package/_shims/auto/runtime.js.map +0 -1
- package/_shims/auto/runtime.mjs +0 -2
- package/_shims/auto/runtime.mjs.map +0 -1
- package/_shims/auto/types-node.d.ts +0 -5
- package/_shims/auto/types-node.d.ts.map +0 -1
- package/_shims/auto/types-node.js +0 -21
- package/_shims/auto/types-node.js.map +0 -1
- package/_shims/auto/types-node.mjs +0 -2
- package/_shims/auto/types-node.mjs.map +0 -1
- package/_shims/auto/types.d.ts +0 -101
- package/_shims/auto/types.js +0 -3
- package/_shims/auto/types.mjs +0 -3
- package/_shims/bun-runtime.d.ts +0 -6
- package/_shims/bun-runtime.d.ts.map +0 -1
- package/_shims/bun-runtime.js +0 -14
- package/_shims/bun-runtime.js.map +0 -1
- package/_shims/bun-runtime.mjs +0 -10
- package/_shims/bun-runtime.mjs.map +0 -1
- package/_shims/index.d.ts +0 -83
- package/_shims/index.js +0 -17
- package/_shims/index.mjs +0 -11
- package/_shims/manual-types.d.ts +0 -12
- package/_shims/manual-types.js +0 -3
- package/_shims/manual-types.mjs +0 -3
- package/_shims/node-runtime.d.ts +0 -3
- package/_shims/node-runtime.d.ts.map +0 -1
- package/_shims/node-runtime.js +0 -89
- package/_shims/node-runtime.js.map +0 -1
- package/_shims/node-runtime.mjs +0 -56
- package/_shims/node-runtime.mjs.map +0 -1
- package/_shims/node-types.d.ts +0 -42
- package/_shims/node-types.js +0 -3
- package/_shims/node-types.mjs +0 -3
- package/_shims/registry.d.ts +0 -37
- package/_shims/registry.d.ts.map +0 -1
- package/_shims/registry.js +0 -41
- package/_shims/registry.js.map +0 -1
- package/_shims/registry.mjs +0 -37
- package/_shims/registry.mjs.map +0 -1
- package/_shims/web-runtime.d.ts +0 -5
- package/_shims/web-runtime.d.ts.map +0 -1
- package/_shims/web-runtime.js +0 -78
- package/_shims/web-runtime.js.map +0 -1
- package/_shims/web-runtime.mjs +0 -71
- package/_shims/web-runtime.mjs.map +0 -1
- package/_shims/web-types.d.ts +0 -83
- package/_shims/web-types.js +0 -3
- package/_shims/web-types.mjs +0 -3
- package/core.d.ts +0 -255
- package/core.d.ts.map +0 -1
- package/core.js +0 -924
- package/core.js.map +0 -1
- package/core.mjs +0 -892
- package/core.mjs.map +0 -1
- package/resources/webhooks.d.ts +0 -22
- package/resources/webhooks.d.ts.map +0 -1
- package/resources/webhooks.js +0 -82
- package/resources/webhooks.js.map +0 -1
- package/resources/webhooks.mjs +0 -78
- package/resources/webhooks.mjs.map +0 -1
- package/shims/node.d.ts +0 -30
- package/shims/node.d.ts.map +0 -1
- package/shims/node.js +0 -31
- package/shims/node.js.map +0 -1
- package/shims/node.mjs +0 -5
- package/shims/node.mjs.map +0 -1
- package/shims/web.d.ts +0 -26
- package/shims/web.d.ts.map +0 -1
- package/shims/web.js +0 -31
- package/shims/web.js.map +0 -1
- package/shims/web.mjs +0 -5
- package/shims/web.mjs.map +0 -1
- package/src/_shims/MultipartBody.ts +0 -9
- package/src/_shims/README.md +0 -46
- package/src/_shims/auto/runtime-bun.ts +0 -4
- package/src/_shims/auto/runtime-node.ts +0 -4
- package/src/_shims/auto/runtime.ts +0 -4
- package/src/_shims/auto/types-node.ts +0 -4
- package/src/_shims/auto/types.d.ts +0 -101
- package/src/_shims/auto/types.js +0 -3
- package/src/_shims/auto/types.mjs +0 -3
- package/src/_shims/bun-runtime.ts +0 -14
- package/src/_shims/index.d.ts +0 -83
- package/src/_shims/index.js +0 -17
- package/src/_shims/index.mjs +0 -11
- package/src/_shims/manual-types.d.ts +0 -12
- package/src/_shims/manual-types.js +0 -3
- package/src/_shims/manual-types.mjs +0 -3
- package/src/_shims/node-runtime.ts +0 -81
- package/src/_shims/node-types.d.ts +0 -42
- package/src/_shims/node-types.js +0 -3
- package/src/_shims/node-types.mjs +0 -3
- package/src/_shims/registry.ts +0 -67
- package/src/_shims/web-runtime.ts +0 -103
- package/src/_shims/web-types.d.ts +0 -83
- package/src/_shims/web-types.js +0 -3
- package/src/_shims/web-types.mjs +0 -3
- package/src/core.ts +0 -1236
- package/src/resources/webhooks.ts +0 -110
- package/src/shims/node.ts +0 -50
- package/src/shims/web.ts +0 -50
|
@@ -0,0 +1,4523 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { Page, type PageParams, PagePromise } from "../core/pagination.mjs";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
|
+
export declare class CardPayments extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Retrieve a Card Payment
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const cardPayment = await client.cardPayments.retrieve(
|
|
12
|
+
* 'card_payment_nd3k2kacrqjli8482ave',
|
|
13
|
+
* );
|
|
14
|
+
* ```
|
|
15
|
+
*/
|
|
16
|
+
retrieve(cardPaymentID: string, options?: RequestOptions): APIPromise<CardPayment>;
|
|
17
|
+
/**
|
|
18
|
+
* List Card Payments
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```ts
|
|
22
|
+
* // Automatically fetches more pages as needed.
|
|
23
|
+
* for await (const cardPayment of client.cardPayments.list()) {
|
|
24
|
+
* // ...
|
|
25
|
+
* }
|
|
26
|
+
* ```
|
|
27
|
+
*/
|
|
28
|
+
list(query?: CardPaymentListParams | null | undefined, options?: RequestOptions): PagePromise<CardPaymentsPage, CardPayment>;
|
|
29
|
+
}
|
|
30
|
+
export type CardPaymentsPage = Page<CardPayment>;
|
|
31
|
+
/**
|
|
32
|
+
* Card Payments group together interactions related to a single card payment, such
|
|
33
|
+
* as an authorization and its corresponding settlement.
|
|
34
|
+
*/
|
|
35
|
+
export interface CardPayment {
|
|
36
|
+
/**
|
|
37
|
+
* The Card Payment identifier.
|
|
38
|
+
*/
|
|
39
|
+
id: string;
|
|
40
|
+
/**
|
|
41
|
+
* The identifier for the Account the Transaction belongs to.
|
|
42
|
+
*/
|
|
43
|
+
account_id: string;
|
|
44
|
+
/**
|
|
45
|
+
* The Card identifier for this payment.
|
|
46
|
+
*/
|
|
47
|
+
card_id: string;
|
|
48
|
+
/**
|
|
49
|
+
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card
|
|
50
|
+
* Payment was created.
|
|
51
|
+
*/
|
|
52
|
+
created_at: string;
|
|
53
|
+
/**
|
|
54
|
+
* The Digital Wallet Token identifier for this payment.
|
|
55
|
+
*/
|
|
56
|
+
digital_wallet_token_id: string | null;
|
|
57
|
+
/**
|
|
58
|
+
* The interactions related to this card payment.
|
|
59
|
+
*/
|
|
60
|
+
elements: Array<CardPayment.Element>;
|
|
61
|
+
/**
|
|
62
|
+
* The Physical Card identifier for this payment.
|
|
63
|
+
*/
|
|
64
|
+
physical_card_id: string | null;
|
|
65
|
+
/**
|
|
66
|
+
* The summarized state of this card payment.
|
|
67
|
+
*/
|
|
68
|
+
state: CardPayment.State;
|
|
69
|
+
/**
|
|
70
|
+
* A constant representing the object's type. For this resource it will always be
|
|
71
|
+
* `card_payment`.
|
|
72
|
+
*/
|
|
73
|
+
type: 'card_payment';
|
|
74
|
+
}
|
|
75
|
+
export declare namespace CardPayment {
|
|
76
|
+
interface Element {
|
|
77
|
+
/**
|
|
78
|
+
* A Card Authentication object. This field will be present in the JSON response if
|
|
79
|
+
* and only if `category` is equal to `card_authentication`. Card Authentications
|
|
80
|
+
* are attempts to authenticate a transaction or a card with 3DS.
|
|
81
|
+
*/
|
|
82
|
+
card_authentication: Element.CardAuthentication | null;
|
|
83
|
+
/**
|
|
84
|
+
* A Card Authorization object. This field will be present in the JSON response if
|
|
85
|
+
* and only if `category` is equal to `card_authorization`. Card Authorizations are
|
|
86
|
+
* temporary holds placed on a customers funds with the intent to later clear a
|
|
87
|
+
* transaction.
|
|
88
|
+
*/
|
|
89
|
+
card_authorization: Element.CardAuthorization | null;
|
|
90
|
+
/**
|
|
91
|
+
* A Card Authorization Expiration object. This field will be present in the JSON
|
|
92
|
+
* response if and only if `category` is equal to `card_authorization_expiration`.
|
|
93
|
+
* Card Authorization Expirations are cancellations of authorizations that were
|
|
94
|
+
* never settled by the acquirer.
|
|
95
|
+
*/
|
|
96
|
+
card_authorization_expiration: Element.CardAuthorizationExpiration | null;
|
|
97
|
+
/**
|
|
98
|
+
* A Card Decline object. This field will be present in the JSON response if and
|
|
99
|
+
* only if `category` is equal to `card_decline`.
|
|
100
|
+
*/
|
|
101
|
+
card_decline: Element.CardDecline | null;
|
|
102
|
+
/**
|
|
103
|
+
* A Card Financial object. This field will be present in the JSON response if and
|
|
104
|
+
* only if `category` is equal to `card_financial`. Card Financials are temporary
|
|
105
|
+
* holds placed on a customers funds with the intent to later clear a transaction.
|
|
106
|
+
*/
|
|
107
|
+
card_financial: Element.CardFinancial | null;
|
|
108
|
+
/**
|
|
109
|
+
* A Card Fuel Confirmation object. This field will be present in the JSON response
|
|
110
|
+
* if and only if `category` is equal to `card_fuel_confirmation`. Card Fuel
|
|
111
|
+
* Confirmations update the amount of a Card Authorization after a fuel pump
|
|
112
|
+
* transaction is completed.
|
|
113
|
+
*/
|
|
114
|
+
card_fuel_confirmation: Element.CardFuelConfirmation | null;
|
|
115
|
+
/**
|
|
116
|
+
* A Card Increment object. This field will be present in the JSON response if and
|
|
117
|
+
* only if `category` is equal to `card_increment`. Card Increments increase the
|
|
118
|
+
* pending amount of an authorized transaction.
|
|
119
|
+
*/
|
|
120
|
+
card_increment: Element.CardIncrement | null;
|
|
121
|
+
/**
|
|
122
|
+
* A Card Refund object. This field will be present in the JSON response if and
|
|
123
|
+
* only if `category` is equal to `card_refund`. Card Refunds move money back to
|
|
124
|
+
* the cardholder. While they are usually connected to a Card Settlement an
|
|
125
|
+
* acquirer can also refund money directly to a card without relation to a
|
|
126
|
+
* transaction.
|
|
127
|
+
*/
|
|
128
|
+
card_refund: Element.CardRefund | null;
|
|
129
|
+
/**
|
|
130
|
+
* A Card Reversal object. This field will be present in the JSON response if and
|
|
131
|
+
* only if `category` is equal to `card_reversal`. Card Reversals cancel parts of
|
|
132
|
+
* or the entirety of an existing Card Authorization.
|
|
133
|
+
*/
|
|
134
|
+
card_reversal: Element.CardReversal | null;
|
|
135
|
+
/**
|
|
136
|
+
* A Card Settlement object. This field will be present in the JSON response if and
|
|
137
|
+
* only if `category` is equal to `card_settlement`. Card Settlements are card
|
|
138
|
+
* transactions that have cleared and settled. While a settlement is usually
|
|
139
|
+
* preceded by an authorization, an acquirer can also directly clear a transaction
|
|
140
|
+
* without first authorizing it.
|
|
141
|
+
*/
|
|
142
|
+
card_settlement: Element.CardSettlement | null;
|
|
143
|
+
/**
|
|
144
|
+
* An Inbound Card Validation object. This field will be present in the JSON
|
|
145
|
+
* response if and only if `category` is equal to `card_validation`. Inbound Card
|
|
146
|
+
* Validations are requests from a merchant to verify that a card number and
|
|
147
|
+
* optionally its address and/or Card Verification Value are valid.
|
|
148
|
+
*/
|
|
149
|
+
card_validation: Element.CardValidation | null;
|
|
150
|
+
/**
|
|
151
|
+
* The type of the resource. We may add additional possible values for this enum
|
|
152
|
+
* over time; your application should be able to handle such additions gracefully.
|
|
153
|
+
*
|
|
154
|
+
* - `card_authorization` - Card Authorization: details will be under the
|
|
155
|
+
* `card_authorization` object.
|
|
156
|
+
* - `card_authentication` - Card Authentication: details will be under the
|
|
157
|
+
* `card_authentication` object.
|
|
158
|
+
* - `card_validation` - Inbound Card Validation: details will be under the
|
|
159
|
+
* `card_validation` object.
|
|
160
|
+
* - `card_decline` - Card Decline: details will be under the `card_decline`
|
|
161
|
+
* object.
|
|
162
|
+
* - `card_reversal` - Card Reversal: details will be under the `card_reversal`
|
|
163
|
+
* object.
|
|
164
|
+
* - `card_authorization_expiration` - Card Authorization Expiration: details will
|
|
165
|
+
* be under the `card_authorization_expiration` object.
|
|
166
|
+
* - `card_increment` - Card Increment: details will be under the `card_increment`
|
|
167
|
+
* object.
|
|
168
|
+
* - `card_settlement` - Card Settlement: details will be under the
|
|
169
|
+
* `card_settlement` object.
|
|
170
|
+
* - `card_refund` - Card Refund: details will be under the `card_refund` object.
|
|
171
|
+
* - `card_fuel_confirmation` - Card Fuel Confirmation: details will be under the
|
|
172
|
+
* `card_fuel_confirmation` object.
|
|
173
|
+
* - `card_financial` - Card Financial: details will be under the `card_financial`
|
|
174
|
+
* object.
|
|
175
|
+
* - `other` - Unknown card payment element.
|
|
176
|
+
*/
|
|
177
|
+
category: 'card_authorization' | 'card_authentication' | 'card_validation' | 'card_decline' | 'card_reversal' | 'card_authorization_expiration' | 'card_increment' | 'card_settlement' | 'card_refund' | 'card_fuel_confirmation' | 'card_financial' | 'other';
|
|
178
|
+
/**
|
|
179
|
+
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
180
|
+
* the card payment element was created.
|
|
181
|
+
*/
|
|
182
|
+
created_at: string;
|
|
183
|
+
/**
|
|
184
|
+
* If the category of this Transaction source is equal to `other`, this field will
|
|
185
|
+
* contain an empty object, otherwise it will contain null.
|
|
186
|
+
*/
|
|
187
|
+
other: Element.Other | null;
|
|
188
|
+
}
|
|
189
|
+
namespace Element {
|
|
190
|
+
/**
|
|
191
|
+
* A Card Authentication object. This field will be present in the JSON response if
|
|
192
|
+
* and only if `category` is equal to `card_authentication`. Card Authentications
|
|
193
|
+
* are attempts to authenticate a transaction or a card with 3DS.
|
|
194
|
+
*/
|
|
195
|
+
interface CardAuthentication {
|
|
196
|
+
/**
|
|
197
|
+
* The Card Authentication identifier.
|
|
198
|
+
*/
|
|
199
|
+
id: string;
|
|
200
|
+
/**
|
|
201
|
+
* The identifier of the Card.
|
|
202
|
+
*/
|
|
203
|
+
card_id: string;
|
|
204
|
+
/**
|
|
205
|
+
* The ID of the Card Payment this transaction belongs to.
|
|
206
|
+
*/
|
|
207
|
+
card_payment_id: string;
|
|
208
|
+
/**
|
|
209
|
+
* The category of the card authentication attempt.
|
|
210
|
+
*
|
|
211
|
+
* - `payment_authentication` - The authentication attempt is for a payment.
|
|
212
|
+
* - `non_payment_authentication` - The authentication attempt is not for a
|
|
213
|
+
* payment.
|
|
214
|
+
*/
|
|
215
|
+
category: 'payment_authentication' | 'non_payment_authentication' | null;
|
|
216
|
+
/**
|
|
217
|
+
* Details about the challenge, if one was requested.
|
|
218
|
+
*/
|
|
219
|
+
challenge: CardAuthentication.Challenge | null;
|
|
220
|
+
/**
|
|
221
|
+
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card
|
|
222
|
+
* Authentication was attempted.
|
|
223
|
+
*/
|
|
224
|
+
created_at: string;
|
|
225
|
+
/**
|
|
226
|
+
* The reason why this authentication attempt was denied, if it was.
|
|
227
|
+
*
|
|
228
|
+
* - `group_locked` - The group was locked.
|
|
229
|
+
* - `card_not_active` - The card was not active.
|
|
230
|
+
* - `entity_not_active` - The entity was not active.
|
|
231
|
+
* - `transaction_not_allowed` - The transaction was not allowed.
|
|
232
|
+
* - `webhook_denied` - The webhook was denied.
|
|
233
|
+
* - `webhook_timed_out` - The webhook timed out.
|
|
234
|
+
*/
|
|
235
|
+
deny_reason: 'group_locked' | 'card_not_active' | 'entity_not_active' | 'transaction_not_allowed' | 'webhook_denied' | 'webhook_timed_out' | null;
|
|
236
|
+
/**
|
|
237
|
+
* The device channel of the card authentication attempt.
|
|
238
|
+
*
|
|
239
|
+
* - `app` - The authentication attempt was made from an app.
|
|
240
|
+
* - `browser` - The authentication attempt was made from a browser.
|
|
241
|
+
* - `three_ds_requestor_initiated` - The authentication attempt was initiated by
|
|
242
|
+
* the 3DS Requestor.
|
|
243
|
+
*/
|
|
244
|
+
device_channel: 'app' | 'browser' | 'three_ds_requestor_initiated' | null;
|
|
245
|
+
/**
|
|
246
|
+
* The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
247
|
+
* is transacting with.
|
|
248
|
+
*/
|
|
249
|
+
merchant_acceptor_id: string;
|
|
250
|
+
/**
|
|
251
|
+
* The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
|
252
|
+
* card is transacting with.
|
|
253
|
+
*/
|
|
254
|
+
merchant_category_code: string;
|
|
255
|
+
/**
|
|
256
|
+
* The country the merchant resides in.
|
|
257
|
+
*/
|
|
258
|
+
merchant_country: string;
|
|
259
|
+
/**
|
|
260
|
+
* The name of the merchant.
|
|
261
|
+
*/
|
|
262
|
+
merchant_name: string;
|
|
263
|
+
/**
|
|
264
|
+
* The purchase amount in minor units.
|
|
265
|
+
*/
|
|
266
|
+
purchase_amount: number | null;
|
|
267
|
+
/**
|
|
268
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
269
|
+
* authentication attempt's purchase currency.
|
|
270
|
+
*/
|
|
271
|
+
purchase_currency: string | null;
|
|
272
|
+
/**
|
|
273
|
+
* The identifier of the Real-Time Decision sent to approve or decline this
|
|
274
|
+
* authentication attempt.
|
|
275
|
+
*/
|
|
276
|
+
real_time_decision_id: string | null;
|
|
277
|
+
/**
|
|
278
|
+
* The status of the card authentication.
|
|
279
|
+
*
|
|
280
|
+
* - `denied` - The authentication attempt was denied.
|
|
281
|
+
* - `authenticated_with_challenge` - The authentication attempt was authenticated
|
|
282
|
+
* with a challenge.
|
|
283
|
+
* - `authenticated_without_challenge` - The authentication attempt was
|
|
284
|
+
* authenticated without a challenge.
|
|
285
|
+
* - `awaiting_challenge` - The authentication attempt is awaiting a challenge.
|
|
286
|
+
* - `validating_challenge` - The authentication attempt is validating a challenge.
|
|
287
|
+
* - `canceled` - The authentication attempt was canceled.
|
|
288
|
+
* - `timed_out_awaiting_challenge` - The authentication attempt timed out while
|
|
289
|
+
* awaiting a challenge.
|
|
290
|
+
* - `errored` - The authentication attempt errored.
|
|
291
|
+
* - `exceeded_attempt_threshold` - The authentication attempt exceeded the attempt
|
|
292
|
+
* threshold.
|
|
293
|
+
*/
|
|
294
|
+
status: 'denied' | 'authenticated_with_challenge' | 'authenticated_without_challenge' | 'awaiting_challenge' | 'validating_challenge' | 'canceled' | 'timed_out_awaiting_challenge' | 'errored' | 'exceeded_attempt_threshold';
|
|
295
|
+
/**
|
|
296
|
+
* A constant representing the object's type. For this resource it will always be
|
|
297
|
+
* `card_authentication`.
|
|
298
|
+
*/
|
|
299
|
+
type: 'card_authentication';
|
|
300
|
+
[k: string]: unknown;
|
|
301
|
+
}
|
|
302
|
+
namespace CardAuthentication {
|
|
303
|
+
/**
|
|
304
|
+
* Details about the challenge, if one was requested.
|
|
305
|
+
*/
|
|
306
|
+
interface Challenge {
|
|
307
|
+
/**
|
|
308
|
+
* Details about the challenge verification attempts, if any happened.
|
|
309
|
+
*/
|
|
310
|
+
attempts: Array<Challenge.Attempt>;
|
|
311
|
+
/**
|
|
312
|
+
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card
|
|
313
|
+
* Authentication Challenge was started.
|
|
314
|
+
*/
|
|
315
|
+
created_at: string;
|
|
316
|
+
/**
|
|
317
|
+
* The one-time code used for the Card Authentication Challenge.
|
|
318
|
+
*/
|
|
319
|
+
one_time_code: string;
|
|
320
|
+
/**
|
|
321
|
+
* The method used to verify the Card Authentication Challenge.
|
|
322
|
+
*
|
|
323
|
+
* - `text_message` - The one-time code was sent via text message.
|
|
324
|
+
* - `email` - The one-time code was sent via email.
|
|
325
|
+
* - `none_available` - The one-time code was not successfully delivered.
|
|
326
|
+
*/
|
|
327
|
+
verification_method: 'text_message' | 'email' | 'none_available';
|
|
328
|
+
/**
|
|
329
|
+
* E.g., the email address or phone number used for the Card Authentication
|
|
330
|
+
* Challenge.
|
|
331
|
+
*/
|
|
332
|
+
verification_value: string | null;
|
|
333
|
+
}
|
|
334
|
+
namespace Challenge {
|
|
335
|
+
interface Attempt {
|
|
336
|
+
/**
|
|
337
|
+
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time of the Card
|
|
338
|
+
* Authentication Challenge Attempt.
|
|
339
|
+
*/
|
|
340
|
+
created_at: string;
|
|
341
|
+
/**
|
|
342
|
+
* The outcome of the Card Authentication Challenge Attempt.
|
|
343
|
+
*
|
|
344
|
+
* - `successful` - The attempt was successful.
|
|
345
|
+
* - `failed` - The attempt was unsuccessful.
|
|
346
|
+
*/
|
|
347
|
+
outcome: 'successful' | 'failed';
|
|
348
|
+
}
|
|
349
|
+
}
|
|
350
|
+
}
|
|
351
|
+
/**
|
|
352
|
+
* A Card Authorization object. This field will be present in the JSON response if
|
|
353
|
+
* and only if `category` is equal to `card_authorization`. Card Authorizations are
|
|
354
|
+
* temporary holds placed on a customers funds with the intent to later clear a
|
|
355
|
+
* transaction.
|
|
356
|
+
*/
|
|
357
|
+
interface CardAuthorization {
|
|
358
|
+
/**
|
|
359
|
+
* The Card Authorization identifier.
|
|
360
|
+
*/
|
|
361
|
+
id: string;
|
|
362
|
+
/**
|
|
363
|
+
* Whether this authorization was approved by Increase, the card network through
|
|
364
|
+
* stand-in processing, or the user through a real-time decision.
|
|
365
|
+
*
|
|
366
|
+
* - `user` - This object was actioned by the user through a real-time decision.
|
|
367
|
+
* - `increase` - This object was actioned by Increase without user intervention.
|
|
368
|
+
* - `network` - This object was actioned by the network, through stand-in
|
|
369
|
+
* processing.
|
|
370
|
+
*/
|
|
371
|
+
actioner: 'user' | 'increase' | 'network';
|
|
372
|
+
/**
|
|
373
|
+
* Additional amounts associated with the card authorization, such as ATM
|
|
374
|
+
* surcharges fees. These are usually a subset of the `amount` field and are used
|
|
375
|
+
* to provide more detailed information about the transaction.
|
|
376
|
+
*/
|
|
377
|
+
additional_amounts: CardAuthorization.AdditionalAmounts;
|
|
378
|
+
/**
|
|
379
|
+
* The pending amount in the minor unit of the transaction's currency. For dollars,
|
|
380
|
+
* for example, this is cents.
|
|
381
|
+
*/
|
|
382
|
+
amount: number;
|
|
383
|
+
/**
|
|
384
|
+
* The ID of the Card Payment this transaction belongs to.
|
|
385
|
+
*/
|
|
386
|
+
card_payment_id: string;
|
|
387
|
+
/**
|
|
388
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
389
|
+
* transaction's currency.
|
|
390
|
+
*
|
|
391
|
+
* - `USD` - US Dollar (USD)
|
|
392
|
+
*/
|
|
393
|
+
currency: 'USD';
|
|
394
|
+
/**
|
|
395
|
+
* If the authorization was made via a Digital Wallet Token (such as an Apple Pay
|
|
396
|
+
* purchase), the identifier of the token that was used.
|
|
397
|
+
*/
|
|
398
|
+
digital_wallet_token_id: string | null;
|
|
399
|
+
/**
|
|
400
|
+
* The direction describes the direction the funds will move, either from the
|
|
401
|
+
* cardholder to the merchant or from the merchant to the cardholder.
|
|
402
|
+
*
|
|
403
|
+
* - `settlement` - A regular card authorization where funds are debited from the
|
|
404
|
+
* cardholder.
|
|
405
|
+
* - `refund` - A refund card authorization, sometimes referred to as a credit
|
|
406
|
+
* voucher authorization, where funds are credited to the cardholder.
|
|
407
|
+
*/
|
|
408
|
+
direction: 'settlement' | 'refund';
|
|
409
|
+
/**
|
|
410
|
+
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization
|
|
411
|
+
* will expire and the pending transaction will be released.
|
|
412
|
+
*/
|
|
413
|
+
expires_at: string;
|
|
414
|
+
/**
|
|
415
|
+
* The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
416
|
+
* is transacting with.
|
|
417
|
+
*/
|
|
418
|
+
merchant_acceptor_id: string;
|
|
419
|
+
/**
|
|
420
|
+
* The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
|
421
|
+
* card is transacting with.
|
|
422
|
+
*/
|
|
423
|
+
merchant_category_code: string;
|
|
424
|
+
/**
|
|
425
|
+
* The city the merchant resides in.
|
|
426
|
+
*/
|
|
427
|
+
merchant_city: string | null;
|
|
428
|
+
/**
|
|
429
|
+
* The country the merchant resides in.
|
|
430
|
+
*/
|
|
431
|
+
merchant_country: string;
|
|
432
|
+
/**
|
|
433
|
+
* The merchant descriptor of the merchant the card is transacting with.
|
|
434
|
+
*/
|
|
435
|
+
merchant_descriptor: string;
|
|
436
|
+
/**
|
|
437
|
+
* The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
|
|
438
|
+
* ZIP code, where the first 5 and last 4 are separated by a dash.
|
|
439
|
+
*/
|
|
440
|
+
merchant_postal_code: string | null;
|
|
441
|
+
/**
|
|
442
|
+
* The state the merchant resides in.
|
|
443
|
+
*/
|
|
444
|
+
merchant_state: string | null;
|
|
445
|
+
/**
|
|
446
|
+
* Fields specific to the `network`.
|
|
447
|
+
*/
|
|
448
|
+
network_details: CardAuthorization.NetworkDetails;
|
|
449
|
+
/**
|
|
450
|
+
* Network-specific identifiers for a specific request or transaction.
|
|
451
|
+
*/
|
|
452
|
+
network_identifiers: CardAuthorization.NetworkIdentifiers;
|
|
453
|
+
/**
|
|
454
|
+
* The risk score generated by the card network. For Visa this is the Visa Advanced
|
|
455
|
+
* Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
|
|
456
|
+
* score is from 0 to 999, where 999 is the riskiest.
|
|
457
|
+
*/
|
|
458
|
+
network_risk_score: number | null;
|
|
459
|
+
/**
|
|
460
|
+
* The identifier of the Pending Transaction associated with this Transaction.
|
|
461
|
+
*/
|
|
462
|
+
pending_transaction_id: string | null;
|
|
463
|
+
/**
|
|
464
|
+
* If the authorization was made in-person with a physical card, the Physical Card
|
|
465
|
+
* that was used.
|
|
466
|
+
*/
|
|
467
|
+
physical_card_id: string | null;
|
|
468
|
+
/**
|
|
469
|
+
* The pending amount in the minor unit of the transaction's presentment currency.
|
|
470
|
+
*/
|
|
471
|
+
presentment_amount: number;
|
|
472
|
+
/**
|
|
473
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
474
|
+
* transaction's presentment currency.
|
|
475
|
+
*/
|
|
476
|
+
presentment_currency: string;
|
|
477
|
+
/**
|
|
478
|
+
* The processing category describes the intent behind the authorization, such as
|
|
479
|
+
* whether it was used for bill payments or an automatic fuel dispenser.
|
|
480
|
+
*
|
|
481
|
+
* - `account_funding` - Account funding transactions are transactions used to
|
|
482
|
+
* e.g., fund an account or transfer funds between accounts.
|
|
483
|
+
* - `automatic_fuel_dispenser` - Automatic fuel dispenser authorizations occur
|
|
484
|
+
* when a card is used at a gas pump, prior to the actual transaction amount
|
|
485
|
+
* being known. They are followed by an advice message that updates the amount of
|
|
486
|
+
* the pending transaction.
|
|
487
|
+
* - `bill_payment` - A transaction used to pay a bill.
|
|
488
|
+
* - `original_credit` - Original credit transactions are used to send money to a
|
|
489
|
+
* cardholder.
|
|
490
|
+
* - `purchase` - A regular purchase.
|
|
491
|
+
* - `quasi_cash` - Quasi-cash transactions represent purchases of items which may
|
|
492
|
+
* be convertible to cash.
|
|
493
|
+
* - `refund` - A refund card authorization, sometimes referred to as a credit
|
|
494
|
+
* voucher authorization, where funds are credited to the cardholder.
|
|
495
|
+
* - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
|
|
496
|
+
* from an ATM or a point of sale.
|
|
497
|
+
* - `unknown` - The processing category is unknown.
|
|
498
|
+
*/
|
|
499
|
+
processing_category: 'account_funding' | 'automatic_fuel_dispenser' | 'bill_payment' | 'original_credit' | 'purchase' | 'quasi_cash' | 'refund' | 'cash_disbursement' | 'unknown';
|
|
500
|
+
/**
|
|
501
|
+
* The identifier of the Real-Time Decision sent to approve or decline this
|
|
502
|
+
* transaction.
|
|
503
|
+
*/
|
|
504
|
+
real_time_decision_id: string | null;
|
|
505
|
+
/**
|
|
506
|
+
* The terminal identifier (commonly abbreviated as TID) of the terminal the card
|
|
507
|
+
* is transacting with.
|
|
508
|
+
*/
|
|
509
|
+
terminal_id: string | null;
|
|
510
|
+
/**
|
|
511
|
+
* A constant representing the object's type. For this resource it will always be
|
|
512
|
+
* `card_authorization`.
|
|
513
|
+
*/
|
|
514
|
+
type: 'card_authorization';
|
|
515
|
+
/**
|
|
516
|
+
* Fields related to verification of cardholder-provided values.
|
|
517
|
+
*/
|
|
518
|
+
verification: CardAuthorization.Verification;
|
|
519
|
+
[k: string]: unknown;
|
|
520
|
+
}
|
|
521
|
+
namespace CardAuthorization {
|
|
522
|
+
/**
|
|
523
|
+
* Additional amounts associated with the card authorization, such as ATM
|
|
524
|
+
* surcharges fees. These are usually a subset of the `amount` field and are used
|
|
525
|
+
* to provide more detailed information about the transaction.
|
|
526
|
+
*/
|
|
527
|
+
interface AdditionalAmounts {
|
|
528
|
+
/**
|
|
529
|
+
* The part of this transaction amount that was for clinic-related services.
|
|
530
|
+
*/
|
|
531
|
+
clinic: AdditionalAmounts.Clinic | null;
|
|
532
|
+
/**
|
|
533
|
+
* The part of this transaction amount that was for dental-related services.
|
|
534
|
+
*/
|
|
535
|
+
dental: AdditionalAmounts.Dental | null;
|
|
536
|
+
/**
|
|
537
|
+
* The original pre-authorized amount.
|
|
538
|
+
*/
|
|
539
|
+
original: AdditionalAmounts.Original | null;
|
|
540
|
+
/**
|
|
541
|
+
* The part of this transaction amount that was for healthcare prescriptions.
|
|
542
|
+
*/
|
|
543
|
+
prescription: AdditionalAmounts.Prescription | null;
|
|
544
|
+
/**
|
|
545
|
+
* The surcharge amount charged for this transaction by the merchant.
|
|
546
|
+
*/
|
|
547
|
+
surcharge: AdditionalAmounts.Surcharge | null;
|
|
548
|
+
/**
|
|
549
|
+
* The total amount of a series of incremental authorizations, optionally provided.
|
|
550
|
+
*/
|
|
551
|
+
total_cumulative: AdditionalAmounts.TotalCumulative | null;
|
|
552
|
+
/**
|
|
553
|
+
* The total amount of healthcare-related additional amounts.
|
|
554
|
+
*/
|
|
555
|
+
total_healthcare: AdditionalAmounts.TotalHealthcare | null;
|
|
556
|
+
/**
|
|
557
|
+
* The part of this transaction amount that was for transit-related services.
|
|
558
|
+
*/
|
|
559
|
+
transit: AdditionalAmounts.Transit | null;
|
|
560
|
+
/**
|
|
561
|
+
* An unknown additional amount.
|
|
562
|
+
*/
|
|
563
|
+
unknown: AdditionalAmounts.Unknown | null;
|
|
564
|
+
/**
|
|
565
|
+
* The part of this transaction amount that was for vision-related services.
|
|
566
|
+
*/
|
|
567
|
+
vision: AdditionalAmounts.Vision | null;
|
|
568
|
+
}
|
|
569
|
+
namespace AdditionalAmounts {
|
|
570
|
+
/**
|
|
571
|
+
* The part of this transaction amount that was for clinic-related services.
|
|
572
|
+
*/
|
|
573
|
+
interface Clinic {
|
|
574
|
+
/**
|
|
575
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
576
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
577
|
+
* subtracted from the amount (such as a discount).
|
|
578
|
+
*/
|
|
579
|
+
amount: number;
|
|
580
|
+
/**
|
|
581
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
582
|
+
* amount's currency.
|
|
583
|
+
*/
|
|
584
|
+
currency: string;
|
|
585
|
+
}
|
|
586
|
+
/**
|
|
587
|
+
* The part of this transaction amount that was for dental-related services.
|
|
588
|
+
*/
|
|
589
|
+
interface Dental {
|
|
590
|
+
/**
|
|
591
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
592
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
593
|
+
* subtracted from the amount (such as a discount).
|
|
594
|
+
*/
|
|
595
|
+
amount: number;
|
|
596
|
+
/**
|
|
597
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
598
|
+
* amount's currency.
|
|
599
|
+
*/
|
|
600
|
+
currency: string;
|
|
601
|
+
}
|
|
602
|
+
/**
|
|
603
|
+
* The original pre-authorized amount.
|
|
604
|
+
*/
|
|
605
|
+
interface Original {
|
|
606
|
+
/**
|
|
607
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
608
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
609
|
+
* subtracted from the amount (such as a discount).
|
|
610
|
+
*/
|
|
611
|
+
amount: number;
|
|
612
|
+
/**
|
|
613
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
614
|
+
* amount's currency.
|
|
615
|
+
*/
|
|
616
|
+
currency: string;
|
|
617
|
+
}
|
|
618
|
+
/**
|
|
619
|
+
* The part of this transaction amount that was for healthcare prescriptions.
|
|
620
|
+
*/
|
|
621
|
+
interface Prescription {
|
|
622
|
+
/**
|
|
623
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
624
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
625
|
+
* subtracted from the amount (such as a discount).
|
|
626
|
+
*/
|
|
627
|
+
amount: number;
|
|
628
|
+
/**
|
|
629
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
630
|
+
* amount's currency.
|
|
631
|
+
*/
|
|
632
|
+
currency: string;
|
|
633
|
+
}
|
|
634
|
+
/**
|
|
635
|
+
* The surcharge amount charged for this transaction by the merchant.
|
|
636
|
+
*/
|
|
637
|
+
interface Surcharge {
|
|
638
|
+
/**
|
|
639
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
640
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
641
|
+
* subtracted from the amount (such as a discount).
|
|
642
|
+
*/
|
|
643
|
+
amount: number;
|
|
644
|
+
/**
|
|
645
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
646
|
+
* amount's currency.
|
|
647
|
+
*/
|
|
648
|
+
currency: string;
|
|
649
|
+
}
|
|
650
|
+
/**
|
|
651
|
+
* The total amount of a series of incremental authorizations, optionally provided.
|
|
652
|
+
*/
|
|
653
|
+
interface TotalCumulative {
|
|
654
|
+
/**
|
|
655
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
656
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
657
|
+
* subtracted from the amount (such as a discount).
|
|
658
|
+
*/
|
|
659
|
+
amount: number;
|
|
660
|
+
/**
|
|
661
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
662
|
+
* amount's currency.
|
|
663
|
+
*/
|
|
664
|
+
currency: string;
|
|
665
|
+
}
|
|
666
|
+
/**
|
|
667
|
+
* The total amount of healthcare-related additional amounts.
|
|
668
|
+
*/
|
|
669
|
+
interface TotalHealthcare {
|
|
670
|
+
/**
|
|
671
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
672
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
673
|
+
* subtracted from the amount (such as a discount).
|
|
674
|
+
*/
|
|
675
|
+
amount: number;
|
|
676
|
+
/**
|
|
677
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
678
|
+
* amount's currency.
|
|
679
|
+
*/
|
|
680
|
+
currency: string;
|
|
681
|
+
}
|
|
682
|
+
/**
|
|
683
|
+
* The part of this transaction amount that was for transit-related services.
|
|
684
|
+
*/
|
|
685
|
+
interface Transit {
|
|
686
|
+
/**
|
|
687
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
688
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
689
|
+
* subtracted from the amount (such as a discount).
|
|
690
|
+
*/
|
|
691
|
+
amount: number;
|
|
692
|
+
/**
|
|
693
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
694
|
+
* amount's currency.
|
|
695
|
+
*/
|
|
696
|
+
currency: string;
|
|
697
|
+
}
|
|
698
|
+
/**
|
|
699
|
+
* An unknown additional amount.
|
|
700
|
+
*/
|
|
701
|
+
interface Unknown {
|
|
702
|
+
/**
|
|
703
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
704
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
705
|
+
* subtracted from the amount (such as a discount).
|
|
706
|
+
*/
|
|
707
|
+
amount: number;
|
|
708
|
+
/**
|
|
709
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
710
|
+
* amount's currency.
|
|
711
|
+
*/
|
|
712
|
+
currency: string;
|
|
713
|
+
}
|
|
714
|
+
/**
|
|
715
|
+
* The part of this transaction amount that was for vision-related services.
|
|
716
|
+
*/
|
|
717
|
+
interface Vision {
|
|
718
|
+
/**
|
|
719
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
720
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
721
|
+
* subtracted from the amount (such as a discount).
|
|
722
|
+
*/
|
|
723
|
+
amount: number;
|
|
724
|
+
/**
|
|
725
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
726
|
+
* amount's currency.
|
|
727
|
+
*/
|
|
728
|
+
currency: string;
|
|
729
|
+
}
|
|
730
|
+
}
|
|
731
|
+
/**
|
|
732
|
+
* Fields specific to the `network`.
|
|
733
|
+
*/
|
|
734
|
+
interface NetworkDetails {
|
|
735
|
+
/**
|
|
736
|
+
* The payment network used to process this card authorization.
|
|
737
|
+
*
|
|
738
|
+
* - `visa` - Visa
|
|
739
|
+
* - `pulse` - Pulse
|
|
740
|
+
*/
|
|
741
|
+
category: 'visa' | 'pulse';
|
|
742
|
+
/**
|
|
743
|
+
* Fields specific to the `pulse` network.
|
|
744
|
+
*/
|
|
745
|
+
pulse: NetworkDetails.Pulse | null;
|
|
746
|
+
/**
|
|
747
|
+
* Fields specific to the `visa` network.
|
|
748
|
+
*/
|
|
749
|
+
visa: NetworkDetails.Visa | null;
|
|
750
|
+
}
|
|
751
|
+
namespace NetworkDetails {
|
|
752
|
+
/**
|
|
753
|
+
* Fields specific to the `pulse` network.
|
|
754
|
+
*/
|
|
755
|
+
interface Pulse {
|
|
756
|
+
}
|
|
757
|
+
/**
|
|
758
|
+
* Fields specific to the `visa` network.
|
|
759
|
+
*/
|
|
760
|
+
interface Visa {
|
|
761
|
+
/**
|
|
762
|
+
* For electronic commerce transactions, this identifies the level of security used
|
|
763
|
+
* in obtaining the customer's payment credential. For mail or telephone order
|
|
764
|
+
* transactions, identifies the type of mail or telephone order.
|
|
765
|
+
*
|
|
766
|
+
* - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
|
|
767
|
+
* that the transaction is a mail/phone order purchase, not a recurring
|
|
768
|
+
* transaction or installment payment. For domestic transactions in the US
|
|
769
|
+
* region, this value may also indicate one bill payment transaction in the
|
|
770
|
+
* card-present or card-absent environments.
|
|
771
|
+
* - `recurring` - Recurring transaction: Payment indicator used to indicate a
|
|
772
|
+
* recurring transaction that originates from an acquirer in the US region.
|
|
773
|
+
* - `installment` - Installment payment: Payment indicator used to indicate one
|
|
774
|
+
* purchase of goods or services that is billed to the account in multiple
|
|
775
|
+
* charges over a period of time agreed upon by the cardholder and merchant from
|
|
776
|
+
* transactions that originate from an acquirer in the US region.
|
|
777
|
+
* - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
|
|
778
|
+
* indicate that the type of mail/telephone order is unknown.
|
|
779
|
+
* - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
|
|
780
|
+
* indicate that the electronic commerce transaction has been authenticated using
|
|
781
|
+
* e.g., 3-D Secure
|
|
782
|
+
* - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
|
|
783
|
+
* Non-authenticated security transaction at a 3-D Secure-capable merchant, and
|
|
784
|
+
* merchant attempted to authenticate the cardholder using 3-D Secure: Use to
|
|
785
|
+
* identify an electronic commerce transaction where the merchant attempted to
|
|
786
|
+
* authenticate the cardholder using 3-D Secure, but was unable to complete the
|
|
787
|
+
* authentication because the issuer or cardholder does not participate in the
|
|
788
|
+
* 3-D Secure program.
|
|
789
|
+
* - `non_authenticated_security_transaction` - Non-authenticated security
|
|
790
|
+
* transaction: Use to identify an electronic commerce transaction that uses data
|
|
791
|
+
* encryption for security however, cardholder authentication is not performed
|
|
792
|
+
* using 3-D Secure.
|
|
793
|
+
* - `non_secure_transaction` - Non-secure transaction: Use to identify an
|
|
794
|
+
* electronic commerce transaction that has no data protection.
|
|
795
|
+
*/
|
|
796
|
+
electronic_commerce_indicator: 'mail_phone_order' | 'recurring' | 'installment' | 'unknown_mail_phone_order' | 'secure_electronic_commerce' | 'non_authenticated_security_transaction_at_3ds_capable_merchant' | 'non_authenticated_security_transaction' | 'non_secure_transaction' | null;
|
|
797
|
+
/**
|
|
798
|
+
* The method used to enter the cardholder's primary account number and card
|
|
799
|
+
* expiration date.
|
|
800
|
+
*
|
|
801
|
+
* - `unknown` - Unknown
|
|
802
|
+
* - `manual` - Manual key entry
|
|
803
|
+
* - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
|
|
804
|
+
* value
|
|
805
|
+
* - `optical_code` - Optical code
|
|
806
|
+
* - `integrated_circuit_card` - Contact chip card
|
|
807
|
+
* - `contactless` - Contactless read of chip card
|
|
808
|
+
* - `credential_on_file` - Transaction initiated using a credential that has
|
|
809
|
+
* previously been stored on file
|
|
810
|
+
* - `magnetic_stripe` - Magnetic stripe read
|
|
811
|
+
* - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
|
|
812
|
+
* - `integrated_circuit_card_no_cvv` - Contact chip card, without card
|
|
813
|
+
* verification value
|
|
814
|
+
*/
|
|
815
|
+
point_of_service_entry_mode: 'unknown' | 'manual' | 'magnetic_stripe_no_cvv' | 'optical_code' | 'integrated_circuit_card' | 'contactless' | 'credential_on_file' | 'magnetic_stripe' | 'contactless_magnetic_stripe' | 'integrated_circuit_card_no_cvv' | null;
|
|
816
|
+
/**
|
|
817
|
+
* Only present when `actioner: network`. Describes why a card authorization was
|
|
818
|
+
* approved or declined by Visa through stand-in processing.
|
|
819
|
+
*
|
|
820
|
+
* - `issuer_error` - Increase failed to process the authorization in a timely
|
|
821
|
+
* manner.
|
|
822
|
+
* - `invalid_physical_card` - The physical card read had an invalid CVV, dCVV, or
|
|
823
|
+
* authorization request cryptogram.
|
|
824
|
+
* - `invalid_cardholder_authentication_verification_value` - The 3DS cardholder
|
|
825
|
+
* authentication verification value was invalid.
|
|
826
|
+
* - `internal_visa_error` - An internal Visa error occurred. Visa uses this reason
|
|
827
|
+
* code for certain expected occurrences as well, such as Application Transaction
|
|
828
|
+
* Counter (ATC) replays.
|
|
829
|
+
* - `merchant_transaction_advisory_service_authentication_required` - The merchant
|
|
830
|
+
* has enabled Visa's Transaction Advisory Service and requires further
|
|
831
|
+
* authentication to perform the transaction. In practice this is often utilized
|
|
832
|
+
* at fuel pumps to tell the cardholder to see the cashier.
|
|
833
|
+
* - `payment_fraud_disruption_acquirer_block` - The transaction was blocked by
|
|
834
|
+
* Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior,
|
|
835
|
+
* such as card testing.
|
|
836
|
+
* - `other` - An unspecific reason for stand-in processing.
|
|
837
|
+
*/
|
|
838
|
+
stand_in_processing_reason: 'issuer_error' | 'invalid_physical_card' | 'invalid_cardholder_authentication_verification_value' | 'internal_visa_error' | 'merchant_transaction_advisory_service_authentication_required' | 'payment_fraud_disruption_acquirer_block' | 'other' | null;
|
|
839
|
+
}
|
|
840
|
+
}
|
|
841
|
+
/**
|
|
842
|
+
* Network-specific identifiers for a specific request or transaction.
|
|
843
|
+
*/
|
|
844
|
+
interface NetworkIdentifiers {
|
|
845
|
+
/**
|
|
846
|
+
* The randomly generated 6-character Authorization Identification Response code
|
|
847
|
+
* sent back to the acquirer in an approved response.
|
|
848
|
+
*/
|
|
849
|
+
authorization_identification_response: string | null;
|
|
850
|
+
/**
|
|
851
|
+
* A life-cycle identifier used across e.g., an authorization and a reversal.
|
|
852
|
+
* Expected to be unique per acquirer within a window of time. For some card
|
|
853
|
+
* networks the retrieval reference number includes the trace counter.
|
|
854
|
+
*/
|
|
855
|
+
retrieval_reference_number: string | null;
|
|
856
|
+
/**
|
|
857
|
+
* A counter used to verify an individual authorization. Expected to be unique per
|
|
858
|
+
* acquirer within a window of time.
|
|
859
|
+
*/
|
|
860
|
+
trace_number: string | null;
|
|
861
|
+
/**
|
|
862
|
+
* A globally unique transaction identifier provided by the card network, used
|
|
863
|
+
* across multiple life-cycle requests.
|
|
864
|
+
*/
|
|
865
|
+
transaction_id: string | null;
|
|
866
|
+
}
|
|
867
|
+
/**
|
|
868
|
+
* Fields related to verification of cardholder-provided values.
|
|
869
|
+
*/
|
|
870
|
+
interface Verification {
|
|
871
|
+
/**
|
|
872
|
+
* Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
873
|
+
* the back of the card.
|
|
874
|
+
*/
|
|
875
|
+
card_verification_code: Verification.CardVerificationCode;
|
|
876
|
+
/**
|
|
877
|
+
* Cardholder address provided in the authorization request and the address on file
|
|
878
|
+
* we verified it against.
|
|
879
|
+
*/
|
|
880
|
+
cardholder_address: Verification.CardholderAddress;
|
|
881
|
+
}
|
|
882
|
+
namespace Verification {
|
|
883
|
+
/**
|
|
884
|
+
* Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
885
|
+
* the back of the card.
|
|
886
|
+
*/
|
|
887
|
+
interface CardVerificationCode {
|
|
888
|
+
/**
|
|
889
|
+
* The result of verifying the Card Verification Code.
|
|
890
|
+
*
|
|
891
|
+
* - `not_checked` - No card verification code was provided in the authorization
|
|
892
|
+
* request.
|
|
893
|
+
* - `match` - The card verification code matched the one on file.
|
|
894
|
+
* - `no_match` - The card verification code did not match the one on file.
|
|
895
|
+
*/
|
|
896
|
+
result: 'not_checked' | 'match' | 'no_match';
|
|
897
|
+
}
|
|
898
|
+
/**
|
|
899
|
+
* Cardholder address provided in the authorization request and the address on file
|
|
900
|
+
* we verified it against.
|
|
901
|
+
*/
|
|
902
|
+
interface CardholderAddress {
|
|
903
|
+
/**
|
|
904
|
+
* Line 1 of the address on file for the cardholder.
|
|
905
|
+
*/
|
|
906
|
+
actual_line1: string | null;
|
|
907
|
+
/**
|
|
908
|
+
* The postal code of the address on file for the cardholder.
|
|
909
|
+
*/
|
|
910
|
+
actual_postal_code: string | null;
|
|
911
|
+
/**
|
|
912
|
+
* The cardholder address line 1 provided for verification in the authorization
|
|
913
|
+
* request.
|
|
914
|
+
*/
|
|
915
|
+
provided_line1: string | null;
|
|
916
|
+
/**
|
|
917
|
+
* The postal code provided for verification in the authorization request.
|
|
918
|
+
*/
|
|
919
|
+
provided_postal_code: string | null;
|
|
920
|
+
/**
|
|
921
|
+
* The address verification result returned to the card network.
|
|
922
|
+
*
|
|
923
|
+
* - `not_checked` - No address information was provided in the authorization
|
|
924
|
+
* request.
|
|
925
|
+
* - `postal_code_match_address_no_match` - Postal code matches, but the street
|
|
926
|
+
* address does not match or was not provided.
|
|
927
|
+
* - `postal_code_no_match_address_match` - Postal code does not match, but the
|
|
928
|
+
* street address matches or was not provided.
|
|
929
|
+
* - `match` - Postal code and street address match.
|
|
930
|
+
* - `no_match` - Postal code and street address do not match.
|
|
931
|
+
* - `postal_code_match_address_not_checked` - Postal code matches, but the street
|
|
932
|
+
* address was not verified. (deprecated)
|
|
933
|
+
*/
|
|
934
|
+
result: 'not_checked' | 'postal_code_match_address_no_match' | 'postal_code_no_match_address_match' | 'match' | 'no_match' | 'postal_code_match_address_not_checked';
|
|
935
|
+
}
|
|
936
|
+
}
|
|
937
|
+
}
|
|
938
|
+
/**
|
|
939
|
+
* A Card Authorization Expiration object. This field will be present in the JSON
|
|
940
|
+
* response if and only if `category` is equal to `card_authorization_expiration`.
|
|
941
|
+
* Card Authorization Expirations are cancellations of authorizations that were
|
|
942
|
+
* never settled by the acquirer.
|
|
943
|
+
*/
|
|
944
|
+
interface CardAuthorizationExpiration {
|
|
945
|
+
/**
|
|
946
|
+
* The Card Authorization Expiration identifier.
|
|
947
|
+
*/
|
|
948
|
+
id: string;
|
|
949
|
+
/**
|
|
950
|
+
* The identifier for the Card Authorization this reverses.
|
|
951
|
+
*/
|
|
952
|
+
card_authorization_id: string;
|
|
953
|
+
/**
|
|
954
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
|
|
955
|
+
* currency.
|
|
956
|
+
*
|
|
957
|
+
* - `USD` - US Dollar (USD)
|
|
958
|
+
*/
|
|
959
|
+
currency: 'USD';
|
|
960
|
+
/**
|
|
961
|
+
* The amount of this authorization expiration in the minor unit of the
|
|
962
|
+
* transaction's currency. For dollars, for example, this is cents.
|
|
963
|
+
*/
|
|
964
|
+
expired_amount: number;
|
|
965
|
+
/**
|
|
966
|
+
* The card network used to process this card authorization.
|
|
967
|
+
*
|
|
968
|
+
* - `visa` - Visa
|
|
969
|
+
* - `pulse` - Pulse
|
|
970
|
+
*/
|
|
971
|
+
network: 'visa' | 'pulse';
|
|
972
|
+
/**
|
|
973
|
+
* A constant representing the object's type. For this resource it will always be
|
|
974
|
+
* `card_authorization_expiration`.
|
|
975
|
+
*/
|
|
976
|
+
type: 'card_authorization_expiration';
|
|
977
|
+
[k: string]: unknown;
|
|
978
|
+
}
|
|
979
|
+
/**
|
|
980
|
+
* A Card Decline object. This field will be present in the JSON response if and
|
|
981
|
+
* only if `category` is equal to `card_decline`.
|
|
982
|
+
*/
|
|
983
|
+
interface CardDecline {
|
|
984
|
+
/**
|
|
985
|
+
* The Card Decline identifier.
|
|
986
|
+
*/
|
|
987
|
+
id: string;
|
|
988
|
+
/**
|
|
989
|
+
* Whether this authorization was approved by Increase, the card network through
|
|
990
|
+
* stand-in processing, or the user through a real-time decision.
|
|
991
|
+
*
|
|
992
|
+
* - `user` - This object was actioned by the user through a real-time decision.
|
|
993
|
+
* - `increase` - This object was actioned by Increase without user intervention.
|
|
994
|
+
* - `network` - This object was actioned by the network, through stand-in
|
|
995
|
+
* processing.
|
|
996
|
+
*/
|
|
997
|
+
actioner: 'user' | 'increase' | 'network';
|
|
998
|
+
/**
|
|
999
|
+
* Additional amounts associated with the card authorization, such as ATM
|
|
1000
|
+
* surcharges fees. These are usually a subset of the `amount` field and are used
|
|
1001
|
+
* to provide more detailed information about the transaction.
|
|
1002
|
+
*/
|
|
1003
|
+
additional_amounts: CardDecline.AdditionalAmounts;
|
|
1004
|
+
/**
|
|
1005
|
+
* The declined amount in the minor unit of the destination account currency. For
|
|
1006
|
+
* dollars, for example, this is cents.
|
|
1007
|
+
*/
|
|
1008
|
+
amount: number;
|
|
1009
|
+
/**
|
|
1010
|
+
* The ID of the Card Payment this transaction belongs to.
|
|
1011
|
+
*/
|
|
1012
|
+
card_payment_id: string;
|
|
1013
|
+
/**
|
|
1014
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination
|
|
1015
|
+
* account currency.
|
|
1016
|
+
*
|
|
1017
|
+
* - `USD` - US Dollar (USD)
|
|
1018
|
+
*/
|
|
1019
|
+
currency: 'USD';
|
|
1020
|
+
/**
|
|
1021
|
+
* The identifier of the declined transaction created for this Card Decline.
|
|
1022
|
+
*/
|
|
1023
|
+
declined_transaction_id: string;
|
|
1024
|
+
/**
|
|
1025
|
+
* If the authorization was made via a Digital Wallet Token (such as an Apple Pay
|
|
1026
|
+
* purchase), the identifier of the token that was used.
|
|
1027
|
+
*/
|
|
1028
|
+
digital_wallet_token_id: string | null;
|
|
1029
|
+
/**
|
|
1030
|
+
* The direction describes the direction the funds will move, either from the
|
|
1031
|
+
* cardholder to the merchant or from the merchant to the cardholder.
|
|
1032
|
+
*
|
|
1033
|
+
* - `settlement` - A regular card authorization where funds are debited from the
|
|
1034
|
+
* cardholder.
|
|
1035
|
+
* - `refund` - A refund card authorization, sometimes referred to as a credit
|
|
1036
|
+
* voucher authorization, where funds are credited to the cardholder.
|
|
1037
|
+
*/
|
|
1038
|
+
direction: 'settlement' | 'refund';
|
|
1039
|
+
/**
|
|
1040
|
+
* The identifier of the card authorization this request attempted to incrementally
|
|
1041
|
+
* authorize.
|
|
1042
|
+
*/
|
|
1043
|
+
incremented_card_authorization_id: string | null;
|
|
1044
|
+
/**
|
|
1045
|
+
* The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
1046
|
+
* is transacting with.
|
|
1047
|
+
*/
|
|
1048
|
+
merchant_acceptor_id: string;
|
|
1049
|
+
/**
|
|
1050
|
+
* The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
|
1051
|
+
* card is transacting with.
|
|
1052
|
+
*/
|
|
1053
|
+
merchant_category_code: string;
|
|
1054
|
+
/**
|
|
1055
|
+
* The city the merchant resides in.
|
|
1056
|
+
*/
|
|
1057
|
+
merchant_city: string | null;
|
|
1058
|
+
/**
|
|
1059
|
+
* The country the merchant resides in.
|
|
1060
|
+
*/
|
|
1061
|
+
merchant_country: string;
|
|
1062
|
+
/**
|
|
1063
|
+
* The merchant descriptor of the merchant the card is transacting with.
|
|
1064
|
+
*/
|
|
1065
|
+
merchant_descriptor: string;
|
|
1066
|
+
/**
|
|
1067
|
+
* The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
|
|
1068
|
+
* ZIP code, where the first 5 and last 4 are separated by a dash.
|
|
1069
|
+
*/
|
|
1070
|
+
merchant_postal_code: string | null;
|
|
1071
|
+
/**
|
|
1072
|
+
* The state the merchant resides in.
|
|
1073
|
+
*/
|
|
1074
|
+
merchant_state: string | null;
|
|
1075
|
+
/**
|
|
1076
|
+
* Fields specific to the `network`.
|
|
1077
|
+
*/
|
|
1078
|
+
network_details: CardDecline.NetworkDetails;
|
|
1079
|
+
/**
|
|
1080
|
+
* Network-specific identifiers for a specific request or transaction.
|
|
1081
|
+
*/
|
|
1082
|
+
network_identifiers: CardDecline.NetworkIdentifiers;
|
|
1083
|
+
/**
|
|
1084
|
+
* The risk score generated by the card network. For Visa this is the Visa Advanced
|
|
1085
|
+
* Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
|
|
1086
|
+
* score is from 0 to 999, where 999 is the riskiest.
|
|
1087
|
+
*/
|
|
1088
|
+
network_risk_score: number | null;
|
|
1089
|
+
/**
|
|
1090
|
+
* If the authorization was made in-person with a physical card, the Physical Card
|
|
1091
|
+
* that was used.
|
|
1092
|
+
*/
|
|
1093
|
+
physical_card_id: string | null;
|
|
1094
|
+
/**
|
|
1095
|
+
* The declined amount in the minor unit of the transaction's presentment currency.
|
|
1096
|
+
*/
|
|
1097
|
+
presentment_amount: number;
|
|
1098
|
+
/**
|
|
1099
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
1100
|
+
* transaction's presentment currency.
|
|
1101
|
+
*/
|
|
1102
|
+
presentment_currency: string;
|
|
1103
|
+
/**
|
|
1104
|
+
* The processing category describes the intent behind the authorization, such as
|
|
1105
|
+
* whether it was used for bill payments or an automatic fuel dispenser.
|
|
1106
|
+
*
|
|
1107
|
+
* - `account_funding` - Account funding transactions are transactions used to
|
|
1108
|
+
* e.g., fund an account or transfer funds between accounts.
|
|
1109
|
+
* - `automatic_fuel_dispenser` - Automatic fuel dispenser authorizations occur
|
|
1110
|
+
* when a card is used at a gas pump, prior to the actual transaction amount
|
|
1111
|
+
* being known. They are followed by an advice message that updates the amount of
|
|
1112
|
+
* the pending transaction.
|
|
1113
|
+
* - `bill_payment` - A transaction used to pay a bill.
|
|
1114
|
+
* - `original_credit` - Original credit transactions are used to send money to a
|
|
1115
|
+
* cardholder.
|
|
1116
|
+
* - `purchase` - A regular purchase.
|
|
1117
|
+
* - `quasi_cash` - Quasi-cash transactions represent purchases of items which may
|
|
1118
|
+
* be convertible to cash.
|
|
1119
|
+
* - `refund` - A refund card authorization, sometimes referred to as a credit
|
|
1120
|
+
* voucher authorization, where funds are credited to the cardholder.
|
|
1121
|
+
* - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
|
|
1122
|
+
* from an ATM or a point of sale.
|
|
1123
|
+
* - `unknown` - The processing category is unknown.
|
|
1124
|
+
*/
|
|
1125
|
+
processing_category: 'account_funding' | 'automatic_fuel_dispenser' | 'bill_payment' | 'original_credit' | 'purchase' | 'quasi_cash' | 'refund' | 'cash_disbursement' | 'unknown';
|
|
1126
|
+
/**
|
|
1127
|
+
* The identifier of the Real-Time Decision sent to approve or decline this
|
|
1128
|
+
* transaction.
|
|
1129
|
+
*/
|
|
1130
|
+
real_time_decision_id: string | null;
|
|
1131
|
+
/**
|
|
1132
|
+
* This is present if a specific decline reason was given in the real-time
|
|
1133
|
+
* decision.
|
|
1134
|
+
*
|
|
1135
|
+
* - `insufficient_funds` - The cardholder does not have sufficient funds to cover
|
|
1136
|
+
* the transaction. The merchant may attempt to process the transaction again.
|
|
1137
|
+
* - `transaction_never_allowed` - This type of transaction is not allowed for this
|
|
1138
|
+
* card. This transaction should not be retried.
|
|
1139
|
+
* - `exceeds_approval_limit` - The transaction amount exceeds the cardholder's
|
|
1140
|
+
* approval limit. The merchant may attempt to process the transaction again.
|
|
1141
|
+
* - `card_temporarily_disabled` - The card has been temporarily disabled or not
|
|
1142
|
+
* yet activated. The merchant may attempt to process the transaction again.
|
|
1143
|
+
* - `suspected_fraud` - The transaction is suspected to be fraudulent. The
|
|
1144
|
+
* merchant may attempt to process the transaction again.
|
|
1145
|
+
* - `other` - The transaction was declined for another reason. The merchant may
|
|
1146
|
+
* attempt to process the transaction again. This should be used sparingly.
|
|
1147
|
+
*/
|
|
1148
|
+
real_time_decision_reason: 'insufficient_funds' | 'transaction_never_allowed' | 'exceeds_approval_limit' | 'card_temporarily_disabled' | 'suspected_fraud' | 'other' | null;
|
|
1149
|
+
/**
|
|
1150
|
+
* Why the transaction was declined.
|
|
1151
|
+
*
|
|
1152
|
+
* - `account_closed` - The account has been closed.
|
|
1153
|
+
* - `card_not_active` - The Card was not active.
|
|
1154
|
+
* - `card_canceled` - The Card has been canceled.
|
|
1155
|
+
* - `physical_card_not_active` - The Physical Card was not active.
|
|
1156
|
+
* - `entity_not_active` - The account's entity was not active.
|
|
1157
|
+
* - `group_locked` - The account was inactive.
|
|
1158
|
+
* - `insufficient_funds` - The Card's Account did not have a sufficient available
|
|
1159
|
+
* balance.
|
|
1160
|
+
* - `cvv2_mismatch` - The given CVV2 did not match the card's value.
|
|
1161
|
+
* - `pin_mismatch` - The given PIN did not match the card's value.
|
|
1162
|
+
* - `card_expiration_mismatch` - The given expiration date did not match the
|
|
1163
|
+
* card's value. Only applies when a CVV2 is present.
|
|
1164
|
+
* - `transaction_not_allowed` - The attempted card transaction is not allowed per
|
|
1165
|
+
* Increase's terms.
|
|
1166
|
+
* - `breaches_limit` - The transaction was blocked by a Limit.
|
|
1167
|
+
* - `webhook_declined` - Your application declined the transaction via webhook.
|
|
1168
|
+
* - `webhook_timed_out` - Your application webhook did not respond without the
|
|
1169
|
+
* required timeout.
|
|
1170
|
+
* - `declined_by_stand_in_processing` - Declined by stand-in processing.
|
|
1171
|
+
* - `invalid_physical_card` - The card read had an invalid CVV, dCVV, or
|
|
1172
|
+
* authorization request cryptogram.
|
|
1173
|
+
* - `missing_original_authorization` - The original card authorization for this
|
|
1174
|
+
* incremental authorization does not exist.
|
|
1175
|
+
* - `failed_3ds_authentication` - The transaction was declined because the 3DS
|
|
1176
|
+
* authentication failed.
|
|
1177
|
+
* - `suspected_card_testing` - The transaction was suspected to be used by a card
|
|
1178
|
+
* tester to test for valid card numbers.
|
|
1179
|
+
* - `suspected_fraud` - The transaction was suspected to be fraudulent. Please
|
|
1180
|
+
* reach out to support@increase.com for more information.
|
|
1181
|
+
*/
|
|
1182
|
+
reason: 'account_closed' | 'card_not_active' | 'card_canceled' | 'physical_card_not_active' | 'entity_not_active' | 'group_locked' | 'insufficient_funds' | 'cvv2_mismatch' | 'pin_mismatch' | 'card_expiration_mismatch' | 'transaction_not_allowed' | 'breaches_limit' | 'webhook_declined' | 'webhook_timed_out' | 'declined_by_stand_in_processing' | 'invalid_physical_card' | 'missing_original_authorization' | 'failed_3ds_authentication' | 'suspected_card_testing' | 'suspected_fraud';
|
|
1183
|
+
/**
|
|
1184
|
+
* The terminal identifier (commonly abbreviated as TID) of the terminal the card
|
|
1185
|
+
* is transacting with.
|
|
1186
|
+
*/
|
|
1187
|
+
terminal_id: string | null;
|
|
1188
|
+
/**
|
|
1189
|
+
* Fields related to verification of cardholder-provided values.
|
|
1190
|
+
*/
|
|
1191
|
+
verification: CardDecline.Verification;
|
|
1192
|
+
[k: string]: unknown;
|
|
1193
|
+
}
|
|
1194
|
+
namespace CardDecline {
|
|
1195
|
+
/**
|
|
1196
|
+
* Additional amounts associated with the card authorization, such as ATM
|
|
1197
|
+
* surcharges fees. These are usually a subset of the `amount` field and are used
|
|
1198
|
+
* to provide more detailed information about the transaction.
|
|
1199
|
+
*/
|
|
1200
|
+
interface AdditionalAmounts {
|
|
1201
|
+
/**
|
|
1202
|
+
* The part of this transaction amount that was for clinic-related services.
|
|
1203
|
+
*/
|
|
1204
|
+
clinic: AdditionalAmounts.Clinic | null;
|
|
1205
|
+
/**
|
|
1206
|
+
* The part of this transaction amount that was for dental-related services.
|
|
1207
|
+
*/
|
|
1208
|
+
dental: AdditionalAmounts.Dental | null;
|
|
1209
|
+
/**
|
|
1210
|
+
* The original pre-authorized amount.
|
|
1211
|
+
*/
|
|
1212
|
+
original: AdditionalAmounts.Original | null;
|
|
1213
|
+
/**
|
|
1214
|
+
* The part of this transaction amount that was for healthcare prescriptions.
|
|
1215
|
+
*/
|
|
1216
|
+
prescription: AdditionalAmounts.Prescription | null;
|
|
1217
|
+
/**
|
|
1218
|
+
* The surcharge amount charged for this transaction by the merchant.
|
|
1219
|
+
*/
|
|
1220
|
+
surcharge: AdditionalAmounts.Surcharge | null;
|
|
1221
|
+
/**
|
|
1222
|
+
* The total amount of a series of incremental authorizations, optionally provided.
|
|
1223
|
+
*/
|
|
1224
|
+
total_cumulative: AdditionalAmounts.TotalCumulative | null;
|
|
1225
|
+
/**
|
|
1226
|
+
* The total amount of healthcare-related additional amounts.
|
|
1227
|
+
*/
|
|
1228
|
+
total_healthcare: AdditionalAmounts.TotalHealthcare | null;
|
|
1229
|
+
/**
|
|
1230
|
+
* The part of this transaction amount that was for transit-related services.
|
|
1231
|
+
*/
|
|
1232
|
+
transit: AdditionalAmounts.Transit | null;
|
|
1233
|
+
/**
|
|
1234
|
+
* An unknown additional amount.
|
|
1235
|
+
*/
|
|
1236
|
+
unknown: AdditionalAmounts.Unknown | null;
|
|
1237
|
+
/**
|
|
1238
|
+
* The part of this transaction amount that was for vision-related services.
|
|
1239
|
+
*/
|
|
1240
|
+
vision: AdditionalAmounts.Vision | null;
|
|
1241
|
+
}
|
|
1242
|
+
namespace AdditionalAmounts {
|
|
1243
|
+
/**
|
|
1244
|
+
* The part of this transaction amount that was for clinic-related services.
|
|
1245
|
+
*/
|
|
1246
|
+
interface Clinic {
|
|
1247
|
+
/**
|
|
1248
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1249
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1250
|
+
* subtracted from the amount (such as a discount).
|
|
1251
|
+
*/
|
|
1252
|
+
amount: number;
|
|
1253
|
+
/**
|
|
1254
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1255
|
+
* amount's currency.
|
|
1256
|
+
*/
|
|
1257
|
+
currency: string;
|
|
1258
|
+
}
|
|
1259
|
+
/**
|
|
1260
|
+
* The part of this transaction amount that was for dental-related services.
|
|
1261
|
+
*/
|
|
1262
|
+
interface Dental {
|
|
1263
|
+
/**
|
|
1264
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1265
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1266
|
+
* subtracted from the amount (such as a discount).
|
|
1267
|
+
*/
|
|
1268
|
+
amount: number;
|
|
1269
|
+
/**
|
|
1270
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1271
|
+
* amount's currency.
|
|
1272
|
+
*/
|
|
1273
|
+
currency: string;
|
|
1274
|
+
}
|
|
1275
|
+
/**
|
|
1276
|
+
* The original pre-authorized amount.
|
|
1277
|
+
*/
|
|
1278
|
+
interface Original {
|
|
1279
|
+
/**
|
|
1280
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1281
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1282
|
+
* subtracted from the amount (such as a discount).
|
|
1283
|
+
*/
|
|
1284
|
+
amount: number;
|
|
1285
|
+
/**
|
|
1286
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1287
|
+
* amount's currency.
|
|
1288
|
+
*/
|
|
1289
|
+
currency: string;
|
|
1290
|
+
}
|
|
1291
|
+
/**
|
|
1292
|
+
* The part of this transaction amount that was for healthcare prescriptions.
|
|
1293
|
+
*/
|
|
1294
|
+
interface Prescription {
|
|
1295
|
+
/**
|
|
1296
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1297
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1298
|
+
* subtracted from the amount (such as a discount).
|
|
1299
|
+
*/
|
|
1300
|
+
amount: number;
|
|
1301
|
+
/**
|
|
1302
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1303
|
+
* amount's currency.
|
|
1304
|
+
*/
|
|
1305
|
+
currency: string;
|
|
1306
|
+
}
|
|
1307
|
+
/**
|
|
1308
|
+
* The surcharge amount charged for this transaction by the merchant.
|
|
1309
|
+
*/
|
|
1310
|
+
interface Surcharge {
|
|
1311
|
+
/**
|
|
1312
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1313
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1314
|
+
* subtracted from the amount (such as a discount).
|
|
1315
|
+
*/
|
|
1316
|
+
amount: number;
|
|
1317
|
+
/**
|
|
1318
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1319
|
+
* amount's currency.
|
|
1320
|
+
*/
|
|
1321
|
+
currency: string;
|
|
1322
|
+
}
|
|
1323
|
+
/**
|
|
1324
|
+
* The total amount of a series of incremental authorizations, optionally provided.
|
|
1325
|
+
*/
|
|
1326
|
+
interface TotalCumulative {
|
|
1327
|
+
/**
|
|
1328
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1329
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1330
|
+
* subtracted from the amount (such as a discount).
|
|
1331
|
+
*/
|
|
1332
|
+
amount: number;
|
|
1333
|
+
/**
|
|
1334
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1335
|
+
* amount's currency.
|
|
1336
|
+
*/
|
|
1337
|
+
currency: string;
|
|
1338
|
+
}
|
|
1339
|
+
/**
|
|
1340
|
+
* The total amount of healthcare-related additional amounts.
|
|
1341
|
+
*/
|
|
1342
|
+
interface TotalHealthcare {
|
|
1343
|
+
/**
|
|
1344
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1345
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1346
|
+
* subtracted from the amount (such as a discount).
|
|
1347
|
+
*/
|
|
1348
|
+
amount: number;
|
|
1349
|
+
/**
|
|
1350
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1351
|
+
* amount's currency.
|
|
1352
|
+
*/
|
|
1353
|
+
currency: string;
|
|
1354
|
+
}
|
|
1355
|
+
/**
|
|
1356
|
+
* The part of this transaction amount that was for transit-related services.
|
|
1357
|
+
*/
|
|
1358
|
+
interface Transit {
|
|
1359
|
+
/**
|
|
1360
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1361
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1362
|
+
* subtracted from the amount (such as a discount).
|
|
1363
|
+
*/
|
|
1364
|
+
amount: number;
|
|
1365
|
+
/**
|
|
1366
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1367
|
+
* amount's currency.
|
|
1368
|
+
*/
|
|
1369
|
+
currency: string;
|
|
1370
|
+
}
|
|
1371
|
+
/**
|
|
1372
|
+
* An unknown additional amount.
|
|
1373
|
+
*/
|
|
1374
|
+
interface Unknown {
|
|
1375
|
+
/**
|
|
1376
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1377
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1378
|
+
* subtracted from the amount (such as a discount).
|
|
1379
|
+
*/
|
|
1380
|
+
amount: number;
|
|
1381
|
+
/**
|
|
1382
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1383
|
+
* amount's currency.
|
|
1384
|
+
*/
|
|
1385
|
+
currency: string;
|
|
1386
|
+
}
|
|
1387
|
+
/**
|
|
1388
|
+
* The part of this transaction amount that was for vision-related services.
|
|
1389
|
+
*/
|
|
1390
|
+
interface Vision {
|
|
1391
|
+
/**
|
|
1392
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1393
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1394
|
+
* subtracted from the amount (such as a discount).
|
|
1395
|
+
*/
|
|
1396
|
+
amount: number;
|
|
1397
|
+
/**
|
|
1398
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1399
|
+
* amount's currency.
|
|
1400
|
+
*/
|
|
1401
|
+
currency: string;
|
|
1402
|
+
}
|
|
1403
|
+
}
|
|
1404
|
+
/**
|
|
1405
|
+
* Fields specific to the `network`.
|
|
1406
|
+
*/
|
|
1407
|
+
interface NetworkDetails {
|
|
1408
|
+
/**
|
|
1409
|
+
* The payment network used to process this card authorization.
|
|
1410
|
+
*
|
|
1411
|
+
* - `visa` - Visa
|
|
1412
|
+
* - `pulse` - Pulse
|
|
1413
|
+
*/
|
|
1414
|
+
category: 'visa' | 'pulse';
|
|
1415
|
+
/**
|
|
1416
|
+
* Fields specific to the `pulse` network.
|
|
1417
|
+
*/
|
|
1418
|
+
pulse: NetworkDetails.Pulse | null;
|
|
1419
|
+
/**
|
|
1420
|
+
* Fields specific to the `visa` network.
|
|
1421
|
+
*/
|
|
1422
|
+
visa: NetworkDetails.Visa | null;
|
|
1423
|
+
}
|
|
1424
|
+
namespace NetworkDetails {
|
|
1425
|
+
/**
|
|
1426
|
+
* Fields specific to the `pulse` network.
|
|
1427
|
+
*/
|
|
1428
|
+
interface Pulse {
|
|
1429
|
+
}
|
|
1430
|
+
/**
|
|
1431
|
+
* Fields specific to the `visa` network.
|
|
1432
|
+
*/
|
|
1433
|
+
interface Visa {
|
|
1434
|
+
/**
|
|
1435
|
+
* For electronic commerce transactions, this identifies the level of security used
|
|
1436
|
+
* in obtaining the customer's payment credential. For mail or telephone order
|
|
1437
|
+
* transactions, identifies the type of mail or telephone order.
|
|
1438
|
+
*
|
|
1439
|
+
* - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
|
|
1440
|
+
* that the transaction is a mail/phone order purchase, not a recurring
|
|
1441
|
+
* transaction or installment payment. For domestic transactions in the US
|
|
1442
|
+
* region, this value may also indicate one bill payment transaction in the
|
|
1443
|
+
* card-present or card-absent environments.
|
|
1444
|
+
* - `recurring` - Recurring transaction: Payment indicator used to indicate a
|
|
1445
|
+
* recurring transaction that originates from an acquirer in the US region.
|
|
1446
|
+
* - `installment` - Installment payment: Payment indicator used to indicate one
|
|
1447
|
+
* purchase of goods or services that is billed to the account in multiple
|
|
1448
|
+
* charges over a period of time agreed upon by the cardholder and merchant from
|
|
1449
|
+
* transactions that originate from an acquirer in the US region.
|
|
1450
|
+
* - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
|
|
1451
|
+
* indicate that the type of mail/telephone order is unknown.
|
|
1452
|
+
* - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
|
|
1453
|
+
* indicate that the electronic commerce transaction has been authenticated using
|
|
1454
|
+
* e.g., 3-D Secure
|
|
1455
|
+
* - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
|
|
1456
|
+
* Non-authenticated security transaction at a 3-D Secure-capable merchant, and
|
|
1457
|
+
* merchant attempted to authenticate the cardholder using 3-D Secure: Use to
|
|
1458
|
+
* identify an electronic commerce transaction where the merchant attempted to
|
|
1459
|
+
* authenticate the cardholder using 3-D Secure, but was unable to complete the
|
|
1460
|
+
* authentication because the issuer or cardholder does not participate in the
|
|
1461
|
+
* 3-D Secure program.
|
|
1462
|
+
* - `non_authenticated_security_transaction` - Non-authenticated security
|
|
1463
|
+
* transaction: Use to identify an electronic commerce transaction that uses data
|
|
1464
|
+
* encryption for security however, cardholder authentication is not performed
|
|
1465
|
+
* using 3-D Secure.
|
|
1466
|
+
* - `non_secure_transaction` - Non-secure transaction: Use to identify an
|
|
1467
|
+
* electronic commerce transaction that has no data protection.
|
|
1468
|
+
*/
|
|
1469
|
+
electronic_commerce_indicator: 'mail_phone_order' | 'recurring' | 'installment' | 'unknown_mail_phone_order' | 'secure_electronic_commerce' | 'non_authenticated_security_transaction_at_3ds_capable_merchant' | 'non_authenticated_security_transaction' | 'non_secure_transaction' | null;
|
|
1470
|
+
/**
|
|
1471
|
+
* The method used to enter the cardholder's primary account number and card
|
|
1472
|
+
* expiration date.
|
|
1473
|
+
*
|
|
1474
|
+
* - `unknown` - Unknown
|
|
1475
|
+
* - `manual` - Manual key entry
|
|
1476
|
+
* - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
|
|
1477
|
+
* value
|
|
1478
|
+
* - `optical_code` - Optical code
|
|
1479
|
+
* - `integrated_circuit_card` - Contact chip card
|
|
1480
|
+
* - `contactless` - Contactless read of chip card
|
|
1481
|
+
* - `credential_on_file` - Transaction initiated using a credential that has
|
|
1482
|
+
* previously been stored on file
|
|
1483
|
+
* - `magnetic_stripe` - Magnetic stripe read
|
|
1484
|
+
* - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
|
|
1485
|
+
* - `integrated_circuit_card_no_cvv` - Contact chip card, without card
|
|
1486
|
+
* verification value
|
|
1487
|
+
*/
|
|
1488
|
+
point_of_service_entry_mode: 'unknown' | 'manual' | 'magnetic_stripe_no_cvv' | 'optical_code' | 'integrated_circuit_card' | 'contactless' | 'credential_on_file' | 'magnetic_stripe' | 'contactless_magnetic_stripe' | 'integrated_circuit_card_no_cvv' | null;
|
|
1489
|
+
/**
|
|
1490
|
+
* Only present when `actioner: network`. Describes why a card authorization was
|
|
1491
|
+
* approved or declined by Visa through stand-in processing.
|
|
1492
|
+
*
|
|
1493
|
+
* - `issuer_error` - Increase failed to process the authorization in a timely
|
|
1494
|
+
* manner.
|
|
1495
|
+
* - `invalid_physical_card` - The physical card read had an invalid CVV, dCVV, or
|
|
1496
|
+
* authorization request cryptogram.
|
|
1497
|
+
* - `invalid_cardholder_authentication_verification_value` - The 3DS cardholder
|
|
1498
|
+
* authentication verification value was invalid.
|
|
1499
|
+
* - `internal_visa_error` - An internal Visa error occurred. Visa uses this reason
|
|
1500
|
+
* code for certain expected occurrences as well, such as Application Transaction
|
|
1501
|
+
* Counter (ATC) replays.
|
|
1502
|
+
* - `merchant_transaction_advisory_service_authentication_required` - The merchant
|
|
1503
|
+
* has enabled Visa's Transaction Advisory Service and requires further
|
|
1504
|
+
* authentication to perform the transaction. In practice this is often utilized
|
|
1505
|
+
* at fuel pumps to tell the cardholder to see the cashier.
|
|
1506
|
+
* - `payment_fraud_disruption_acquirer_block` - The transaction was blocked by
|
|
1507
|
+
* Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior,
|
|
1508
|
+
* such as card testing.
|
|
1509
|
+
* - `other` - An unspecific reason for stand-in processing.
|
|
1510
|
+
*/
|
|
1511
|
+
stand_in_processing_reason: 'issuer_error' | 'invalid_physical_card' | 'invalid_cardholder_authentication_verification_value' | 'internal_visa_error' | 'merchant_transaction_advisory_service_authentication_required' | 'payment_fraud_disruption_acquirer_block' | 'other' | null;
|
|
1512
|
+
}
|
|
1513
|
+
}
|
|
1514
|
+
/**
|
|
1515
|
+
* Network-specific identifiers for a specific request or transaction.
|
|
1516
|
+
*/
|
|
1517
|
+
interface NetworkIdentifiers {
|
|
1518
|
+
/**
|
|
1519
|
+
* The randomly generated 6-character Authorization Identification Response code
|
|
1520
|
+
* sent back to the acquirer in an approved response.
|
|
1521
|
+
*/
|
|
1522
|
+
authorization_identification_response: string | null;
|
|
1523
|
+
/**
|
|
1524
|
+
* A life-cycle identifier used across e.g., an authorization and a reversal.
|
|
1525
|
+
* Expected to be unique per acquirer within a window of time. For some card
|
|
1526
|
+
* networks the retrieval reference number includes the trace counter.
|
|
1527
|
+
*/
|
|
1528
|
+
retrieval_reference_number: string | null;
|
|
1529
|
+
/**
|
|
1530
|
+
* A counter used to verify an individual authorization. Expected to be unique per
|
|
1531
|
+
* acquirer within a window of time.
|
|
1532
|
+
*/
|
|
1533
|
+
trace_number: string | null;
|
|
1534
|
+
/**
|
|
1535
|
+
* A globally unique transaction identifier provided by the card network, used
|
|
1536
|
+
* across multiple life-cycle requests.
|
|
1537
|
+
*/
|
|
1538
|
+
transaction_id: string | null;
|
|
1539
|
+
}
|
|
1540
|
+
/**
|
|
1541
|
+
* Fields related to verification of cardholder-provided values.
|
|
1542
|
+
*/
|
|
1543
|
+
interface Verification {
|
|
1544
|
+
/**
|
|
1545
|
+
* Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
1546
|
+
* the back of the card.
|
|
1547
|
+
*/
|
|
1548
|
+
card_verification_code: Verification.CardVerificationCode;
|
|
1549
|
+
/**
|
|
1550
|
+
* Cardholder address provided in the authorization request and the address on file
|
|
1551
|
+
* we verified it against.
|
|
1552
|
+
*/
|
|
1553
|
+
cardholder_address: Verification.CardholderAddress;
|
|
1554
|
+
}
|
|
1555
|
+
namespace Verification {
|
|
1556
|
+
/**
|
|
1557
|
+
* Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
1558
|
+
* the back of the card.
|
|
1559
|
+
*/
|
|
1560
|
+
interface CardVerificationCode {
|
|
1561
|
+
/**
|
|
1562
|
+
* The result of verifying the Card Verification Code.
|
|
1563
|
+
*
|
|
1564
|
+
* - `not_checked` - No card verification code was provided in the authorization
|
|
1565
|
+
* request.
|
|
1566
|
+
* - `match` - The card verification code matched the one on file.
|
|
1567
|
+
* - `no_match` - The card verification code did not match the one on file.
|
|
1568
|
+
*/
|
|
1569
|
+
result: 'not_checked' | 'match' | 'no_match';
|
|
1570
|
+
}
|
|
1571
|
+
/**
|
|
1572
|
+
* Cardholder address provided in the authorization request and the address on file
|
|
1573
|
+
* we verified it against.
|
|
1574
|
+
*/
|
|
1575
|
+
interface CardholderAddress {
|
|
1576
|
+
/**
|
|
1577
|
+
* Line 1 of the address on file for the cardholder.
|
|
1578
|
+
*/
|
|
1579
|
+
actual_line1: string | null;
|
|
1580
|
+
/**
|
|
1581
|
+
* The postal code of the address on file for the cardholder.
|
|
1582
|
+
*/
|
|
1583
|
+
actual_postal_code: string | null;
|
|
1584
|
+
/**
|
|
1585
|
+
* The cardholder address line 1 provided for verification in the authorization
|
|
1586
|
+
* request.
|
|
1587
|
+
*/
|
|
1588
|
+
provided_line1: string | null;
|
|
1589
|
+
/**
|
|
1590
|
+
* The postal code provided for verification in the authorization request.
|
|
1591
|
+
*/
|
|
1592
|
+
provided_postal_code: string | null;
|
|
1593
|
+
/**
|
|
1594
|
+
* The address verification result returned to the card network.
|
|
1595
|
+
*
|
|
1596
|
+
* - `not_checked` - No address information was provided in the authorization
|
|
1597
|
+
* request.
|
|
1598
|
+
* - `postal_code_match_address_no_match` - Postal code matches, but the street
|
|
1599
|
+
* address does not match or was not provided.
|
|
1600
|
+
* - `postal_code_no_match_address_match` - Postal code does not match, but the
|
|
1601
|
+
* street address matches or was not provided.
|
|
1602
|
+
* - `match` - Postal code and street address match.
|
|
1603
|
+
* - `no_match` - Postal code and street address do not match.
|
|
1604
|
+
* - `postal_code_match_address_not_checked` - Postal code matches, but the street
|
|
1605
|
+
* address was not verified. (deprecated)
|
|
1606
|
+
*/
|
|
1607
|
+
result: 'not_checked' | 'postal_code_match_address_no_match' | 'postal_code_no_match_address_match' | 'match' | 'no_match' | 'postal_code_match_address_not_checked';
|
|
1608
|
+
}
|
|
1609
|
+
}
|
|
1610
|
+
}
|
|
1611
|
+
/**
|
|
1612
|
+
* A Card Financial object. This field will be present in the JSON response if and
|
|
1613
|
+
* only if `category` is equal to `card_financial`. Card Financials are temporary
|
|
1614
|
+
* holds placed on a customers funds with the intent to later clear a transaction.
|
|
1615
|
+
*/
|
|
1616
|
+
interface CardFinancial {
|
|
1617
|
+
/**
|
|
1618
|
+
* The Card Financial identifier.
|
|
1619
|
+
*/
|
|
1620
|
+
id: string;
|
|
1621
|
+
/**
|
|
1622
|
+
* Whether this financial was approved by Increase, the card network through
|
|
1623
|
+
* stand-in processing, or the user through a real-time decision.
|
|
1624
|
+
*
|
|
1625
|
+
* - `user` - This object was actioned by the user through a real-time decision.
|
|
1626
|
+
* - `increase` - This object was actioned by Increase without user intervention.
|
|
1627
|
+
* - `network` - This object was actioned by the network, through stand-in
|
|
1628
|
+
* processing.
|
|
1629
|
+
*/
|
|
1630
|
+
actioner: 'user' | 'increase' | 'network';
|
|
1631
|
+
/**
|
|
1632
|
+
* Additional amounts associated with the card authorization, such as ATM
|
|
1633
|
+
* surcharges fees. These are usually a subset of the `amount` field and are used
|
|
1634
|
+
* to provide more detailed information about the transaction.
|
|
1635
|
+
*/
|
|
1636
|
+
additional_amounts: CardFinancial.AdditionalAmounts;
|
|
1637
|
+
/**
|
|
1638
|
+
* The pending amount in the minor unit of the transaction's currency. For dollars,
|
|
1639
|
+
* for example, this is cents.
|
|
1640
|
+
*/
|
|
1641
|
+
amount: number;
|
|
1642
|
+
/**
|
|
1643
|
+
* The ID of the Card Payment this transaction belongs to.
|
|
1644
|
+
*/
|
|
1645
|
+
card_payment_id: string;
|
|
1646
|
+
/**
|
|
1647
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
1648
|
+
* transaction's currency.
|
|
1649
|
+
*
|
|
1650
|
+
* - `USD` - US Dollar (USD)
|
|
1651
|
+
*/
|
|
1652
|
+
currency: 'USD';
|
|
1653
|
+
/**
|
|
1654
|
+
* If the authorization was made via a Digital Wallet Token (such as an Apple Pay
|
|
1655
|
+
* purchase), the identifier of the token that was used.
|
|
1656
|
+
*/
|
|
1657
|
+
digital_wallet_token_id: string | null;
|
|
1658
|
+
/**
|
|
1659
|
+
* The direction describes the direction the funds will move, either from the
|
|
1660
|
+
* cardholder to the merchant or from the merchant to the cardholder.
|
|
1661
|
+
*
|
|
1662
|
+
* - `settlement` - A regular card authorization where funds are debited from the
|
|
1663
|
+
* cardholder.
|
|
1664
|
+
* - `refund` - A refund card authorization, sometimes referred to as a credit
|
|
1665
|
+
* voucher authorization, where funds are credited to the cardholder.
|
|
1666
|
+
*/
|
|
1667
|
+
direction: 'settlement' | 'refund';
|
|
1668
|
+
/**
|
|
1669
|
+
* The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
1670
|
+
* is transacting with.
|
|
1671
|
+
*/
|
|
1672
|
+
merchant_acceptor_id: string;
|
|
1673
|
+
/**
|
|
1674
|
+
* The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
|
1675
|
+
* card is transacting with.
|
|
1676
|
+
*/
|
|
1677
|
+
merchant_category_code: string;
|
|
1678
|
+
/**
|
|
1679
|
+
* The city the merchant resides in.
|
|
1680
|
+
*/
|
|
1681
|
+
merchant_city: string | null;
|
|
1682
|
+
/**
|
|
1683
|
+
* The country the merchant resides in.
|
|
1684
|
+
*/
|
|
1685
|
+
merchant_country: string;
|
|
1686
|
+
/**
|
|
1687
|
+
* The merchant descriptor of the merchant the card is transacting with.
|
|
1688
|
+
*/
|
|
1689
|
+
merchant_descriptor: string;
|
|
1690
|
+
/**
|
|
1691
|
+
* The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
|
|
1692
|
+
* ZIP code, where the first 5 and last 4 are separated by a dash.
|
|
1693
|
+
*/
|
|
1694
|
+
merchant_postal_code: string | null;
|
|
1695
|
+
/**
|
|
1696
|
+
* The state the merchant resides in.
|
|
1697
|
+
*/
|
|
1698
|
+
merchant_state: string | null;
|
|
1699
|
+
/**
|
|
1700
|
+
* Fields specific to the `network`.
|
|
1701
|
+
*/
|
|
1702
|
+
network_details: CardFinancial.NetworkDetails;
|
|
1703
|
+
/**
|
|
1704
|
+
* Network-specific identifiers for a specific request or transaction.
|
|
1705
|
+
*/
|
|
1706
|
+
network_identifiers: CardFinancial.NetworkIdentifiers;
|
|
1707
|
+
/**
|
|
1708
|
+
* The risk score generated by the card network. For Visa this is the Visa Advanced
|
|
1709
|
+
* Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
|
|
1710
|
+
* score is from 0 to 999, where 999 is the riskiest.
|
|
1711
|
+
*/
|
|
1712
|
+
network_risk_score: number | null;
|
|
1713
|
+
/**
|
|
1714
|
+
* If the authorization was made in-person with a physical card, the Physical Card
|
|
1715
|
+
* that was used.
|
|
1716
|
+
*/
|
|
1717
|
+
physical_card_id: string | null;
|
|
1718
|
+
/**
|
|
1719
|
+
* The pending amount in the minor unit of the transaction's presentment currency.
|
|
1720
|
+
*/
|
|
1721
|
+
presentment_amount: number;
|
|
1722
|
+
/**
|
|
1723
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
1724
|
+
* transaction's presentment currency.
|
|
1725
|
+
*/
|
|
1726
|
+
presentment_currency: string;
|
|
1727
|
+
/**
|
|
1728
|
+
* The processing category describes the intent behind the financial, such as
|
|
1729
|
+
* whether it was used for bill payments or an automatic fuel dispenser.
|
|
1730
|
+
*
|
|
1731
|
+
* - `account_funding` - Account funding transactions are transactions used to
|
|
1732
|
+
* e.g., fund an account or transfer funds between accounts.
|
|
1733
|
+
* - `automatic_fuel_dispenser` - Automatic fuel dispenser authorizations occur
|
|
1734
|
+
* when a card is used at a gas pump, prior to the actual transaction amount
|
|
1735
|
+
* being known. They are followed by an advice message that updates the amount of
|
|
1736
|
+
* the pending transaction.
|
|
1737
|
+
* - `bill_payment` - A transaction used to pay a bill.
|
|
1738
|
+
* - `original_credit` - Original credit transactions are used to send money to a
|
|
1739
|
+
* cardholder.
|
|
1740
|
+
* - `purchase` - A regular purchase.
|
|
1741
|
+
* - `quasi_cash` - Quasi-cash transactions represent purchases of items which may
|
|
1742
|
+
* be convertible to cash.
|
|
1743
|
+
* - `refund` - A refund card authorization, sometimes referred to as a credit
|
|
1744
|
+
* voucher authorization, where funds are credited to the cardholder.
|
|
1745
|
+
* - `cash_disbursement` - Cash disbursement transactions are used to withdraw cash
|
|
1746
|
+
* from an ATM or a point of sale.
|
|
1747
|
+
* - `unknown` - The processing category is unknown.
|
|
1748
|
+
*/
|
|
1749
|
+
processing_category: 'account_funding' | 'automatic_fuel_dispenser' | 'bill_payment' | 'original_credit' | 'purchase' | 'quasi_cash' | 'refund' | 'cash_disbursement' | 'unknown';
|
|
1750
|
+
/**
|
|
1751
|
+
* The identifier of the Real-Time Decision sent to approve or decline this
|
|
1752
|
+
* transaction.
|
|
1753
|
+
*/
|
|
1754
|
+
real_time_decision_id: string | null;
|
|
1755
|
+
/**
|
|
1756
|
+
* The terminal identifier (commonly abbreviated as TID) of the terminal the card
|
|
1757
|
+
* is transacting with.
|
|
1758
|
+
*/
|
|
1759
|
+
terminal_id: string | null;
|
|
1760
|
+
/**
|
|
1761
|
+
* The identifier of the Transaction associated with this Transaction.
|
|
1762
|
+
*/
|
|
1763
|
+
transaction_id: string;
|
|
1764
|
+
/**
|
|
1765
|
+
* A constant representing the object's type. For this resource it will always be
|
|
1766
|
+
* `card_financial`.
|
|
1767
|
+
*/
|
|
1768
|
+
type: 'card_financial';
|
|
1769
|
+
/**
|
|
1770
|
+
* Fields related to verification of cardholder-provided values.
|
|
1771
|
+
*/
|
|
1772
|
+
verification: CardFinancial.Verification;
|
|
1773
|
+
[k: string]: unknown;
|
|
1774
|
+
}
|
|
1775
|
+
namespace CardFinancial {
|
|
1776
|
+
/**
|
|
1777
|
+
* Additional amounts associated with the card authorization, such as ATM
|
|
1778
|
+
* surcharges fees. These are usually a subset of the `amount` field and are used
|
|
1779
|
+
* to provide more detailed information about the transaction.
|
|
1780
|
+
*/
|
|
1781
|
+
interface AdditionalAmounts {
|
|
1782
|
+
/**
|
|
1783
|
+
* The part of this transaction amount that was for clinic-related services.
|
|
1784
|
+
*/
|
|
1785
|
+
clinic: AdditionalAmounts.Clinic | null;
|
|
1786
|
+
/**
|
|
1787
|
+
* The part of this transaction amount that was for dental-related services.
|
|
1788
|
+
*/
|
|
1789
|
+
dental: AdditionalAmounts.Dental | null;
|
|
1790
|
+
/**
|
|
1791
|
+
* The original pre-authorized amount.
|
|
1792
|
+
*/
|
|
1793
|
+
original: AdditionalAmounts.Original | null;
|
|
1794
|
+
/**
|
|
1795
|
+
* The part of this transaction amount that was for healthcare prescriptions.
|
|
1796
|
+
*/
|
|
1797
|
+
prescription: AdditionalAmounts.Prescription | null;
|
|
1798
|
+
/**
|
|
1799
|
+
* The surcharge amount charged for this transaction by the merchant.
|
|
1800
|
+
*/
|
|
1801
|
+
surcharge: AdditionalAmounts.Surcharge | null;
|
|
1802
|
+
/**
|
|
1803
|
+
* The total amount of a series of incremental authorizations, optionally provided.
|
|
1804
|
+
*/
|
|
1805
|
+
total_cumulative: AdditionalAmounts.TotalCumulative | null;
|
|
1806
|
+
/**
|
|
1807
|
+
* The total amount of healthcare-related additional amounts.
|
|
1808
|
+
*/
|
|
1809
|
+
total_healthcare: AdditionalAmounts.TotalHealthcare | null;
|
|
1810
|
+
/**
|
|
1811
|
+
* The part of this transaction amount that was for transit-related services.
|
|
1812
|
+
*/
|
|
1813
|
+
transit: AdditionalAmounts.Transit | null;
|
|
1814
|
+
/**
|
|
1815
|
+
* An unknown additional amount.
|
|
1816
|
+
*/
|
|
1817
|
+
unknown: AdditionalAmounts.Unknown | null;
|
|
1818
|
+
/**
|
|
1819
|
+
* The part of this transaction amount that was for vision-related services.
|
|
1820
|
+
*/
|
|
1821
|
+
vision: AdditionalAmounts.Vision | null;
|
|
1822
|
+
}
|
|
1823
|
+
namespace AdditionalAmounts {
|
|
1824
|
+
/**
|
|
1825
|
+
* The part of this transaction amount that was for clinic-related services.
|
|
1826
|
+
*/
|
|
1827
|
+
interface Clinic {
|
|
1828
|
+
/**
|
|
1829
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1830
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1831
|
+
* subtracted from the amount (such as a discount).
|
|
1832
|
+
*/
|
|
1833
|
+
amount: number;
|
|
1834
|
+
/**
|
|
1835
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1836
|
+
* amount's currency.
|
|
1837
|
+
*/
|
|
1838
|
+
currency: string;
|
|
1839
|
+
}
|
|
1840
|
+
/**
|
|
1841
|
+
* The part of this transaction amount that was for dental-related services.
|
|
1842
|
+
*/
|
|
1843
|
+
interface Dental {
|
|
1844
|
+
/**
|
|
1845
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1846
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1847
|
+
* subtracted from the amount (such as a discount).
|
|
1848
|
+
*/
|
|
1849
|
+
amount: number;
|
|
1850
|
+
/**
|
|
1851
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1852
|
+
* amount's currency.
|
|
1853
|
+
*/
|
|
1854
|
+
currency: string;
|
|
1855
|
+
}
|
|
1856
|
+
/**
|
|
1857
|
+
* The original pre-authorized amount.
|
|
1858
|
+
*/
|
|
1859
|
+
interface Original {
|
|
1860
|
+
/**
|
|
1861
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1862
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1863
|
+
* subtracted from the amount (such as a discount).
|
|
1864
|
+
*/
|
|
1865
|
+
amount: number;
|
|
1866
|
+
/**
|
|
1867
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1868
|
+
* amount's currency.
|
|
1869
|
+
*/
|
|
1870
|
+
currency: string;
|
|
1871
|
+
}
|
|
1872
|
+
/**
|
|
1873
|
+
* The part of this transaction amount that was for healthcare prescriptions.
|
|
1874
|
+
*/
|
|
1875
|
+
interface Prescription {
|
|
1876
|
+
/**
|
|
1877
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1878
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1879
|
+
* subtracted from the amount (such as a discount).
|
|
1880
|
+
*/
|
|
1881
|
+
amount: number;
|
|
1882
|
+
/**
|
|
1883
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1884
|
+
* amount's currency.
|
|
1885
|
+
*/
|
|
1886
|
+
currency: string;
|
|
1887
|
+
}
|
|
1888
|
+
/**
|
|
1889
|
+
* The surcharge amount charged for this transaction by the merchant.
|
|
1890
|
+
*/
|
|
1891
|
+
interface Surcharge {
|
|
1892
|
+
/**
|
|
1893
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1894
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1895
|
+
* subtracted from the amount (such as a discount).
|
|
1896
|
+
*/
|
|
1897
|
+
amount: number;
|
|
1898
|
+
/**
|
|
1899
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1900
|
+
* amount's currency.
|
|
1901
|
+
*/
|
|
1902
|
+
currency: string;
|
|
1903
|
+
}
|
|
1904
|
+
/**
|
|
1905
|
+
* The total amount of a series of incremental authorizations, optionally provided.
|
|
1906
|
+
*/
|
|
1907
|
+
interface TotalCumulative {
|
|
1908
|
+
/**
|
|
1909
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1910
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1911
|
+
* subtracted from the amount (such as a discount).
|
|
1912
|
+
*/
|
|
1913
|
+
amount: number;
|
|
1914
|
+
/**
|
|
1915
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1916
|
+
* amount's currency.
|
|
1917
|
+
*/
|
|
1918
|
+
currency: string;
|
|
1919
|
+
}
|
|
1920
|
+
/**
|
|
1921
|
+
* The total amount of healthcare-related additional amounts.
|
|
1922
|
+
*/
|
|
1923
|
+
interface TotalHealthcare {
|
|
1924
|
+
/**
|
|
1925
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1926
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1927
|
+
* subtracted from the amount (such as a discount).
|
|
1928
|
+
*/
|
|
1929
|
+
amount: number;
|
|
1930
|
+
/**
|
|
1931
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1932
|
+
* amount's currency.
|
|
1933
|
+
*/
|
|
1934
|
+
currency: string;
|
|
1935
|
+
}
|
|
1936
|
+
/**
|
|
1937
|
+
* The part of this transaction amount that was for transit-related services.
|
|
1938
|
+
*/
|
|
1939
|
+
interface Transit {
|
|
1940
|
+
/**
|
|
1941
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1942
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1943
|
+
* subtracted from the amount (such as a discount).
|
|
1944
|
+
*/
|
|
1945
|
+
amount: number;
|
|
1946
|
+
/**
|
|
1947
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1948
|
+
* amount's currency.
|
|
1949
|
+
*/
|
|
1950
|
+
currency: string;
|
|
1951
|
+
}
|
|
1952
|
+
/**
|
|
1953
|
+
* An unknown additional amount.
|
|
1954
|
+
*/
|
|
1955
|
+
interface Unknown {
|
|
1956
|
+
/**
|
|
1957
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1958
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1959
|
+
* subtracted from the amount (such as a discount).
|
|
1960
|
+
*/
|
|
1961
|
+
amount: number;
|
|
1962
|
+
/**
|
|
1963
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1964
|
+
* amount's currency.
|
|
1965
|
+
*/
|
|
1966
|
+
currency: string;
|
|
1967
|
+
}
|
|
1968
|
+
/**
|
|
1969
|
+
* The part of this transaction amount that was for vision-related services.
|
|
1970
|
+
*/
|
|
1971
|
+
interface Vision {
|
|
1972
|
+
/**
|
|
1973
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
1974
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
1975
|
+
* subtracted from the amount (such as a discount).
|
|
1976
|
+
*/
|
|
1977
|
+
amount: number;
|
|
1978
|
+
/**
|
|
1979
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
1980
|
+
* amount's currency.
|
|
1981
|
+
*/
|
|
1982
|
+
currency: string;
|
|
1983
|
+
}
|
|
1984
|
+
}
|
|
1985
|
+
/**
|
|
1986
|
+
* Fields specific to the `network`.
|
|
1987
|
+
*/
|
|
1988
|
+
interface NetworkDetails {
|
|
1989
|
+
/**
|
|
1990
|
+
* The payment network used to process this card authorization.
|
|
1991
|
+
*
|
|
1992
|
+
* - `visa` - Visa
|
|
1993
|
+
* - `pulse` - Pulse
|
|
1994
|
+
*/
|
|
1995
|
+
category: 'visa' | 'pulse';
|
|
1996
|
+
/**
|
|
1997
|
+
* Fields specific to the `pulse` network.
|
|
1998
|
+
*/
|
|
1999
|
+
pulse: NetworkDetails.Pulse | null;
|
|
2000
|
+
/**
|
|
2001
|
+
* Fields specific to the `visa` network.
|
|
2002
|
+
*/
|
|
2003
|
+
visa: NetworkDetails.Visa | null;
|
|
2004
|
+
}
|
|
2005
|
+
namespace NetworkDetails {
|
|
2006
|
+
/**
|
|
2007
|
+
* Fields specific to the `pulse` network.
|
|
2008
|
+
*/
|
|
2009
|
+
interface Pulse {
|
|
2010
|
+
}
|
|
2011
|
+
/**
|
|
2012
|
+
* Fields specific to the `visa` network.
|
|
2013
|
+
*/
|
|
2014
|
+
interface Visa {
|
|
2015
|
+
/**
|
|
2016
|
+
* For electronic commerce transactions, this identifies the level of security used
|
|
2017
|
+
* in obtaining the customer's payment credential. For mail or telephone order
|
|
2018
|
+
* transactions, identifies the type of mail or telephone order.
|
|
2019
|
+
*
|
|
2020
|
+
* - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
|
|
2021
|
+
* that the transaction is a mail/phone order purchase, not a recurring
|
|
2022
|
+
* transaction or installment payment. For domestic transactions in the US
|
|
2023
|
+
* region, this value may also indicate one bill payment transaction in the
|
|
2024
|
+
* card-present or card-absent environments.
|
|
2025
|
+
* - `recurring` - Recurring transaction: Payment indicator used to indicate a
|
|
2026
|
+
* recurring transaction that originates from an acquirer in the US region.
|
|
2027
|
+
* - `installment` - Installment payment: Payment indicator used to indicate one
|
|
2028
|
+
* purchase of goods or services that is billed to the account in multiple
|
|
2029
|
+
* charges over a period of time agreed upon by the cardholder and merchant from
|
|
2030
|
+
* transactions that originate from an acquirer in the US region.
|
|
2031
|
+
* - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
|
|
2032
|
+
* indicate that the type of mail/telephone order is unknown.
|
|
2033
|
+
* - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
|
|
2034
|
+
* indicate that the electronic commerce transaction has been authenticated using
|
|
2035
|
+
* e.g., 3-D Secure
|
|
2036
|
+
* - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
|
|
2037
|
+
* Non-authenticated security transaction at a 3-D Secure-capable merchant, and
|
|
2038
|
+
* merchant attempted to authenticate the cardholder using 3-D Secure: Use to
|
|
2039
|
+
* identify an electronic commerce transaction where the merchant attempted to
|
|
2040
|
+
* authenticate the cardholder using 3-D Secure, but was unable to complete the
|
|
2041
|
+
* authentication because the issuer or cardholder does not participate in the
|
|
2042
|
+
* 3-D Secure program.
|
|
2043
|
+
* - `non_authenticated_security_transaction` - Non-authenticated security
|
|
2044
|
+
* transaction: Use to identify an electronic commerce transaction that uses data
|
|
2045
|
+
* encryption for security however, cardholder authentication is not performed
|
|
2046
|
+
* using 3-D Secure.
|
|
2047
|
+
* - `non_secure_transaction` - Non-secure transaction: Use to identify an
|
|
2048
|
+
* electronic commerce transaction that has no data protection.
|
|
2049
|
+
*/
|
|
2050
|
+
electronic_commerce_indicator: 'mail_phone_order' | 'recurring' | 'installment' | 'unknown_mail_phone_order' | 'secure_electronic_commerce' | 'non_authenticated_security_transaction_at_3ds_capable_merchant' | 'non_authenticated_security_transaction' | 'non_secure_transaction' | null;
|
|
2051
|
+
/**
|
|
2052
|
+
* The method used to enter the cardholder's primary account number and card
|
|
2053
|
+
* expiration date.
|
|
2054
|
+
*
|
|
2055
|
+
* - `unknown` - Unknown
|
|
2056
|
+
* - `manual` - Manual key entry
|
|
2057
|
+
* - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
|
|
2058
|
+
* value
|
|
2059
|
+
* - `optical_code` - Optical code
|
|
2060
|
+
* - `integrated_circuit_card` - Contact chip card
|
|
2061
|
+
* - `contactless` - Contactless read of chip card
|
|
2062
|
+
* - `credential_on_file` - Transaction initiated using a credential that has
|
|
2063
|
+
* previously been stored on file
|
|
2064
|
+
* - `magnetic_stripe` - Magnetic stripe read
|
|
2065
|
+
* - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
|
|
2066
|
+
* - `integrated_circuit_card_no_cvv` - Contact chip card, without card
|
|
2067
|
+
* verification value
|
|
2068
|
+
*/
|
|
2069
|
+
point_of_service_entry_mode: 'unknown' | 'manual' | 'magnetic_stripe_no_cvv' | 'optical_code' | 'integrated_circuit_card' | 'contactless' | 'credential_on_file' | 'magnetic_stripe' | 'contactless_magnetic_stripe' | 'integrated_circuit_card_no_cvv' | null;
|
|
2070
|
+
/**
|
|
2071
|
+
* Only present when `actioner: network`. Describes why a card authorization was
|
|
2072
|
+
* approved or declined by Visa through stand-in processing.
|
|
2073
|
+
*
|
|
2074
|
+
* - `issuer_error` - Increase failed to process the authorization in a timely
|
|
2075
|
+
* manner.
|
|
2076
|
+
* - `invalid_physical_card` - The physical card read had an invalid CVV, dCVV, or
|
|
2077
|
+
* authorization request cryptogram.
|
|
2078
|
+
* - `invalid_cardholder_authentication_verification_value` - The 3DS cardholder
|
|
2079
|
+
* authentication verification value was invalid.
|
|
2080
|
+
* - `internal_visa_error` - An internal Visa error occurred. Visa uses this reason
|
|
2081
|
+
* code for certain expected occurrences as well, such as Application Transaction
|
|
2082
|
+
* Counter (ATC) replays.
|
|
2083
|
+
* - `merchant_transaction_advisory_service_authentication_required` - The merchant
|
|
2084
|
+
* has enabled Visa's Transaction Advisory Service and requires further
|
|
2085
|
+
* authentication to perform the transaction. In practice this is often utilized
|
|
2086
|
+
* at fuel pumps to tell the cardholder to see the cashier.
|
|
2087
|
+
* - `payment_fraud_disruption_acquirer_block` - The transaction was blocked by
|
|
2088
|
+
* Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior,
|
|
2089
|
+
* such as card testing.
|
|
2090
|
+
* - `other` - An unspecific reason for stand-in processing.
|
|
2091
|
+
*/
|
|
2092
|
+
stand_in_processing_reason: 'issuer_error' | 'invalid_physical_card' | 'invalid_cardholder_authentication_verification_value' | 'internal_visa_error' | 'merchant_transaction_advisory_service_authentication_required' | 'payment_fraud_disruption_acquirer_block' | 'other' | null;
|
|
2093
|
+
}
|
|
2094
|
+
}
|
|
2095
|
+
/**
|
|
2096
|
+
* Network-specific identifiers for a specific request or transaction.
|
|
2097
|
+
*/
|
|
2098
|
+
interface NetworkIdentifiers {
|
|
2099
|
+
/**
|
|
2100
|
+
* The randomly generated 6-character Authorization Identification Response code
|
|
2101
|
+
* sent back to the acquirer in an approved response.
|
|
2102
|
+
*/
|
|
2103
|
+
authorization_identification_response: string | null;
|
|
2104
|
+
/**
|
|
2105
|
+
* A life-cycle identifier used across e.g., an authorization and a reversal.
|
|
2106
|
+
* Expected to be unique per acquirer within a window of time. For some card
|
|
2107
|
+
* networks the retrieval reference number includes the trace counter.
|
|
2108
|
+
*/
|
|
2109
|
+
retrieval_reference_number: string | null;
|
|
2110
|
+
/**
|
|
2111
|
+
* A counter used to verify an individual authorization. Expected to be unique per
|
|
2112
|
+
* acquirer within a window of time.
|
|
2113
|
+
*/
|
|
2114
|
+
trace_number: string | null;
|
|
2115
|
+
/**
|
|
2116
|
+
* A globally unique transaction identifier provided by the card network, used
|
|
2117
|
+
* across multiple life-cycle requests.
|
|
2118
|
+
*/
|
|
2119
|
+
transaction_id: string | null;
|
|
2120
|
+
}
|
|
2121
|
+
/**
|
|
2122
|
+
* Fields related to verification of cardholder-provided values.
|
|
2123
|
+
*/
|
|
2124
|
+
interface Verification {
|
|
2125
|
+
/**
|
|
2126
|
+
* Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
2127
|
+
* the back of the card.
|
|
2128
|
+
*/
|
|
2129
|
+
card_verification_code: Verification.CardVerificationCode;
|
|
2130
|
+
/**
|
|
2131
|
+
* Cardholder address provided in the authorization request and the address on file
|
|
2132
|
+
* we verified it against.
|
|
2133
|
+
*/
|
|
2134
|
+
cardholder_address: Verification.CardholderAddress;
|
|
2135
|
+
}
|
|
2136
|
+
namespace Verification {
|
|
2137
|
+
/**
|
|
2138
|
+
* Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
2139
|
+
* the back of the card.
|
|
2140
|
+
*/
|
|
2141
|
+
interface CardVerificationCode {
|
|
2142
|
+
/**
|
|
2143
|
+
* The result of verifying the Card Verification Code.
|
|
2144
|
+
*
|
|
2145
|
+
* - `not_checked` - No card verification code was provided in the authorization
|
|
2146
|
+
* request.
|
|
2147
|
+
* - `match` - The card verification code matched the one on file.
|
|
2148
|
+
* - `no_match` - The card verification code did not match the one on file.
|
|
2149
|
+
*/
|
|
2150
|
+
result: 'not_checked' | 'match' | 'no_match';
|
|
2151
|
+
}
|
|
2152
|
+
/**
|
|
2153
|
+
* Cardholder address provided in the authorization request and the address on file
|
|
2154
|
+
* we verified it against.
|
|
2155
|
+
*/
|
|
2156
|
+
interface CardholderAddress {
|
|
2157
|
+
/**
|
|
2158
|
+
* Line 1 of the address on file for the cardholder.
|
|
2159
|
+
*/
|
|
2160
|
+
actual_line1: string | null;
|
|
2161
|
+
/**
|
|
2162
|
+
* The postal code of the address on file for the cardholder.
|
|
2163
|
+
*/
|
|
2164
|
+
actual_postal_code: string | null;
|
|
2165
|
+
/**
|
|
2166
|
+
* The cardholder address line 1 provided for verification in the authorization
|
|
2167
|
+
* request.
|
|
2168
|
+
*/
|
|
2169
|
+
provided_line1: string | null;
|
|
2170
|
+
/**
|
|
2171
|
+
* The postal code provided for verification in the authorization request.
|
|
2172
|
+
*/
|
|
2173
|
+
provided_postal_code: string | null;
|
|
2174
|
+
/**
|
|
2175
|
+
* The address verification result returned to the card network.
|
|
2176
|
+
*
|
|
2177
|
+
* - `not_checked` - No address information was provided in the authorization
|
|
2178
|
+
* request.
|
|
2179
|
+
* - `postal_code_match_address_no_match` - Postal code matches, but the street
|
|
2180
|
+
* address does not match or was not provided.
|
|
2181
|
+
* - `postal_code_no_match_address_match` - Postal code does not match, but the
|
|
2182
|
+
* street address matches or was not provided.
|
|
2183
|
+
* - `match` - Postal code and street address match.
|
|
2184
|
+
* - `no_match` - Postal code and street address do not match.
|
|
2185
|
+
* - `postal_code_match_address_not_checked` - Postal code matches, but the street
|
|
2186
|
+
* address was not verified. (deprecated)
|
|
2187
|
+
*/
|
|
2188
|
+
result: 'not_checked' | 'postal_code_match_address_no_match' | 'postal_code_no_match_address_match' | 'match' | 'no_match' | 'postal_code_match_address_not_checked';
|
|
2189
|
+
}
|
|
2190
|
+
}
|
|
2191
|
+
}
|
|
2192
|
+
/**
|
|
2193
|
+
* A Card Fuel Confirmation object. This field will be present in the JSON response
|
|
2194
|
+
* if and only if `category` is equal to `card_fuel_confirmation`. Card Fuel
|
|
2195
|
+
* Confirmations update the amount of a Card Authorization after a fuel pump
|
|
2196
|
+
* transaction is completed.
|
|
2197
|
+
*/
|
|
2198
|
+
interface CardFuelConfirmation {
|
|
2199
|
+
/**
|
|
2200
|
+
* The Card Fuel Confirmation identifier.
|
|
2201
|
+
*/
|
|
2202
|
+
id: string;
|
|
2203
|
+
/**
|
|
2204
|
+
* The identifier for the Card Authorization this updates.
|
|
2205
|
+
*/
|
|
2206
|
+
card_authorization_id: string;
|
|
2207
|
+
/**
|
|
2208
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's
|
|
2209
|
+
* currency.
|
|
2210
|
+
*
|
|
2211
|
+
* - `USD` - US Dollar (USD)
|
|
2212
|
+
*/
|
|
2213
|
+
currency: 'USD';
|
|
2214
|
+
/**
|
|
2215
|
+
* The card network used to process this card authorization.
|
|
2216
|
+
*
|
|
2217
|
+
* - `visa` - Visa
|
|
2218
|
+
* - `pulse` - Pulse
|
|
2219
|
+
*/
|
|
2220
|
+
network: 'visa' | 'pulse';
|
|
2221
|
+
/**
|
|
2222
|
+
* Network-specific identifiers for a specific request or transaction.
|
|
2223
|
+
*/
|
|
2224
|
+
network_identifiers: CardFuelConfirmation.NetworkIdentifiers;
|
|
2225
|
+
/**
|
|
2226
|
+
* The identifier of the Pending Transaction associated with this Card Fuel
|
|
2227
|
+
* Confirmation.
|
|
2228
|
+
*/
|
|
2229
|
+
pending_transaction_id: string | null;
|
|
2230
|
+
/**
|
|
2231
|
+
* A constant representing the object's type. For this resource it will always be
|
|
2232
|
+
* `card_fuel_confirmation`.
|
|
2233
|
+
*/
|
|
2234
|
+
type: 'card_fuel_confirmation';
|
|
2235
|
+
/**
|
|
2236
|
+
* The updated authorization amount after this fuel confirmation, in the minor unit
|
|
2237
|
+
* of the transaction's currency. For dollars, for example, this is cents.
|
|
2238
|
+
*/
|
|
2239
|
+
updated_authorization_amount: number;
|
|
2240
|
+
[k: string]: unknown;
|
|
2241
|
+
}
|
|
2242
|
+
namespace CardFuelConfirmation {
|
|
2243
|
+
/**
|
|
2244
|
+
* Network-specific identifiers for a specific request or transaction.
|
|
2245
|
+
*/
|
|
2246
|
+
interface NetworkIdentifiers {
|
|
2247
|
+
/**
|
|
2248
|
+
* The randomly generated 6-character Authorization Identification Response code
|
|
2249
|
+
* sent back to the acquirer in an approved response.
|
|
2250
|
+
*/
|
|
2251
|
+
authorization_identification_response: string | null;
|
|
2252
|
+
/**
|
|
2253
|
+
* A life-cycle identifier used across e.g., an authorization and a reversal.
|
|
2254
|
+
* Expected to be unique per acquirer within a window of time. For some card
|
|
2255
|
+
* networks the retrieval reference number includes the trace counter.
|
|
2256
|
+
*/
|
|
2257
|
+
retrieval_reference_number: string | null;
|
|
2258
|
+
/**
|
|
2259
|
+
* A counter used to verify an individual authorization. Expected to be unique per
|
|
2260
|
+
* acquirer within a window of time.
|
|
2261
|
+
*/
|
|
2262
|
+
trace_number: string | null;
|
|
2263
|
+
/**
|
|
2264
|
+
* A globally unique transaction identifier provided by the card network, used
|
|
2265
|
+
* across multiple life-cycle requests.
|
|
2266
|
+
*/
|
|
2267
|
+
transaction_id: string | null;
|
|
2268
|
+
}
|
|
2269
|
+
}
|
|
2270
|
+
/**
|
|
2271
|
+
* A Card Increment object. This field will be present in the JSON response if and
|
|
2272
|
+
* only if `category` is equal to `card_increment`. Card Increments increase the
|
|
2273
|
+
* pending amount of an authorized transaction.
|
|
2274
|
+
*/
|
|
2275
|
+
interface CardIncrement {
|
|
2276
|
+
/**
|
|
2277
|
+
* The Card Increment identifier.
|
|
2278
|
+
*/
|
|
2279
|
+
id: string;
|
|
2280
|
+
/**
|
|
2281
|
+
* Whether this authorization was approved by Increase, the card network through
|
|
2282
|
+
* stand-in processing, or the user through a real-time decision.
|
|
2283
|
+
*
|
|
2284
|
+
* - `user` - This object was actioned by the user through a real-time decision.
|
|
2285
|
+
* - `increase` - This object was actioned by Increase without user intervention.
|
|
2286
|
+
* - `network` - This object was actioned by the network, through stand-in
|
|
2287
|
+
* processing.
|
|
2288
|
+
*/
|
|
2289
|
+
actioner: 'user' | 'increase' | 'network';
|
|
2290
|
+
/**
|
|
2291
|
+
* Additional amounts associated with the card authorization, such as ATM
|
|
2292
|
+
* surcharges fees. These are usually a subset of the `amount` field and are used
|
|
2293
|
+
* to provide more detailed information about the transaction.
|
|
2294
|
+
*/
|
|
2295
|
+
additional_amounts: CardIncrement.AdditionalAmounts;
|
|
2296
|
+
/**
|
|
2297
|
+
* The amount of this increment in the minor unit of the transaction's currency.
|
|
2298
|
+
* For dollars, for example, this is cents.
|
|
2299
|
+
*/
|
|
2300
|
+
amount: number;
|
|
2301
|
+
/**
|
|
2302
|
+
* The identifier for the Card Authorization this increments.
|
|
2303
|
+
*/
|
|
2304
|
+
card_authorization_id: string;
|
|
2305
|
+
/**
|
|
2306
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's
|
|
2307
|
+
* currency.
|
|
2308
|
+
*
|
|
2309
|
+
* - `USD` - US Dollar (USD)
|
|
2310
|
+
*/
|
|
2311
|
+
currency: 'USD';
|
|
2312
|
+
/**
|
|
2313
|
+
* The card network used to process this card authorization.
|
|
2314
|
+
*
|
|
2315
|
+
* - `visa` - Visa
|
|
2316
|
+
* - `pulse` - Pulse
|
|
2317
|
+
*/
|
|
2318
|
+
network: 'visa' | 'pulse';
|
|
2319
|
+
/**
|
|
2320
|
+
* Network-specific identifiers for a specific request or transaction.
|
|
2321
|
+
*/
|
|
2322
|
+
network_identifiers: CardIncrement.NetworkIdentifiers;
|
|
2323
|
+
/**
|
|
2324
|
+
* The risk score generated by the card network. For Visa this is the Visa Advanced
|
|
2325
|
+
* Authorization risk score, from 0 to 99, where 99 is the riskiest.
|
|
2326
|
+
*/
|
|
2327
|
+
network_risk_score: number | null;
|
|
2328
|
+
/**
|
|
2329
|
+
* The identifier of the Pending Transaction associated with this Card Increment.
|
|
2330
|
+
*/
|
|
2331
|
+
pending_transaction_id: string | null;
|
|
2332
|
+
/**
|
|
2333
|
+
* The amount of this increment in the minor unit of the transaction's presentment
|
|
2334
|
+
* currency.
|
|
2335
|
+
*/
|
|
2336
|
+
presentment_amount: number;
|
|
2337
|
+
/**
|
|
2338
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
2339
|
+
* transaction's presentment currency.
|
|
2340
|
+
*/
|
|
2341
|
+
presentment_currency: string;
|
|
2342
|
+
/**
|
|
2343
|
+
* The identifier of the Real-Time Decision sent to approve or decline this
|
|
2344
|
+
* incremental authorization.
|
|
2345
|
+
*/
|
|
2346
|
+
real_time_decision_id: string | null;
|
|
2347
|
+
/**
|
|
2348
|
+
* A constant representing the object's type. For this resource it will always be
|
|
2349
|
+
* `card_increment`.
|
|
2350
|
+
*/
|
|
2351
|
+
type: 'card_increment';
|
|
2352
|
+
/**
|
|
2353
|
+
* The updated authorization amount after this increment, in the minor unit of the
|
|
2354
|
+
* transaction's currency. For dollars, for example, this is cents.
|
|
2355
|
+
*/
|
|
2356
|
+
updated_authorization_amount: number;
|
|
2357
|
+
[k: string]: unknown;
|
|
2358
|
+
}
|
|
2359
|
+
namespace CardIncrement {
|
|
2360
|
+
/**
|
|
2361
|
+
* Additional amounts associated with the card authorization, such as ATM
|
|
2362
|
+
* surcharges fees. These are usually a subset of the `amount` field and are used
|
|
2363
|
+
* to provide more detailed information about the transaction.
|
|
2364
|
+
*/
|
|
2365
|
+
interface AdditionalAmounts {
|
|
2366
|
+
/**
|
|
2367
|
+
* The part of this transaction amount that was for clinic-related services.
|
|
2368
|
+
*/
|
|
2369
|
+
clinic: AdditionalAmounts.Clinic | null;
|
|
2370
|
+
/**
|
|
2371
|
+
* The part of this transaction amount that was for dental-related services.
|
|
2372
|
+
*/
|
|
2373
|
+
dental: AdditionalAmounts.Dental | null;
|
|
2374
|
+
/**
|
|
2375
|
+
* The original pre-authorized amount.
|
|
2376
|
+
*/
|
|
2377
|
+
original: AdditionalAmounts.Original | null;
|
|
2378
|
+
/**
|
|
2379
|
+
* The part of this transaction amount that was for healthcare prescriptions.
|
|
2380
|
+
*/
|
|
2381
|
+
prescription: AdditionalAmounts.Prescription | null;
|
|
2382
|
+
/**
|
|
2383
|
+
* The surcharge amount charged for this transaction by the merchant.
|
|
2384
|
+
*/
|
|
2385
|
+
surcharge: AdditionalAmounts.Surcharge | null;
|
|
2386
|
+
/**
|
|
2387
|
+
* The total amount of a series of incremental authorizations, optionally provided.
|
|
2388
|
+
*/
|
|
2389
|
+
total_cumulative: AdditionalAmounts.TotalCumulative | null;
|
|
2390
|
+
/**
|
|
2391
|
+
* The total amount of healthcare-related additional amounts.
|
|
2392
|
+
*/
|
|
2393
|
+
total_healthcare: AdditionalAmounts.TotalHealthcare | null;
|
|
2394
|
+
/**
|
|
2395
|
+
* The part of this transaction amount that was for transit-related services.
|
|
2396
|
+
*/
|
|
2397
|
+
transit: AdditionalAmounts.Transit | null;
|
|
2398
|
+
/**
|
|
2399
|
+
* An unknown additional amount.
|
|
2400
|
+
*/
|
|
2401
|
+
unknown: AdditionalAmounts.Unknown | null;
|
|
2402
|
+
/**
|
|
2403
|
+
* The part of this transaction amount that was for vision-related services.
|
|
2404
|
+
*/
|
|
2405
|
+
vision: AdditionalAmounts.Vision | null;
|
|
2406
|
+
}
|
|
2407
|
+
namespace AdditionalAmounts {
|
|
2408
|
+
/**
|
|
2409
|
+
* The part of this transaction amount that was for clinic-related services.
|
|
2410
|
+
*/
|
|
2411
|
+
interface Clinic {
|
|
2412
|
+
/**
|
|
2413
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
2414
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2415
|
+
* subtracted from the amount (such as a discount).
|
|
2416
|
+
*/
|
|
2417
|
+
amount: number;
|
|
2418
|
+
/**
|
|
2419
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2420
|
+
* amount's currency.
|
|
2421
|
+
*/
|
|
2422
|
+
currency: string;
|
|
2423
|
+
}
|
|
2424
|
+
/**
|
|
2425
|
+
* The part of this transaction amount that was for dental-related services.
|
|
2426
|
+
*/
|
|
2427
|
+
interface Dental {
|
|
2428
|
+
/**
|
|
2429
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
2430
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2431
|
+
* subtracted from the amount (such as a discount).
|
|
2432
|
+
*/
|
|
2433
|
+
amount: number;
|
|
2434
|
+
/**
|
|
2435
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2436
|
+
* amount's currency.
|
|
2437
|
+
*/
|
|
2438
|
+
currency: string;
|
|
2439
|
+
}
|
|
2440
|
+
/**
|
|
2441
|
+
* The original pre-authorized amount.
|
|
2442
|
+
*/
|
|
2443
|
+
interface Original {
|
|
2444
|
+
/**
|
|
2445
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
2446
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2447
|
+
* subtracted from the amount (such as a discount).
|
|
2448
|
+
*/
|
|
2449
|
+
amount: number;
|
|
2450
|
+
/**
|
|
2451
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2452
|
+
* amount's currency.
|
|
2453
|
+
*/
|
|
2454
|
+
currency: string;
|
|
2455
|
+
}
|
|
2456
|
+
/**
|
|
2457
|
+
* The part of this transaction amount that was for healthcare prescriptions.
|
|
2458
|
+
*/
|
|
2459
|
+
interface Prescription {
|
|
2460
|
+
/**
|
|
2461
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
2462
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2463
|
+
* subtracted from the amount (such as a discount).
|
|
2464
|
+
*/
|
|
2465
|
+
amount: number;
|
|
2466
|
+
/**
|
|
2467
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2468
|
+
* amount's currency.
|
|
2469
|
+
*/
|
|
2470
|
+
currency: string;
|
|
2471
|
+
}
|
|
2472
|
+
/**
|
|
2473
|
+
* The surcharge amount charged for this transaction by the merchant.
|
|
2474
|
+
*/
|
|
2475
|
+
interface Surcharge {
|
|
2476
|
+
/**
|
|
2477
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
2478
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2479
|
+
* subtracted from the amount (such as a discount).
|
|
2480
|
+
*/
|
|
2481
|
+
amount: number;
|
|
2482
|
+
/**
|
|
2483
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2484
|
+
* amount's currency.
|
|
2485
|
+
*/
|
|
2486
|
+
currency: string;
|
|
2487
|
+
}
|
|
2488
|
+
/**
|
|
2489
|
+
* The total amount of a series of incremental authorizations, optionally provided.
|
|
2490
|
+
*/
|
|
2491
|
+
interface TotalCumulative {
|
|
2492
|
+
/**
|
|
2493
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
2494
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2495
|
+
* subtracted from the amount (such as a discount).
|
|
2496
|
+
*/
|
|
2497
|
+
amount: number;
|
|
2498
|
+
/**
|
|
2499
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2500
|
+
* amount's currency.
|
|
2501
|
+
*/
|
|
2502
|
+
currency: string;
|
|
2503
|
+
}
|
|
2504
|
+
/**
|
|
2505
|
+
* The total amount of healthcare-related additional amounts.
|
|
2506
|
+
*/
|
|
2507
|
+
interface TotalHealthcare {
|
|
2508
|
+
/**
|
|
2509
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
2510
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2511
|
+
* subtracted from the amount (such as a discount).
|
|
2512
|
+
*/
|
|
2513
|
+
amount: number;
|
|
2514
|
+
/**
|
|
2515
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2516
|
+
* amount's currency.
|
|
2517
|
+
*/
|
|
2518
|
+
currency: string;
|
|
2519
|
+
}
|
|
2520
|
+
/**
|
|
2521
|
+
* The part of this transaction amount that was for transit-related services.
|
|
2522
|
+
*/
|
|
2523
|
+
interface Transit {
|
|
2524
|
+
/**
|
|
2525
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
2526
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2527
|
+
* subtracted from the amount (such as a discount).
|
|
2528
|
+
*/
|
|
2529
|
+
amount: number;
|
|
2530
|
+
/**
|
|
2531
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2532
|
+
* amount's currency.
|
|
2533
|
+
*/
|
|
2534
|
+
currency: string;
|
|
2535
|
+
}
|
|
2536
|
+
/**
|
|
2537
|
+
* An unknown additional amount.
|
|
2538
|
+
*/
|
|
2539
|
+
interface Unknown {
|
|
2540
|
+
/**
|
|
2541
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
2542
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2543
|
+
* subtracted from the amount (such as a discount).
|
|
2544
|
+
*/
|
|
2545
|
+
amount: number;
|
|
2546
|
+
/**
|
|
2547
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2548
|
+
* amount's currency.
|
|
2549
|
+
*/
|
|
2550
|
+
currency: string;
|
|
2551
|
+
}
|
|
2552
|
+
/**
|
|
2553
|
+
* The part of this transaction amount that was for vision-related services.
|
|
2554
|
+
*/
|
|
2555
|
+
interface Vision {
|
|
2556
|
+
/**
|
|
2557
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
2558
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
2559
|
+
* subtracted from the amount (such as a discount).
|
|
2560
|
+
*/
|
|
2561
|
+
amount: number;
|
|
2562
|
+
/**
|
|
2563
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
2564
|
+
* amount's currency.
|
|
2565
|
+
*/
|
|
2566
|
+
currency: string;
|
|
2567
|
+
}
|
|
2568
|
+
}
|
|
2569
|
+
/**
|
|
2570
|
+
* Network-specific identifiers for a specific request or transaction.
|
|
2571
|
+
*/
|
|
2572
|
+
interface NetworkIdentifiers {
|
|
2573
|
+
/**
|
|
2574
|
+
* The randomly generated 6-character Authorization Identification Response code
|
|
2575
|
+
* sent back to the acquirer in an approved response.
|
|
2576
|
+
*/
|
|
2577
|
+
authorization_identification_response: string | null;
|
|
2578
|
+
/**
|
|
2579
|
+
* A life-cycle identifier used across e.g., an authorization and a reversal.
|
|
2580
|
+
* Expected to be unique per acquirer within a window of time. For some card
|
|
2581
|
+
* networks the retrieval reference number includes the trace counter.
|
|
2582
|
+
*/
|
|
2583
|
+
retrieval_reference_number: string | null;
|
|
2584
|
+
/**
|
|
2585
|
+
* A counter used to verify an individual authorization. Expected to be unique per
|
|
2586
|
+
* acquirer within a window of time.
|
|
2587
|
+
*/
|
|
2588
|
+
trace_number: string | null;
|
|
2589
|
+
/**
|
|
2590
|
+
* A globally unique transaction identifier provided by the card network, used
|
|
2591
|
+
* across multiple life-cycle requests.
|
|
2592
|
+
*/
|
|
2593
|
+
transaction_id: string | null;
|
|
2594
|
+
}
|
|
2595
|
+
}
|
|
2596
|
+
/**
|
|
2597
|
+
* A Card Refund object. This field will be present in the JSON response if and
|
|
2598
|
+
* only if `category` is equal to `card_refund`. Card Refunds move money back to
|
|
2599
|
+
* the cardholder. While they are usually connected to a Card Settlement an
|
|
2600
|
+
* acquirer can also refund money directly to a card without relation to a
|
|
2601
|
+
* transaction.
|
|
2602
|
+
*/
|
|
2603
|
+
interface CardRefund {
|
|
2604
|
+
/**
|
|
2605
|
+
* The Card Refund identifier.
|
|
2606
|
+
*/
|
|
2607
|
+
id: string;
|
|
2608
|
+
/**
|
|
2609
|
+
* The amount in the minor unit of the transaction's settlement currency. For
|
|
2610
|
+
* dollars, for example, this is cents.
|
|
2611
|
+
*/
|
|
2612
|
+
amount: number;
|
|
2613
|
+
/**
|
|
2614
|
+
* The ID of the Card Payment this transaction belongs to.
|
|
2615
|
+
*/
|
|
2616
|
+
card_payment_id: string;
|
|
2617
|
+
/**
|
|
2618
|
+
* Cashback debited for this transaction, if eligible. Cashback is paid out in
|
|
2619
|
+
* aggregate, monthly.
|
|
2620
|
+
*/
|
|
2621
|
+
cashback: CardRefund.Cashback | null;
|
|
2622
|
+
/**
|
|
2623
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
2624
|
+
* transaction's settlement currency.
|
|
2625
|
+
*
|
|
2626
|
+
* - `USD` - US Dollar (USD)
|
|
2627
|
+
*/
|
|
2628
|
+
currency: 'USD';
|
|
2629
|
+
/**
|
|
2630
|
+
* Interchange assessed as a part of this transaciton.
|
|
2631
|
+
*/
|
|
2632
|
+
interchange: CardRefund.Interchange | null;
|
|
2633
|
+
/**
|
|
2634
|
+
* The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
2635
|
+
* is transacting with.
|
|
2636
|
+
*/
|
|
2637
|
+
merchant_acceptor_id: string;
|
|
2638
|
+
/**
|
|
2639
|
+
* The 4-digit MCC describing the merchant's business.
|
|
2640
|
+
*/
|
|
2641
|
+
merchant_category_code: string;
|
|
2642
|
+
/**
|
|
2643
|
+
* The city the merchant resides in.
|
|
2644
|
+
*/
|
|
2645
|
+
merchant_city: string;
|
|
2646
|
+
/**
|
|
2647
|
+
* The country the merchant resides in.
|
|
2648
|
+
*/
|
|
2649
|
+
merchant_country: string;
|
|
2650
|
+
/**
|
|
2651
|
+
* The name of the merchant.
|
|
2652
|
+
*/
|
|
2653
|
+
merchant_name: string;
|
|
2654
|
+
/**
|
|
2655
|
+
* The merchant's postal code. For US merchants this is always a 5-digit ZIP code.
|
|
2656
|
+
*/
|
|
2657
|
+
merchant_postal_code: string | null;
|
|
2658
|
+
/**
|
|
2659
|
+
* The state the merchant resides in.
|
|
2660
|
+
*/
|
|
2661
|
+
merchant_state: string | null;
|
|
2662
|
+
/**
|
|
2663
|
+
* Network-specific identifiers for this refund.
|
|
2664
|
+
*/
|
|
2665
|
+
network_identifiers: CardRefund.NetworkIdentifiers;
|
|
2666
|
+
/**
|
|
2667
|
+
* The amount in the minor unit of the transaction's presentment currency.
|
|
2668
|
+
*/
|
|
2669
|
+
presentment_amount: number;
|
|
2670
|
+
/**
|
|
2671
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
2672
|
+
* transaction's presentment currency.
|
|
2673
|
+
*/
|
|
2674
|
+
presentment_currency: string;
|
|
2675
|
+
/**
|
|
2676
|
+
* Additional details about the card purchase, such as tax and industry-specific
|
|
2677
|
+
* fields.
|
|
2678
|
+
*/
|
|
2679
|
+
purchase_details: CardRefund.PurchaseDetails | null;
|
|
2680
|
+
/**
|
|
2681
|
+
* The identifier of the Transaction associated with this Transaction.
|
|
2682
|
+
*/
|
|
2683
|
+
transaction_id: string;
|
|
2684
|
+
/**
|
|
2685
|
+
* A constant representing the object's type. For this resource it will always be
|
|
2686
|
+
* `card_refund`.
|
|
2687
|
+
*/
|
|
2688
|
+
type: 'card_refund';
|
|
2689
|
+
[k: string]: unknown;
|
|
2690
|
+
}
|
|
2691
|
+
namespace CardRefund {
|
|
2692
|
+
/**
|
|
2693
|
+
* Cashback debited for this transaction, if eligible. Cashback is paid out in
|
|
2694
|
+
* aggregate, monthly.
|
|
2695
|
+
*/
|
|
2696
|
+
interface Cashback {
|
|
2697
|
+
/**
|
|
2698
|
+
* The cashback amount given as a string containing a decimal number. The amount is
|
|
2699
|
+
* a positive number if it will be credited to you (e.g., settlements) and a
|
|
2700
|
+
* negative number if it will be debited (e.g., refunds).
|
|
2701
|
+
*/
|
|
2702
|
+
amount: string;
|
|
2703
|
+
/**
|
|
2704
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
|
|
2705
|
+
*
|
|
2706
|
+
* - `USD` - US Dollar (USD)
|
|
2707
|
+
*/
|
|
2708
|
+
currency: 'USD';
|
|
2709
|
+
}
|
|
2710
|
+
/**
|
|
2711
|
+
* Interchange assessed as a part of this transaciton.
|
|
2712
|
+
*/
|
|
2713
|
+
interface Interchange {
|
|
2714
|
+
/**
|
|
2715
|
+
* The interchange amount given as a string containing a decimal number in major
|
|
2716
|
+
* units (so e.g., "3.14" for $3.14). The amount is a positive number if it is
|
|
2717
|
+
* credited to Increase (e.g., settlements) and a negative number if it is debited
|
|
2718
|
+
* (e.g., refunds).
|
|
2719
|
+
*/
|
|
2720
|
+
amount: string;
|
|
2721
|
+
/**
|
|
2722
|
+
* The card network specific interchange code.
|
|
2723
|
+
*/
|
|
2724
|
+
code: string | null;
|
|
2725
|
+
/**
|
|
2726
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange
|
|
2727
|
+
* reimbursement.
|
|
2728
|
+
*
|
|
2729
|
+
* - `USD` - US Dollar (USD)
|
|
2730
|
+
*/
|
|
2731
|
+
currency: 'USD';
|
|
2732
|
+
}
|
|
2733
|
+
/**
|
|
2734
|
+
* Network-specific identifiers for this refund.
|
|
2735
|
+
*/
|
|
2736
|
+
interface NetworkIdentifiers {
|
|
2737
|
+
/**
|
|
2738
|
+
* A network assigned business ID that identifies the acquirer that processed this
|
|
2739
|
+
* transaction.
|
|
2740
|
+
*/
|
|
2741
|
+
acquirer_business_id: string;
|
|
2742
|
+
/**
|
|
2743
|
+
* A globally unique identifier for this settlement.
|
|
2744
|
+
*/
|
|
2745
|
+
acquirer_reference_number: string;
|
|
2746
|
+
/**
|
|
2747
|
+
* The randomly generated 6-character Authorization Identification Response code
|
|
2748
|
+
* sent back to the acquirer in an approved response.
|
|
2749
|
+
*/
|
|
2750
|
+
authorization_identification_response: string | null;
|
|
2751
|
+
/**
|
|
2752
|
+
* A globally unique transaction identifier provided by the card network, used
|
|
2753
|
+
* across multiple life-cycle requests.
|
|
2754
|
+
*/
|
|
2755
|
+
transaction_id: string | null;
|
|
2756
|
+
}
|
|
2757
|
+
/**
|
|
2758
|
+
* Additional details about the card purchase, such as tax and industry-specific
|
|
2759
|
+
* fields.
|
|
2760
|
+
*/
|
|
2761
|
+
interface PurchaseDetails {
|
|
2762
|
+
/**
|
|
2763
|
+
* Fields specific to car rentals.
|
|
2764
|
+
*/
|
|
2765
|
+
car_rental: PurchaseDetails.CarRental | null;
|
|
2766
|
+
/**
|
|
2767
|
+
* An identifier from the merchant for the customer or consumer.
|
|
2768
|
+
*/
|
|
2769
|
+
customer_reference_identifier: string | null;
|
|
2770
|
+
/**
|
|
2771
|
+
* The state or provincial tax amount in minor units.
|
|
2772
|
+
*/
|
|
2773
|
+
local_tax_amount: number | null;
|
|
2774
|
+
/**
|
|
2775
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
|
|
2776
|
+
* assessed.
|
|
2777
|
+
*/
|
|
2778
|
+
local_tax_currency: string | null;
|
|
2779
|
+
/**
|
|
2780
|
+
* Fields specific to lodging.
|
|
2781
|
+
*/
|
|
2782
|
+
lodging: PurchaseDetails.Lodging | null;
|
|
2783
|
+
/**
|
|
2784
|
+
* The national tax amount in minor units.
|
|
2785
|
+
*/
|
|
2786
|
+
national_tax_amount: number | null;
|
|
2787
|
+
/**
|
|
2788
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
|
|
2789
|
+
* assessed.
|
|
2790
|
+
*/
|
|
2791
|
+
national_tax_currency: string | null;
|
|
2792
|
+
/**
|
|
2793
|
+
* An identifier from the merchant for the purchase to the issuer and cardholder.
|
|
2794
|
+
*/
|
|
2795
|
+
purchase_identifier: string | null;
|
|
2796
|
+
/**
|
|
2797
|
+
* The format of the purchase identifier.
|
|
2798
|
+
*
|
|
2799
|
+
* - `free_text` - Free text
|
|
2800
|
+
* - `order_number` - Order number
|
|
2801
|
+
* - `rental_agreement_number` - Rental agreement number
|
|
2802
|
+
* - `hotel_folio_number` - Hotel folio number
|
|
2803
|
+
* - `invoice_number` - Invoice number
|
|
2804
|
+
*/
|
|
2805
|
+
purchase_identifier_format: 'free_text' | 'order_number' | 'rental_agreement_number' | 'hotel_folio_number' | 'invoice_number' | null;
|
|
2806
|
+
/**
|
|
2807
|
+
* Fields specific to travel.
|
|
2808
|
+
*/
|
|
2809
|
+
travel: PurchaseDetails.Travel | null;
|
|
2810
|
+
}
|
|
2811
|
+
namespace PurchaseDetails {
|
|
2812
|
+
/**
|
|
2813
|
+
* Fields specific to car rentals.
|
|
2814
|
+
*/
|
|
2815
|
+
interface CarRental {
|
|
2816
|
+
/**
|
|
2817
|
+
* Code indicating the vehicle's class.
|
|
2818
|
+
*/
|
|
2819
|
+
car_class_code: string | null;
|
|
2820
|
+
/**
|
|
2821
|
+
* Date the customer picked up the car or, in the case of a no-show or pre-pay
|
|
2822
|
+
* transaction, the scheduled pick up date.
|
|
2823
|
+
*/
|
|
2824
|
+
checkout_date: string | null;
|
|
2825
|
+
/**
|
|
2826
|
+
* Daily rate being charged for the vehicle.
|
|
2827
|
+
*/
|
|
2828
|
+
daily_rental_rate_amount: number | null;
|
|
2829
|
+
/**
|
|
2830
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
|
|
2831
|
+
* rate.
|
|
2832
|
+
*/
|
|
2833
|
+
daily_rental_rate_currency: string | null;
|
|
2834
|
+
/**
|
|
2835
|
+
* Number of days the vehicle was rented.
|
|
2836
|
+
*/
|
|
2837
|
+
days_rented: number | null;
|
|
2838
|
+
/**
|
|
2839
|
+
* Additional charges (gas, late fee, etc.) being billed.
|
|
2840
|
+
*
|
|
2841
|
+
* - `no_extra_charge` - No extra charge
|
|
2842
|
+
* - `gas` - Gas
|
|
2843
|
+
* - `extra_mileage` - Extra mileage
|
|
2844
|
+
* - `late_return` - Late return
|
|
2845
|
+
* - `one_way_service_fee` - One way service fee
|
|
2846
|
+
* - `parking_violation` - Parking violation
|
|
2847
|
+
*/
|
|
2848
|
+
extra_charges: 'no_extra_charge' | 'gas' | 'extra_mileage' | 'late_return' | 'one_way_service_fee' | 'parking_violation' | null;
|
|
2849
|
+
/**
|
|
2850
|
+
* Fuel charges for the vehicle.
|
|
2851
|
+
*/
|
|
2852
|
+
fuel_charges_amount: number | null;
|
|
2853
|
+
/**
|
|
2854
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
|
|
2855
|
+
* assessed.
|
|
2856
|
+
*/
|
|
2857
|
+
fuel_charges_currency: string | null;
|
|
2858
|
+
/**
|
|
2859
|
+
* Any insurance being charged for the vehicle.
|
|
2860
|
+
*/
|
|
2861
|
+
insurance_charges_amount: number | null;
|
|
2862
|
+
/**
|
|
2863
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
|
|
2864
|
+
* charges assessed.
|
|
2865
|
+
*/
|
|
2866
|
+
insurance_charges_currency: string | null;
|
|
2867
|
+
/**
|
|
2868
|
+
* An indicator that the cardholder is being billed for a reserved vehicle that was
|
|
2869
|
+
* not actually rented (that is, a "no-show" charge).
|
|
2870
|
+
*
|
|
2871
|
+
* - `not_applicable` - Not applicable
|
|
2872
|
+
* - `no_show_for_specialized_vehicle` - No show for specialized vehicle
|
|
2873
|
+
*/
|
|
2874
|
+
no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
|
|
2875
|
+
/**
|
|
2876
|
+
* Charges for returning the vehicle at a different location than where it was
|
|
2877
|
+
* picked up.
|
|
2878
|
+
*/
|
|
2879
|
+
one_way_drop_off_charges_amount: number | null;
|
|
2880
|
+
/**
|
|
2881
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
|
|
2882
|
+
* drop-off charges assessed.
|
|
2883
|
+
*/
|
|
2884
|
+
one_way_drop_off_charges_currency: string | null;
|
|
2885
|
+
/**
|
|
2886
|
+
* Name of the person renting the vehicle.
|
|
2887
|
+
*/
|
|
2888
|
+
renter_name: string | null;
|
|
2889
|
+
/**
|
|
2890
|
+
* Weekly rate being charged for the vehicle.
|
|
2891
|
+
*/
|
|
2892
|
+
weekly_rental_rate_amount: number | null;
|
|
2893
|
+
/**
|
|
2894
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
|
|
2895
|
+
* rental rate.
|
|
2896
|
+
*/
|
|
2897
|
+
weekly_rental_rate_currency: string | null;
|
|
2898
|
+
}
|
|
2899
|
+
/**
|
|
2900
|
+
* Fields specific to lodging.
|
|
2901
|
+
*/
|
|
2902
|
+
interface Lodging {
|
|
2903
|
+
/**
|
|
2904
|
+
* Date the customer checked in.
|
|
2905
|
+
*/
|
|
2906
|
+
check_in_date: string | null;
|
|
2907
|
+
/**
|
|
2908
|
+
* Daily rate being charged for the room.
|
|
2909
|
+
*/
|
|
2910
|
+
daily_room_rate_amount: number | null;
|
|
2911
|
+
/**
|
|
2912
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
|
|
2913
|
+
* rate.
|
|
2914
|
+
*/
|
|
2915
|
+
daily_room_rate_currency: string | null;
|
|
2916
|
+
/**
|
|
2917
|
+
* Additional charges (phone, late check-out, etc.) being billed.
|
|
2918
|
+
*
|
|
2919
|
+
* - `no_extra_charge` - No extra charge
|
|
2920
|
+
* - `restaurant` - Restaurant
|
|
2921
|
+
* - `gift_shop` - Gift shop
|
|
2922
|
+
* - `mini_bar` - Mini bar
|
|
2923
|
+
* - `telephone` - Telephone
|
|
2924
|
+
* - `other` - Other
|
|
2925
|
+
* - `laundry` - Laundry
|
|
2926
|
+
*/
|
|
2927
|
+
extra_charges: 'no_extra_charge' | 'restaurant' | 'gift_shop' | 'mini_bar' | 'telephone' | 'other' | 'laundry' | null;
|
|
2928
|
+
/**
|
|
2929
|
+
* Folio cash advances for the room.
|
|
2930
|
+
*/
|
|
2931
|
+
folio_cash_advances_amount: number | null;
|
|
2932
|
+
/**
|
|
2933
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
|
|
2934
|
+
* advances.
|
|
2935
|
+
*/
|
|
2936
|
+
folio_cash_advances_currency: string | null;
|
|
2937
|
+
/**
|
|
2938
|
+
* Food and beverage charges for the room.
|
|
2939
|
+
*/
|
|
2940
|
+
food_beverage_charges_amount: number | null;
|
|
2941
|
+
/**
|
|
2942
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
|
|
2943
|
+
* beverage charges.
|
|
2944
|
+
*/
|
|
2945
|
+
food_beverage_charges_currency: string | null;
|
|
2946
|
+
/**
|
|
2947
|
+
* Indicator that the cardholder is being billed for a reserved room that was not
|
|
2948
|
+
* actually used.
|
|
2949
|
+
*
|
|
2950
|
+
* - `not_applicable` - Not applicable
|
|
2951
|
+
* - `no_show` - No show
|
|
2952
|
+
*/
|
|
2953
|
+
no_show_indicator: 'not_applicable' | 'no_show' | null;
|
|
2954
|
+
/**
|
|
2955
|
+
* Prepaid expenses being charged for the room.
|
|
2956
|
+
*/
|
|
2957
|
+
prepaid_expenses_amount: number | null;
|
|
2958
|
+
/**
|
|
2959
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
|
|
2960
|
+
* expenses.
|
|
2961
|
+
*/
|
|
2962
|
+
prepaid_expenses_currency: string | null;
|
|
2963
|
+
/**
|
|
2964
|
+
* Number of nights the room was rented.
|
|
2965
|
+
*/
|
|
2966
|
+
room_nights: number | null;
|
|
2967
|
+
/**
|
|
2968
|
+
* Total room tax being charged.
|
|
2969
|
+
*/
|
|
2970
|
+
total_room_tax_amount: number | null;
|
|
2971
|
+
/**
|
|
2972
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
|
|
2973
|
+
* tax.
|
|
2974
|
+
*/
|
|
2975
|
+
total_room_tax_currency: string | null;
|
|
2976
|
+
/**
|
|
2977
|
+
* Total tax being charged for the room.
|
|
2978
|
+
*/
|
|
2979
|
+
total_tax_amount: number | null;
|
|
2980
|
+
/**
|
|
2981
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
|
|
2982
|
+
* assessed.
|
|
2983
|
+
*/
|
|
2984
|
+
total_tax_currency: string | null;
|
|
2985
|
+
}
|
|
2986
|
+
/**
|
|
2987
|
+
* Fields specific to travel.
|
|
2988
|
+
*/
|
|
2989
|
+
interface Travel {
|
|
2990
|
+
/**
|
|
2991
|
+
* Ancillary purchases in addition to the airfare.
|
|
2992
|
+
*/
|
|
2993
|
+
ancillary: Travel.Ancillary | null;
|
|
2994
|
+
/**
|
|
2995
|
+
* Indicates the computerized reservation system used to book the ticket.
|
|
2996
|
+
*/
|
|
2997
|
+
computerized_reservation_system: string | null;
|
|
2998
|
+
/**
|
|
2999
|
+
* Indicates the reason for a credit to the cardholder.
|
|
3000
|
+
*
|
|
3001
|
+
* - `no_credit` - No credit
|
|
3002
|
+
* - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
|
|
3003
|
+
* ancillary purchase cancellation
|
|
3004
|
+
* - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
|
|
3005
|
+
* Airline ticket and passenger transport ancillary purchase cancellation
|
|
3006
|
+
* - `airline_ticket_cancellation` - Airline ticket cancellation
|
|
3007
|
+
* - `other` - Other
|
|
3008
|
+
* - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
|
|
3009
|
+
*/
|
|
3010
|
+
credit_reason_indicator: 'no_credit' | 'passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_cancellation' | 'other' | 'partial_refund_of_airline_ticket' | null;
|
|
3011
|
+
/**
|
|
3012
|
+
* Date of departure.
|
|
3013
|
+
*/
|
|
3014
|
+
departure_date: string | null;
|
|
3015
|
+
/**
|
|
3016
|
+
* Code for the originating city or airport.
|
|
3017
|
+
*/
|
|
3018
|
+
origination_city_airport_code: string | null;
|
|
3019
|
+
/**
|
|
3020
|
+
* Name of the passenger.
|
|
3021
|
+
*/
|
|
3022
|
+
passenger_name: string | null;
|
|
3023
|
+
/**
|
|
3024
|
+
* Indicates whether this ticket is non-refundable.
|
|
3025
|
+
*
|
|
3026
|
+
* - `no_restrictions` - No restrictions
|
|
3027
|
+
* - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
|
|
3028
|
+
*/
|
|
3029
|
+
restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
|
|
3030
|
+
/**
|
|
3031
|
+
* Indicates why a ticket was changed.
|
|
3032
|
+
*
|
|
3033
|
+
* - `none` - None
|
|
3034
|
+
* - `change_to_existing_ticket` - Change to existing ticket
|
|
3035
|
+
* - `new_ticket` - New ticket
|
|
3036
|
+
*/
|
|
3037
|
+
ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
|
|
3038
|
+
/**
|
|
3039
|
+
* Ticket number.
|
|
3040
|
+
*/
|
|
3041
|
+
ticket_number: string | null;
|
|
3042
|
+
/**
|
|
3043
|
+
* Code for the travel agency if the ticket was issued by a travel agency.
|
|
3044
|
+
*/
|
|
3045
|
+
travel_agency_code: string | null;
|
|
3046
|
+
/**
|
|
3047
|
+
* Name of the travel agency if the ticket was issued by a travel agency.
|
|
3048
|
+
*/
|
|
3049
|
+
travel_agency_name: string | null;
|
|
3050
|
+
/**
|
|
3051
|
+
* Fields specific to each leg of the journey.
|
|
3052
|
+
*/
|
|
3053
|
+
trip_legs: Array<Travel.TripLeg> | null;
|
|
3054
|
+
}
|
|
3055
|
+
namespace Travel {
|
|
3056
|
+
/**
|
|
3057
|
+
* Ancillary purchases in addition to the airfare.
|
|
3058
|
+
*/
|
|
3059
|
+
interface Ancillary {
|
|
3060
|
+
/**
|
|
3061
|
+
* If this purchase has a connection or relationship to another purchase, such as a
|
|
3062
|
+
* baggage fee for a passenger transport ticket, this field should contain the
|
|
3063
|
+
* ticket document number for the other purchase.
|
|
3064
|
+
*/
|
|
3065
|
+
connected_ticket_document_number: string | null;
|
|
3066
|
+
/**
|
|
3067
|
+
* Indicates the reason for a credit to the cardholder.
|
|
3068
|
+
*
|
|
3069
|
+
* - `no_credit` - No credit
|
|
3070
|
+
* - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
|
|
3071
|
+
* ancillary purchase cancellation
|
|
3072
|
+
* - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
|
|
3073
|
+
* Airline ticket and passenger transport ancillary purchase cancellation
|
|
3074
|
+
* - `other` - Other
|
|
3075
|
+
*/
|
|
3076
|
+
credit_reason_indicator: 'no_credit' | 'passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation' | 'other' | null;
|
|
3077
|
+
/**
|
|
3078
|
+
* Name of the passenger or description of the ancillary purchase.
|
|
3079
|
+
*/
|
|
3080
|
+
passenger_name_or_description: string | null;
|
|
3081
|
+
/**
|
|
3082
|
+
* Additional travel charges, such as baggage fees.
|
|
3083
|
+
*/
|
|
3084
|
+
services: Array<Ancillary.Service>;
|
|
3085
|
+
/**
|
|
3086
|
+
* Ticket document number.
|
|
3087
|
+
*/
|
|
3088
|
+
ticket_document_number: string | null;
|
|
3089
|
+
}
|
|
3090
|
+
namespace Ancillary {
|
|
3091
|
+
interface Service {
|
|
3092
|
+
/**
|
|
3093
|
+
* Category of the ancillary service.
|
|
3094
|
+
*
|
|
3095
|
+
* - `none` - None
|
|
3096
|
+
* - `bundled_service` - Bundled service
|
|
3097
|
+
* - `baggage_fee` - Baggage fee
|
|
3098
|
+
* - `change_fee` - Change fee
|
|
3099
|
+
* - `cargo` - Cargo
|
|
3100
|
+
* - `carbon_offset` - Carbon offset
|
|
3101
|
+
* - `frequent_flyer` - Frequent flyer
|
|
3102
|
+
* - `gift_card` - Gift card
|
|
3103
|
+
* - `ground_transport` - Ground transport
|
|
3104
|
+
* - `in_flight_entertainment` - In-flight entertainment
|
|
3105
|
+
* - `lounge` - Lounge
|
|
3106
|
+
* - `medical` - Medical
|
|
3107
|
+
* - `meal_beverage` - Meal beverage
|
|
3108
|
+
* - `other` - Other
|
|
3109
|
+
* - `passenger_assist_fee` - Passenger assist fee
|
|
3110
|
+
* - `pets` - Pets
|
|
3111
|
+
* - `seat_fees` - Seat fees
|
|
3112
|
+
* - `standby` - Standby
|
|
3113
|
+
* - `service_fee` - Service fee
|
|
3114
|
+
* - `store` - Store
|
|
3115
|
+
* - `travel_service` - Travel service
|
|
3116
|
+
* - `unaccompanied_travel` - Unaccompanied travel
|
|
3117
|
+
* - `upgrades` - Upgrades
|
|
3118
|
+
* - `wifi` - Wi-fi
|
|
3119
|
+
*/
|
|
3120
|
+
category: 'none' | 'bundled_service' | 'baggage_fee' | 'change_fee' | 'cargo' | 'carbon_offset' | 'frequent_flyer' | 'gift_card' | 'ground_transport' | 'in_flight_entertainment' | 'lounge' | 'medical' | 'meal_beverage' | 'other' | 'passenger_assist_fee' | 'pets' | 'seat_fees' | 'standby' | 'service_fee' | 'store' | 'travel_service' | 'unaccompanied_travel' | 'upgrades' | 'wifi' | null;
|
|
3121
|
+
/**
|
|
3122
|
+
* Sub-category of the ancillary service, free-form.
|
|
3123
|
+
*/
|
|
3124
|
+
sub_category: string | null;
|
|
3125
|
+
}
|
|
3126
|
+
}
|
|
3127
|
+
interface TripLeg {
|
|
3128
|
+
/**
|
|
3129
|
+
* Carrier code (e.g., United Airlines, Jet Blue, etc.).
|
|
3130
|
+
*/
|
|
3131
|
+
carrier_code: string | null;
|
|
3132
|
+
/**
|
|
3133
|
+
* Code for the destination city or airport.
|
|
3134
|
+
*/
|
|
3135
|
+
destination_city_airport_code: string | null;
|
|
3136
|
+
/**
|
|
3137
|
+
* Fare basis code.
|
|
3138
|
+
*/
|
|
3139
|
+
fare_basis_code: string | null;
|
|
3140
|
+
/**
|
|
3141
|
+
* Flight number.
|
|
3142
|
+
*/
|
|
3143
|
+
flight_number: string | null;
|
|
3144
|
+
/**
|
|
3145
|
+
* Service class (e.g., first class, business class, etc.).
|
|
3146
|
+
*/
|
|
3147
|
+
service_class: string | null;
|
|
3148
|
+
/**
|
|
3149
|
+
* Indicates whether a stopover is allowed on this ticket.
|
|
3150
|
+
*
|
|
3151
|
+
* - `none` - None
|
|
3152
|
+
* - `stop_over_allowed` - Stop over allowed
|
|
3153
|
+
* - `stop_over_not_allowed` - Stop over not allowed
|
|
3154
|
+
*/
|
|
3155
|
+
stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
|
|
3156
|
+
}
|
|
3157
|
+
}
|
|
3158
|
+
}
|
|
3159
|
+
}
|
|
3160
|
+
/**
|
|
3161
|
+
* A Card Reversal object. This field will be present in the JSON response if and
|
|
3162
|
+
* only if `category` is equal to `card_reversal`. Card Reversals cancel parts of
|
|
3163
|
+
* or the entirety of an existing Card Authorization.
|
|
3164
|
+
*/
|
|
3165
|
+
interface CardReversal {
|
|
3166
|
+
/**
|
|
3167
|
+
* The Card Reversal identifier.
|
|
3168
|
+
*/
|
|
3169
|
+
id: string;
|
|
3170
|
+
/**
|
|
3171
|
+
* The identifier for the Card Authorization this reverses.
|
|
3172
|
+
*/
|
|
3173
|
+
card_authorization_id: string;
|
|
3174
|
+
/**
|
|
3175
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
|
|
3176
|
+
* currency.
|
|
3177
|
+
*
|
|
3178
|
+
* - `USD` - US Dollar (USD)
|
|
3179
|
+
*/
|
|
3180
|
+
currency: 'USD';
|
|
3181
|
+
/**
|
|
3182
|
+
* The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
3183
|
+
* is transacting with.
|
|
3184
|
+
*/
|
|
3185
|
+
merchant_acceptor_id: string;
|
|
3186
|
+
/**
|
|
3187
|
+
* The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
|
3188
|
+
* card is transacting with.
|
|
3189
|
+
*/
|
|
3190
|
+
merchant_category_code: string;
|
|
3191
|
+
/**
|
|
3192
|
+
* The city the merchant resides in.
|
|
3193
|
+
*/
|
|
3194
|
+
merchant_city: string | null;
|
|
3195
|
+
/**
|
|
3196
|
+
* The country the merchant resides in.
|
|
3197
|
+
*/
|
|
3198
|
+
merchant_country: string | null;
|
|
3199
|
+
/**
|
|
3200
|
+
* The merchant descriptor of the merchant the card is transacting with.
|
|
3201
|
+
*/
|
|
3202
|
+
merchant_descriptor: string;
|
|
3203
|
+
/**
|
|
3204
|
+
* The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
|
|
3205
|
+
* ZIP code, where the first 5 and last 4 are separated by a dash.
|
|
3206
|
+
*/
|
|
3207
|
+
merchant_postal_code: string | null;
|
|
3208
|
+
/**
|
|
3209
|
+
* The state the merchant resides in.
|
|
3210
|
+
*/
|
|
3211
|
+
merchant_state: string | null;
|
|
3212
|
+
/**
|
|
3213
|
+
* The card network used to process this card authorization.
|
|
3214
|
+
*
|
|
3215
|
+
* - `visa` - Visa
|
|
3216
|
+
* - `pulse` - Pulse
|
|
3217
|
+
*/
|
|
3218
|
+
network: 'visa' | 'pulse';
|
|
3219
|
+
/**
|
|
3220
|
+
* Network-specific identifiers for a specific request or transaction.
|
|
3221
|
+
*/
|
|
3222
|
+
network_identifiers: CardReversal.NetworkIdentifiers;
|
|
3223
|
+
/**
|
|
3224
|
+
* The identifier of the Pending Transaction associated with this Card Reversal.
|
|
3225
|
+
*/
|
|
3226
|
+
pending_transaction_id: string | null;
|
|
3227
|
+
/**
|
|
3228
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's
|
|
3229
|
+
* presentment currency.
|
|
3230
|
+
*/
|
|
3231
|
+
presentment_currency: string;
|
|
3232
|
+
/**
|
|
3233
|
+
* The amount of this reversal in the minor unit of the transaction's currency. For
|
|
3234
|
+
* dollars, for example, this is cents.
|
|
3235
|
+
*/
|
|
3236
|
+
reversal_amount: number;
|
|
3237
|
+
/**
|
|
3238
|
+
* The amount of this reversal in the minor unit of the transaction's presentment
|
|
3239
|
+
* currency. For dollars, for example, this is cents.
|
|
3240
|
+
*/
|
|
3241
|
+
reversal_presentment_amount: number;
|
|
3242
|
+
/**
|
|
3243
|
+
* Why this reversal was initiated.
|
|
3244
|
+
*
|
|
3245
|
+
* - `reversed_by_customer` - The Card Reversal was initiated at the customer's
|
|
3246
|
+
* request.
|
|
3247
|
+
* - `reversed_by_network_or_acquirer` - The Card Reversal was initiated by the
|
|
3248
|
+
* network or acquirer.
|
|
3249
|
+
* - `reversed_by_point_of_sale` - The Card Reversal was initiated by the point of
|
|
3250
|
+
* sale device.
|
|
3251
|
+
* - `partial_reversal` - The Card Reversal was a partial reversal, for any reason.
|
|
3252
|
+
*/
|
|
3253
|
+
reversal_reason: 'reversed_by_customer' | 'reversed_by_network_or_acquirer' | 'reversed_by_point_of_sale' | 'partial_reversal' | null;
|
|
3254
|
+
/**
|
|
3255
|
+
* The terminal identifier (commonly abbreviated as TID) of the terminal the card
|
|
3256
|
+
* is transacting with.
|
|
3257
|
+
*/
|
|
3258
|
+
terminal_id: string | null;
|
|
3259
|
+
/**
|
|
3260
|
+
* A constant representing the object's type. For this resource it will always be
|
|
3261
|
+
* `card_reversal`.
|
|
3262
|
+
*/
|
|
3263
|
+
type: 'card_reversal';
|
|
3264
|
+
/**
|
|
3265
|
+
* The amount left pending on the Card Authorization in the minor unit of the
|
|
3266
|
+
* transaction's currency. For dollars, for example, this is cents.
|
|
3267
|
+
*/
|
|
3268
|
+
updated_authorization_amount: number;
|
|
3269
|
+
/**
|
|
3270
|
+
* The amount left pending on the Card Authorization in the minor unit of the
|
|
3271
|
+
* transaction's presentment currency. For dollars, for example, this is cents.
|
|
3272
|
+
*/
|
|
3273
|
+
updated_authorization_presentment_amount: number;
|
|
3274
|
+
[k: string]: unknown;
|
|
3275
|
+
}
|
|
3276
|
+
namespace CardReversal {
|
|
3277
|
+
/**
|
|
3278
|
+
* Network-specific identifiers for a specific request or transaction.
|
|
3279
|
+
*/
|
|
3280
|
+
interface NetworkIdentifiers {
|
|
3281
|
+
/**
|
|
3282
|
+
* The randomly generated 6-character Authorization Identification Response code
|
|
3283
|
+
* sent back to the acquirer in an approved response.
|
|
3284
|
+
*/
|
|
3285
|
+
authorization_identification_response: string | null;
|
|
3286
|
+
/**
|
|
3287
|
+
* A life-cycle identifier used across e.g., an authorization and a reversal.
|
|
3288
|
+
* Expected to be unique per acquirer within a window of time. For some card
|
|
3289
|
+
* networks the retrieval reference number includes the trace counter.
|
|
3290
|
+
*/
|
|
3291
|
+
retrieval_reference_number: string | null;
|
|
3292
|
+
/**
|
|
3293
|
+
* A counter used to verify an individual authorization. Expected to be unique per
|
|
3294
|
+
* acquirer within a window of time.
|
|
3295
|
+
*/
|
|
3296
|
+
trace_number: string | null;
|
|
3297
|
+
/**
|
|
3298
|
+
* A globally unique transaction identifier provided by the card network, used
|
|
3299
|
+
* across multiple life-cycle requests.
|
|
3300
|
+
*/
|
|
3301
|
+
transaction_id: string | null;
|
|
3302
|
+
}
|
|
3303
|
+
}
|
|
3304
|
+
/**
|
|
3305
|
+
* A Card Settlement object. This field will be present in the JSON response if and
|
|
3306
|
+
* only if `category` is equal to `card_settlement`. Card Settlements are card
|
|
3307
|
+
* transactions that have cleared and settled. While a settlement is usually
|
|
3308
|
+
* preceded by an authorization, an acquirer can also directly clear a transaction
|
|
3309
|
+
* without first authorizing it.
|
|
3310
|
+
*/
|
|
3311
|
+
interface CardSettlement {
|
|
3312
|
+
/**
|
|
3313
|
+
* The Card Settlement identifier.
|
|
3314
|
+
*/
|
|
3315
|
+
id: string;
|
|
3316
|
+
/**
|
|
3317
|
+
* The amount in the minor unit of the transaction's settlement currency. For
|
|
3318
|
+
* dollars, for example, this is cents.
|
|
3319
|
+
*/
|
|
3320
|
+
amount: number;
|
|
3321
|
+
/**
|
|
3322
|
+
* The Card Authorization that was created prior to this Card Settlement, if one
|
|
3323
|
+
* exists.
|
|
3324
|
+
*/
|
|
3325
|
+
card_authorization: string | null;
|
|
3326
|
+
/**
|
|
3327
|
+
* The ID of the Card Payment this transaction belongs to.
|
|
3328
|
+
*/
|
|
3329
|
+
card_payment_id: string;
|
|
3330
|
+
/**
|
|
3331
|
+
* Cashback earned on this transaction, if eligible. Cashback is paid out in
|
|
3332
|
+
* aggregate, monthly.
|
|
3333
|
+
*/
|
|
3334
|
+
cashback: CardSettlement.Cashback | null;
|
|
3335
|
+
/**
|
|
3336
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
3337
|
+
* transaction's settlement currency.
|
|
3338
|
+
*
|
|
3339
|
+
* - `USD` - US Dollar (USD)
|
|
3340
|
+
*/
|
|
3341
|
+
currency: 'USD';
|
|
3342
|
+
/**
|
|
3343
|
+
* Interchange assessed as a part of this transaction.
|
|
3344
|
+
*/
|
|
3345
|
+
interchange: CardSettlement.Interchange | null;
|
|
3346
|
+
/**
|
|
3347
|
+
* The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
3348
|
+
* is transacting with.
|
|
3349
|
+
*/
|
|
3350
|
+
merchant_acceptor_id: string;
|
|
3351
|
+
/**
|
|
3352
|
+
* The 4-digit MCC describing the merchant's business.
|
|
3353
|
+
*/
|
|
3354
|
+
merchant_category_code: string;
|
|
3355
|
+
/**
|
|
3356
|
+
* The city the merchant resides in.
|
|
3357
|
+
*/
|
|
3358
|
+
merchant_city: string;
|
|
3359
|
+
/**
|
|
3360
|
+
* The country the merchant resides in.
|
|
3361
|
+
*/
|
|
3362
|
+
merchant_country: string;
|
|
3363
|
+
/**
|
|
3364
|
+
* The name of the merchant.
|
|
3365
|
+
*/
|
|
3366
|
+
merchant_name: string;
|
|
3367
|
+
/**
|
|
3368
|
+
* The merchant's postal code. For US merchants this is always a 5-digit ZIP code.
|
|
3369
|
+
*/
|
|
3370
|
+
merchant_postal_code: string | null;
|
|
3371
|
+
/**
|
|
3372
|
+
* The state the merchant resides in.
|
|
3373
|
+
*/
|
|
3374
|
+
merchant_state: string | null;
|
|
3375
|
+
/**
|
|
3376
|
+
* The card network on which this transaction was processed.
|
|
3377
|
+
*
|
|
3378
|
+
* - `visa` - Visa
|
|
3379
|
+
* - `pulse` - Pulse
|
|
3380
|
+
*/
|
|
3381
|
+
network: 'visa' | 'pulse';
|
|
3382
|
+
/**
|
|
3383
|
+
* Network-specific identifiers for this refund.
|
|
3384
|
+
*/
|
|
3385
|
+
network_identifiers: CardSettlement.NetworkIdentifiers;
|
|
3386
|
+
/**
|
|
3387
|
+
* The identifier of the Pending Transaction associated with this Transaction.
|
|
3388
|
+
*/
|
|
3389
|
+
pending_transaction_id: string | null;
|
|
3390
|
+
/**
|
|
3391
|
+
* The amount in the minor unit of the transaction's presentment currency.
|
|
3392
|
+
*/
|
|
3393
|
+
presentment_amount: number;
|
|
3394
|
+
/**
|
|
3395
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
3396
|
+
* transaction's presentment currency.
|
|
3397
|
+
*/
|
|
3398
|
+
presentment_currency: string;
|
|
3399
|
+
/**
|
|
3400
|
+
* Additional details about the card purchase, such as tax and industry-specific
|
|
3401
|
+
* fields.
|
|
3402
|
+
*/
|
|
3403
|
+
purchase_details: CardSettlement.PurchaseDetails | null;
|
|
3404
|
+
/**
|
|
3405
|
+
* Surcharge amount details, if applicable. The amount is positive if the surcharge
|
|
3406
|
+
* is added to to the overall transaction amount (surcharge), and negative if the
|
|
3407
|
+
* surcharge is deducted from the overall transaction amount (discount).
|
|
3408
|
+
*/
|
|
3409
|
+
surcharge: CardSettlement.Surcharge | null;
|
|
3410
|
+
/**
|
|
3411
|
+
* The identifier of the Transaction associated with this Transaction.
|
|
3412
|
+
*/
|
|
3413
|
+
transaction_id: string;
|
|
3414
|
+
/**
|
|
3415
|
+
* A constant representing the object's type. For this resource it will always be
|
|
3416
|
+
* `card_settlement`.
|
|
3417
|
+
*/
|
|
3418
|
+
type: 'card_settlement';
|
|
3419
|
+
[k: string]: unknown;
|
|
3420
|
+
}
|
|
3421
|
+
namespace CardSettlement {
|
|
3422
|
+
/**
|
|
3423
|
+
* Cashback earned on this transaction, if eligible. Cashback is paid out in
|
|
3424
|
+
* aggregate, monthly.
|
|
3425
|
+
*/
|
|
3426
|
+
interface Cashback {
|
|
3427
|
+
/**
|
|
3428
|
+
* The cashback amount given as a string containing a decimal number. The amount is
|
|
3429
|
+
* a positive number if it will be credited to you (e.g., settlements) and a
|
|
3430
|
+
* negative number if it will be debited (e.g., refunds).
|
|
3431
|
+
*/
|
|
3432
|
+
amount: string;
|
|
3433
|
+
/**
|
|
3434
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback.
|
|
3435
|
+
*
|
|
3436
|
+
* - `USD` - US Dollar (USD)
|
|
3437
|
+
*/
|
|
3438
|
+
currency: 'USD';
|
|
3439
|
+
}
|
|
3440
|
+
/**
|
|
3441
|
+
* Interchange assessed as a part of this transaction.
|
|
3442
|
+
*/
|
|
3443
|
+
interface Interchange {
|
|
3444
|
+
/**
|
|
3445
|
+
* The interchange amount given as a string containing a decimal number in major
|
|
3446
|
+
* units (so e.g., "3.14" for $3.14). The amount is a positive number if it is
|
|
3447
|
+
* credited to Increase (e.g., settlements) and a negative number if it is debited
|
|
3448
|
+
* (e.g., refunds).
|
|
3449
|
+
*/
|
|
3450
|
+
amount: string;
|
|
3451
|
+
/**
|
|
3452
|
+
* The card network specific interchange code.
|
|
3453
|
+
*/
|
|
3454
|
+
code: string | null;
|
|
3455
|
+
/**
|
|
3456
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange
|
|
3457
|
+
* reimbursement.
|
|
3458
|
+
*
|
|
3459
|
+
* - `USD` - US Dollar (USD)
|
|
3460
|
+
*/
|
|
3461
|
+
currency: 'USD';
|
|
3462
|
+
}
|
|
3463
|
+
/**
|
|
3464
|
+
* Network-specific identifiers for this refund.
|
|
3465
|
+
*/
|
|
3466
|
+
interface NetworkIdentifiers {
|
|
3467
|
+
/**
|
|
3468
|
+
* A network assigned business ID that identifies the acquirer that processed this
|
|
3469
|
+
* transaction.
|
|
3470
|
+
*/
|
|
3471
|
+
acquirer_business_id: string;
|
|
3472
|
+
/**
|
|
3473
|
+
* A globally unique identifier for this settlement.
|
|
3474
|
+
*/
|
|
3475
|
+
acquirer_reference_number: string;
|
|
3476
|
+
/**
|
|
3477
|
+
* The randomly generated 6-character Authorization Identification Response code
|
|
3478
|
+
* sent back to the acquirer in an approved response.
|
|
3479
|
+
*/
|
|
3480
|
+
authorization_identification_response: string | null;
|
|
3481
|
+
/**
|
|
3482
|
+
* A globally unique transaction identifier provided by the card network, used
|
|
3483
|
+
* across multiple life-cycle requests.
|
|
3484
|
+
*/
|
|
3485
|
+
transaction_id: string | null;
|
|
3486
|
+
}
|
|
3487
|
+
/**
|
|
3488
|
+
* Additional details about the card purchase, such as tax and industry-specific
|
|
3489
|
+
* fields.
|
|
3490
|
+
*/
|
|
3491
|
+
interface PurchaseDetails {
|
|
3492
|
+
/**
|
|
3493
|
+
* Fields specific to car rentals.
|
|
3494
|
+
*/
|
|
3495
|
+
car_rental: PurchaseDetails.CarRental | null;
|
|
3496
|
+
/**
|
|
3497
|
+
* An identifier from the merchant for the customer or consumer.
|
|
3498
|
+
*/
|
|
3499
|
+
customer_reference_identifier: string | null;
|
|
3500
|
+
/**
|
|
3501
|
+
* The state or provincial tax amount in minor units.
|
|
3502
|
+
*/
|
|
3503
|
+
local_tax_amount: number | null;
|
|
3504
|
+
/**
|
|
3505
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
|
|
3506
|
+
* assessed.
|
|
3507
|
+
*/
|
|
3508
|
+
local_tax_currency: string | null;
|
|
3509
|
+
/**
|
|
3510
|
+
* Fields specific to lodging.
|
|
3511
|
+
*/
|
|
3512
|
+
lodging: PurchaseDetails.Lodging | null;
|
|
3513
|
+
/**
|
|
3514
|
+
* The national tax amount in minor units.
|
|
3515
|
+
*/
|
|
3516
|
+
national_tax_amount: number | null;
|
|
3517
|
+
/**
|
|
3518
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
|
|
3519
|
+
* assessed.
|
|
3520
|
+
*/
|
|
3521
|
+
national_tax_currency: string | null;
|
|
3522
|
+
/**
|
|
3523
|
+
* An identifier from the merchant for the purchase to the issuer and cardholder.
|
|
3524
|
+
*/
|
|
3525
|
+
purchase_identifier: string | null;
|
|
3526
|
+
/**
|
|
3527
|
+
* The format of the purchase identifier.
|
|
3528
|
+
*
|
|
3529
|
+
* - `free_text` - Free text
|
|
3530
|
+
* - `order_number` - Order number
|
|
3531
|
+
* - `rental_agreement_number` - Rental agreement number
|
|
3532
|
+
* - `hotel_folio_number` - Hotel folio number
|
|
3533
|
+
* - `invoice_number` - Invoice number
|
|
3534
|
+
*/
|
|
3535
|
+
purchase_identifier_format: 'free_text' | 'order_number' | 'rental_agreement_number' | 'hotel_folio_number' | 'invoice_number' | null;
|
|
3536
|
+
/**
|
|
3537
|
+
* Fields specific to travel.
|
|
3538
|
+
*/
|
|
3539
|
+
travel: PurchaseDetails.Travel | null;
|
|
3540
|
+
}
|
|
3541
|
+
namespace PurchaseDetails {
|
|
3542
|
+
/**
|
|
3543
|
+
* Fields specific to car rentals.
|
|
3544
|
+
*/
|
|
3545
|
+
interface CarRental {
|
|
3546
|
+
/**
|
|
3547
|
+
* Code indicating the vehicle's class.
|
|
3548
|
+
*/
|
|
3549
|
+
car_class_code: string | null;
|
|
3550
|
+
/**
|
|
3551
|
+
* Date the customer picked up the car or, in the case of a no-show or pre-pay
|
|
3552
|
+
* transaction, the scheduled pick up date.
|
|
3553
|
+
*/
|
|
3554
|
+
checkout_date: string | null;
|
|
3555
|
+
/**
|
|
3556
|
+
* Daily rate being charged for the vehicle.
|
|
3557
|
+
*/
|
|
3558
|
+
daily_rental_rate_amount: number | null;
|
|
3559
|
+
/**
|
|
3560
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
|
|
3561
|
+
* rate.
|
|
3562
|
+
*/
|
|
3563
|
+
daily_rental_rate_currency: string | null;
|
|
3564
|
+
/**
|
|
3565
|
+
* Number of days the vehicle was rented.
|
|
3566
|
+
*/
|
|
3567
|
+
days_rented: number | null;
|
|
3568
|
+
/**
|
|
3569
|
+
* Additional charges (gas, late fee, etc.) being billed.
|
|
3570
|
+
*
|
|
3571
|
+
* - `no_extra_charge` - No extra charge
|
|
3572
|
+
* - `gas` - Gas
|
|
3573
|
+
* - `extra_mileage` - Extra mileage
|
|
3574
|
+
* - `late_return` - Late return
|
|
3575
|
+
* - `one_way_service_fee` - One way service fee
|
|
3576
|
+
* - `parking_violation` - Parking violation
|
|
3577
|
+
*/
|
|
3578
|
+
extra_charges: 'no_extra_charge' | 'gas' | 'extra_mileage' | 'late_return' | 'one_way_service_fee' | 'parking_violation' | null;
|
|
3579
|
+
/**
|
|
3580
|
+
* Fuel charges for the vehicle.
|
|
3581
|
+
*/
|
|
3582
|
+
fuel_charges_amount: number | null;
|
|
3583
|
+
/**
|
|
3584
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
|
|
3585
|
+
* assessed.
|
|
3586
|
+
*/
|
|
3587
|
+
fuel_charges_currency: string | null;
|
|
3588
|
+
/**
|
|
3589
|
+
* Any insurance being charged for the vehicle.
|
|
3590
|
+
*/
|
|
3591
|
+
insurance_charges_amount: number | null;
|
|
3592
|
+
/**
|
|
3593
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
|
|
3594
|
+
* charges assessed.
|
|
3595
|
+
*/
|
|
3596
|
+
insurance_charges_currency: string | null;
|
|
3597
|
+
/**
|
|
3598
|
+
* An indicator that the cardholder is being billed for a reserved vehicle that was
|
|
3599
|
+
* not actually rented (that is, a "no-show" charge).
|
|
3600
|
+
*
|
|
3601
|
+
* - `not_applicable` - Not applicable
|
|
3602
|
+
* - `no_show_for_specialized_vehicle` - No show for specialized vehicle
|
|
3603
|
+
*/
|
|
3604
|
+
no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
|
|
3605
|
+
/**
|
|
3606
|
+
* Charges for returning the vehicle at a different location than where it was
|
|
3607
|
+
* picked up.
|
|
3608
|
+
*/
|
|
3609
|
+
one_way_drop_off_charges_amount: number | null;
|
|
3610
|
+
/**
|
|
3611
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
|
|
3612
|
+
* drop-off charges assessed.
|
|
3613
|
+
*/
|
|
3614
|
+
one_way_drop_off_charges_currency: string | null;
|
|
3615
|
+
/**
|
|
3616
|
+
* Name of the person renting the vehicle.
|
|
3617
|
+
*/
|
|
3618
|
+
renter_name: string | null;
|
|
3619
|
+
/**
|
|
3620
|
+
* Weekly rate being charged for the vehicle.
|
|
3621
|
+
*/
|
|
3622
|
+
weekly_rental_rate_amount: number | null;
|
|
3623
|
+
/**
|
|
3624
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
|
|
3625
|
+
* rental rate.
|
|
3626
|
+
*/
|
|
3627
|
+
weekly_rental_rate_currency: string | null;
|
|
3628
|
+
}
|
|
3629
|
+
/**
|
|
3630
|
+
* Fields specific to lodging.
|
|
3631
|
+
*/
|
|
3632
|
+
interface Lodging {
|
|
3633
|
+
/**
|
|
3634
|
+
* Date the customer checked in.
|
|
3635
|
+
*/
|
|
3636
|
+
check_in_date: string | null;
|
|
3637
|
+
/**
|
|
3638
|
+
* Daily rate being charged for the room.
|
|
3639
|
+
*/
|
|
3640
|
+
daily_room_rate_amount: number | null;
|
|
3641
|
+
/**
|
|
3642
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
|
|
3643
|
+
* rate.
|
|
3644
|
+
*/
|
|
3645
|
+
daily_room_rate_currency: string | null;
|
|
3646
|
+
/**
|
|
3647
|
+
* Additional charges (phone, late check-out, etc.) being billed.
|
|
3648
|
+
*
|
|
3649
|
+
* - `no_extra_charge` - No extra charge
|
|
3650
|
+
* - `restaurant` - Restaurant
|
|
3651
|
+
* - `gift_shop` - Gift shop
|
|
3652
|
+
* - `mini_bar` - Mini bar
|
|
3653
|
+
* - `telephone` - Telephone
|
|
3654
|
+
* - `other` - Other
|
|
3655
|
+
* - `laundry` - Laundry
|
|
3656
|
+
*/
|
|
3657
|
+
extra_charges: 'no_extra_charge' | 'restaurant' | 'gift_shop' | 'mini_bar' | 'telephone' | 'other' | 'laundry' | null;
|
|
3658
|
+
/**
|
|
3659
|
+
* Folio cash advances for the room.
|
|
3660
|
+
*/
|
|
3661
|
+
folio_cash_advances_amount: number | null;
|
|
3662
|
+
/**
|
|
3663
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
|
|
3664
|
+
* advances.
|
|
3665
|
+
*/
|
|
3666
|
+
folio_cash_advances_currency: string | null;
|
|
3667
|
+
/**
|
|
3668
|
+
* Food and beverage charges for the room.
|
|
3669
|
+
*/
|
|
3670
|
+
food_beverage_charges_amount: number | null;
|
|
3671
|
+
/**
|
|
3672
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and
|
|
3673
|
+
* beverage charges.
|
|
3674
|
+
*/
|
|
3675
|
+
food_beverage_charges_currency: string | null;
|
|
3676
|
+
/**
|
|
3677
|
+
* Indicator that the cardholder is being billed for a reserved room that was not
|
|
3678
|
+
* actually used.
|
|
3679
|
+
*
|
|
3680
|
+
* - `not_applicable` - Not applicable
|
|
3681
|
+
* - `no_show` - No show
|
|
3682
|
+
*/
|
|
3683
|
+
no_show_indicator: 'not_applicable' | 'no_show' | null;
|
|
3684
|
+
/**
|
|
3685
|
+
* Prepaid expenses being charged for the room.
|
|
3686
|
+
*/
|
|
3687
|
+
prepaid_expenses_amount: number | null;
|
|
3688
|
+
/**
|
|
3689
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
|
|
3690
|
+
* expenses.
|
|
3691
|
+
*/
|
|
3692
|
+
prepaid_expenses_currency: string | null;
|
|
3693
|
+
/**
|
|
3694
|
+
* Number of nights the room was rented.
|
|
3695
|
+
*/
|
|
3696
|
+
room_nights: number | null;
|
|
3697
|
+
/**
|
|
3698
|
+
* Total room tax being charged.
|
|
3699
|
+
*/
|
|
3700
|
+
total_room_tax_amount: number | null;
|
|
3701
|
+
/**
|
|
3702
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
|
|
3703
|
+
* tax.
|
|
3704
|
+
*/
|
|
3705
|
+
total_room_tax_currency: string | null;
|
|
3706
|
+
/**
|
|
3707
|
+
* Total tax being charged for the room.
|
|
3708
|
+
*/
|
|
3709
|
+
total_tax_amount: number | null;
|
|
3710
|
+
/**
|
|
3711
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
|
|
3712
|
+
* assessed.
|
|
3713
|
+
*/
|
|
3714
|
+
total_tax_currency: string | null;
|
|
3715
|
+
}
|
|
3716
|
+
/**
|
|
3717
|
+
* Fields specific to travel.
|
|
3718
|
+
*/
|
|
3719
|
+
interface Travel {
|
|
3720
|
+
/**
|
|
3721
|
+
* Ancillary purchases in addition to the airfare.
|
|
3722
|
+
*/
|
|
3723
|
+
ancillary: Travel.Ancillary | null;
|
|
3724
|
+
/**
|
|
3725
|
+
* Indicates the computerized reservation system used to book the ticket.
|
|
3726
|
+
*/
|
|
3727
|
+
computerized_reservation_system: string | null;
|
|
3728
|
+
/**
|
|
3729
|
+
* Indicates the reason for a credit to the cardholder.
|
|
3730
|
+
*
|
|
3731
|
+
* - `no_credit` - No credit
|
|
3732
|
+
* - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
|
|
3733
|
+
* ancillary purchase cancellation
|
|
3734
|
+
* - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
|
|
3735
|
+
* Airline ticket and passenger transport ancillary purchase cancellation
|
|
3736
|
+
* - `airline_ticket_cancellation` - Airline ticket cancellation
|
|
3737
|
+
* - `other` - Other
|
|
3738
|
+
* - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
|
|
3739
|
+
*/
|
|
3740
|
+
credit_reason_indicator: 'no_credit' | 'passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_cancellation' | 'other' | 'partial_refund_of_airline_ticket' | null;
|
|
3741
|
+
/**
|
|
3742
|
+
* Date of departure.
|
|
3743
|
+
*/
|
|
3744
|
+
departure_date: string | null;
|
|
3745
|
+
/**
|
|
3746
|
+
* Code for the originating city or airport.
|
|
3747
|
+
*/
|
|
3748
|
+
origination_city_airport_code: string | null;
|
|
3749
|
+
/**
|
|
3750
|
+
* Name of the passenger.
|
|
3751
|
+
*/
|
|
3752
|
+
passenger_name: string | null;
|
|
3753
|
+
/**
|
|
3754
|
+
* Indicates whether this ticket is non-refundable.
|
|
3755
|
+
*
|
|
3756
|
+
* - `no_restrictions` - No restrictions
|
|
3757
|
+
* - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
|
|
3758
|
+
*/
|
|
3759
|
+
restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
|
|
3760
|
+
/**
|
|
3761
|
+
* Indicates why a ticket was changed.
|
|
3762
|
+
*
|
|
3763
|
+
* - `none` - None
|
|
3764
|
+
* - `change_to_existing_ticket` - Change to existing ticket
|
|
3765
|
+
* - `new_ticket` - New ticket
|
|
3766
|
+
*/
|
|
3767
|
+
ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
|
|
3768
|
+
/**
|
|
3769
|
+
* Ticket number.
|
|
3770
|
+
*/
|
|
3771
|
+
ticket_number: string | null;
|
|
3772
|
+
/**
|
|
3773
|
+
* Code for the travel agency if the ticket was issued by a travel agency.
|
|
3774
|
+
*/
|
|
3775
|
+
travel_agency_code: string | null;
|
|
3776
|
+
/**
|
|
3777
|
+
* Name of the travel agency if the ticket was issued by a travel agency.
|
|
3778
|
+
*/
|
|
3779
|
+
travel_agency_name: string | null;
|
|
3780
|
+
/**
|
|
3781
|
+
* Fields specific to each leg of the journey.
|
|
3782
|
+
*/
|
|
3783
|
+
trip_legs: Array<Travel.TripLeg> | null;
|
|
3784
|
+
}
|
|
3785
|
+
namespace Travel {
|
|
3786
|
+
/**
|
|
3787
|
+
* Ancillary purchases in addition to the airfare.
|
|
3788
|
+
*/
|
|
3789
|
+
interface Ancillary {
|
|
3790
|
+
/**
|
|
3791
|
+
* If this purchase has a connection or relationship to another purchase, such as a
|
|
3792
|
+
* baggage fee for a passenger transport ticket, this field should contain the
|
|
3793
|
+
* ticket document number for the other purchase.
|
|
3794
|
+
*/
|
|
3795
|
+
connected_ticket_document_number: string | null;
|
|
3796
|
+
/**
|
|
3797
|
+
* Indicates the reason for a credit to the cardholder.
|
|
3798
|
+
*
|
|
3799
|
+
* - `no_credit` - No credit
|
|
3800
|
+
* - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
|
|
3801
|
+
* ancillary purchase cancellation
|
|
3802
|
+
* - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
|
|
3803
|
+
* Airline ticket and passenger transport ancillary purchase cancellation
|
|
3804
|
+
* - `other` - Other
|
|
3805
|
+
*/
|
|
3806
|
+
credit_reason_indicator: 'no_credit' | 'passenger_transport_ancillary_purchase_cancellation' | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation' | 'other' | null;
|
|
3807
|
+
/**
|
|
3808
|
+
* Name of the passenger or description of the ancillary purchase.
|
|
3809
|
+
*/
|
|
3810
|
+
passenger_name_or_description: string | null;
|
|
3811
|
+
/**
|
|
3812
|
+
* Additional travel charges, such as baggage fees.
|
|
3813
|
+
*/
|
|
3814
|
+
services: Array<Ancillary.Service>;
|
|
3815
|
+
/**
|
|
3816
|
+
* Ticket document number.
|
|
3817
|
+
*/
|
|
3818
|
+
ticket_document_number: string | null;
|
|
3819
|
+
}
|
|
3820
|
+
namespace Ancillary {
|
|
3821
|
+
interface Service {
|
|
3822
|
+
/**
|
|
3823
|
+
* Category of the ancillary service.
|
|
3824
|
+
*
|
|
3825
|
+
* - `none` - None
|
|
3826
|
+
* - `bundled_service` - Bundled service
|
|
3827
|
+
* - `baggage_fee` - Baggage fee
|
|
3828
|
+
* - `change_fee` - Change fee
|
|
3829
|
+
* - `cargo` - Cargo
|
|
3830
|
+
* - `carbon_offset` - Carbon offset
|
|
3831
|
+
* - `frequent_flyer` - Frequent flyer
|
|
3832
|
+
* - `gift_card` - Gift card
|
|
3833
|
+
* - `ground_transport` - Ground transport
|
|
3834
|
+
* - `in_flight_entertainment` - In-flight entertainment
|
|
3835
|
+
* - `lounge` - Lounge
|
|
3836
|
+
* - `medical` - Medical
|
|
3837
|
+
* - `meal_beverage` - Meal beverage
|
|
3838
|
+
* - `other` - Other
|
|
3839
|
+
* - `passenger_assist_fee` - Passenger assist fee
|
|
3840
|
+
* - `pets` - Pets
|
|
3841
|
+
* - `seat_fees` - Seat fees
|
|
3842
|
+
* - `standby` - Standby
|
|
3843
|
+
* - `service_fee` - Service fee
|
|
3844
|
+
* - `store` - Store
|
|
3845
|
+
* - `travel_service` - Travel service
|
|
3846
|
+
* - `unaccompanied_travel` - Unaccompanied travel
|
|
3847
|
+
* - `upgrades` - Upgrades
|
|
3848
|
+
* - `wifi` - Wi-fi
|
|
3849
|
+
*/
|
|
3850
|
+
category: 'none' | 'bundled_service' | 'baggage_fee' | 'change_fee' | 'cargo' | 'carbon_offset' | 'frequent_flyer' | 'gift_card' | 'ground_transport' | 'in_flight_entertainment' | 'lounge' | 'medical' | 'meal_beverage' | 'other' | 'passenger_assist_fee' | 'pets' | 'seat_fees' | 'standby' | 'service_fee' | 'store' | 'travel_service' | 'unaccompanied_travel' | 'upgrades' | 'wifi' | null;
|
|
3851
|
+
/**
|
|
3852
|
+
* Sub-category of the ancillary service, free-form.
|
|
3853
|
+
*/
|
|
3854
|
+
sub_category: string | null;
|
|
3855
|
+
}
|
|
3856
|
+
}
|
|
3857
|
+
interface TripLeg {
|
|
3858
|
+
/**
|
|
3859
|
+
* Carrier code (e.g., United Airlines, Jet Blue, etc.).
|
|
3860
|
+
*/
|
|
3861
|
+
carrier_code: string | null;
|
|
3862
|
+
/**
|
|
3863
|
+
* Code for the destination city or airport.
|
|
3864
|
+
*/
|
|
3865
|
+
destination_city_airport_code: string | null;
|
|
3866
|
+
/**
|
|
3867
|
+
* Fare basis code.
|
|
3868
|
+
*/
|
|
3869
|
+
fare_basis_code: string | null;
|
|
3870
|
+
/**
|
|
3871
|
+
* Flight number.
|
|
3872
|
+
*/
|
|
3873
|
+
flight_number: string | null;
|
|
3874
|
+
/**
|
|
3875
|
+
* Service class (e.g., first class, business class, etc.).
|
|
3876
|
+
*/
|
|
3877
|
+
service_class: string | null;
|
|
3878
|
+
/**
|
|
3879
|
+
* Indicates whether a stopover is allowed on this ticket.
|
|
3880
|
+
*
|
|
3881
|
+
* - `none` - None
|
|
3882
|
+
* - `stop_over_allowed` - Stop over allowed
|
|
3883
|
+
* - `stop_over_not_allowed` - Stop over not allowed
|
|
3884
|
+
*/
|
|
3885
|
+
stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
|
|
3886
|
+
}
|
|
3887
|
+
}
|
|
3888
|
+
}
|
|
3889
|
+
/**
|
|
3890
|
+
* Surcharge amount details, if applicable. The amount is positive if the surcharge
|
|
3891
|
+
* is added to to the overall transaction amount (surcharge), and negative if the
|
|
3892
|
+
* surcharge is deducted from the overall transaction amount (discount).
|
|
3893
|
+
*/
|
|
3894
|
+
interface Surcharge {
|
|
3895
|
+
/**
|
|
3896
|
+
* The surcharge amount in the minor unit of the transaction's settlement currency.
|
|
3897
|
+
*/
|
|
3898
|
+
amount: number;
|
|
3899
|
+
/**
|
|
3900
|
+
* The surcharge amount in the minor unit of the transaction's presentment
|
|
3901
|
+
* currency.
|
|
3902
|
+
*/
|
|
3903
|
+
presentment_amount: number;
|
|
3904
|
+
}
|
|
3905
|
+
}
|
|
3906
|
+
/**
|
|
3907
|
+
* An Inbound Card Validation object. This field will be present in the JSON
|
|
3908
|
+
* response if and only if `category` is equal to `card_validation`. Inbound Card
|
|
3909
|
+
* Validations are requests from a merchant to verify that a card number and
|
|
3910
|
+
* optionally its address and/or Card Verification Value are valid.
|
|
3911
|
+
*/
|
|
3912
|
+
interface CardValidation {
|
|
3913
|
+
/**
|
|
3914
|
+
* The Card Validation identifier.
|
|
3915
|
+
*/
|
|
3916
|
+
id: string;
|
|
3917
|
+
/**
|
|
3918
|
+
* Whether this authorization was approved by Increase, the card network through
|
|
3919
|
+
* stand-in processing, or the user through a real-time decision.
|
|
3920
|
+
*
|
|
3921
|
+
* - `user` - This object was actioned by the user through a real-time decision.
|
|
3922
|
+
* - `increase` - This object was actioned by Increase without user intervention.
|
|
3923
|
+
* - `network` - This object was actioned by the network, through stand-in
|
|
3924
|
+
* processing.
|
|
3925
|
+
*/
|
|
3926
|
+
actioner: 'user' | 'increase' | 'network';
|
|
3927
|
+
/**
|
|
3928
|
+
* Additional amounts associated with the card authorization, such as ATM
|
|
3929
|
+
* surcharges fees. These are usually a subset of the `amount` field and are used
|
|
3930
|
+
* to provide more detailed information about the transaction.
|
|
3931
|
+
*/
|
|
3932
|
+
additional_amounts: CardValidation.AdditionalAmounts;
|
|
3933
|
+
/**
|
|
3934
|
+
* The ID of the Card Payment this transaction belongs to.
|
|
3935
|
+
*/
|
|
3936
|
+
card_payment_id: string;
|
|
3937
|
+
/**
|
|
3938
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
3939
|
+
* transaction's currency.
|
|
3940
|
+
*
|
|
3941
|
+
* - `USD` - US Dollar (USD)
|
|
3942
|
+
*/
|
|
3943
|
+
currency: 'USD';
|
|
3944
|
+
/**
|
|
3945
|
+
* If the authorization was made via a Digital Wallet Token (such as an Apple Pay
|
|
3946
|
+
* purchase), the identifier of the token that was used.
|
|
3947
|
+
*/
|
|
3948
|
+
digital_wallet_token_id: string | null;
|
|
3949
|
+
/**
|
|
3950
|
+
* The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
3951
|
+
* is transacting with.
|
|
3952
|
+
*/
|
|
3953
|
+
merchant_acceptor_id: string;
|
|
3954
|
+
/**
|
|
3955
|
+
* The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
|
3956
|
+
* card is transacting with.
|
|
3957
|
+
*/
|
|
3958
|
+
merchant_category_code: string;
|
|
3959
|
+
/**
|
|
3960
|
+
* The city the merchant resides in.
|
|
3961
|
+
*/
|
|
3962
|
+
merchant_city: string | null;
|
|
3963
|
+
/**
|
|
3964
|
+
* The country the merchant resides in.
|
|
3965
|
+
*/
|
|
3966
|
+
merchant_country: string;
|
|
3967
|
+
/**
|
|
3968
|
+
* The merchant descriptor of the merchant the card is transacting with.
|
|
3969
|
+
*/
|
|
3970
|
+
merchant_descriptor: string;
|
|
3971
|
+
/**
|
|
3972
|
+
* The merchant's postal code. For US merchants this is either a 5-digit or 9-digit
|
|
3973
|
+
* ZIP code, where the first 5 and last 4 are separated by a dash.
|
|
3974
|
+
*/
|
|
3975
|
+
merchant_postal_code: string | null;
|
|
3976
|
+
/**
|
|
3977
|
+
* The state the merchant resides in.
|
|
3978
|
+
*/
|
|
3979
|
+
merchant_state: string | null;
|
|
3980
|
+
/**
|
|
3981
|
+
* Fields specific to the `network`.
|
|
3982
|
+
*/
|
|
3983
|
+
network_details: CardValidation.NetworkDetails;
|
|
3984
|
+
/**
|
|
3985
|
+
* Network-specific identifiers for a specific request or transaction.
|
|
3986
|
+
*/
|
|
3987
|
+
network_identifiers: CardValidation.NetworkIdentifiers;
|
|
3988
|
+
/**
|
|
3989
|
+
* The risk score generated by the card network. For Visa this is the Visa Advanced
|
|
3990
|
+
* Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the
|
|
3991
|
+
* score is from 0 to 999, where 999 is the riskiest.
|
|
3992
|
+
*/
|
|
3993
|
+
network_risk_score: number | null;
|
|
3994
|
+
/**
|
|
3995
|
+
* If the authorization was made in-person with a physical card, the Physical Card
|
|
3996
|
+
* that was used.
|
|
3997
|
+
*/
|
|
3998
|
+
physical_card_id: string | null;
|
|
3999
|
+
/**
|
|
4000
|
+
* The identifier of the Real-Time Decision sent to approve or decline this
|
|
4001
|
+
* transaction.
|
|
4002
|
+
*/
|
|
4003
|
+
real_time_decision_id: string | null;
|
|
4004
|
+
/**
|
|
4005
|
+
* The terminal identifier (commonly abbreviated as TID) of the terminal the card
|
|
4006
|
+
* is transacting with.
|
|
4007
|
+
*/
|
|
4008
|
+
terminal_id: string | null;
|
|
4009
|
+
/**
|
|
4010
|
+
* A constant representing the object's type. For this resource it will always be
|
|
4011
|
+
* `inbound_card_validation`.
|
|
4012
|
+
*/
|
|
4013
|
+
type: 'inbound_card_validation';
|
|
4014
|
+
/**
|
|
4015
|
+
* Fields related to verification of cardholder-provided values.
|
|
4016
|
+
*/
|
|
4017
|
+
verification: CardValidation.Verification;
|
|
4018
|
+
[k: string]: unknown;
|
|
4019
|
+
}
|
|
4020
|
+
namespace CardValidation {
|
|
4021
|
+
/**
|
|
4022
|
+
* Additional amounts associated with the card authorization, such as ATM
|
|
4023
|
+
* surcharges fees. These are usually a subset of the `amount` field and are used
|
|
4024
|
+
* to provide more detailed information about the transaction.
|
|
4025
|
+
*/
|
|
4026
|
+
interface AdditionalAmounts {
|
|
4027
|
+
/**
|
|
4028
|
+
* The part of this transaction amount that was for clinic-related services.
|
|
4029
|
+
*/
|
|
4030
|
+
clinic: AdditionalAmounts.Clinic | null;
|
|
4031
|
+
/**
|
|
4032
|
+
* The part of this transaction amount that was for dental-related services.
|
|
4033
|
+
*/
|
|
4034
|
+
dental: AdditionalAmounts.Dental | null;
|
|
4035
|
+
/**
|
|
4036
|
+
* The original pre-authorized amount.
|
|
4037
|
+
*/
|
|
4038
|
+
original: AdditionalAmounts.Original | null;
|
|
4039
|
+
/**
|
|
4040
|
+
* The part of this transaction amount that was for healthcare prescriptions.
|
|
4041
|
+
*/
|
|
4042
|
+
prescription: AdditionalAmounts.Prescription | null;
|
|
4043
|
+
/**
|
|
4044
|
+
* The surcharge amount charged for this transaction by the merchant.
|
|
4045
|
+
*/
|
|
4046
|
+
surcharge: AdditionalAmounts.Surcharge | null;
|
|
4047
|
+
/**
|
|
4048
|
+
* The total amount of a series of incremental authorizations, optionally provided.
|
|
4049
|
+
*/
|
|
4050
|
+
total_cumulative: AdditionalAmounts.TotalCumulative | null;
|
|
4051
|
+
/**
|
|
4052
|
+
* The total amount of healthcare-related additional amounts.
|
|
4053
|
+
*/
|
|
4054
|
+
total_healthcare: AdditionalAmounts.TotalHealthcare | null;
|
|
4055
|
+
/**
|
|
4056
|
+
* The part of this transaction amount that was for transit-related services.
|
|
4057
|
+
*/
|
|
4058
|
+
transit: AdditionalAmounts.Transit | null;
|
|
4059
|
+
/**
|
|
4060
|
+
* An unknown additional amount.
|
|
4061
|
+
*/
|
|
4062
|
+
unknown: AdditionalAmounts.Unknown | null;
|
|
4063
|
+
/**
|
|
4064
|
+
* The part of this transaction amount that was for vision-related services.
|
|
4065
|
+
*/
|
|
4066
|
+
vision: AdditionalAmounts.Vision | null;
|
|
4067
|
+
}
|
|
4068
|
+
namespace AdditionalAmounts {
|
|
4069
|
+
/**
|
|
4070
|
+
* The part of this transaction amount that was for clinic-related services.
|
|
4071
|
+
*/
|
|
4072
|
+
interface Clinic {
|
|
4073
|
+
/**
|
|
4074
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
4075
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
4076
|
+
* subtracted from the amount (such as a discount).
|
|
4077
|
+
*/
|
|
4078
|
+
amount: number;
|
|
4079
|
+
/**
|
|
4080
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
4081
|
+
* amount's currency.
|
|
4082
|
+
*/
|
|
4083
|
+
currency: string;
|
|
4084
|
+
}
|
|
4085
|
+
/**
|
|
4086
|
+
* The part of this transaction amount that was for dental-related services.
|
|
4087
|
+
*/
|
|
4088
|
+
interface Dental {
|
|
4089
|
+
/**
|
|
4090
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
4091
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
4092
|
+
* subtracted from the amount (such as a discount).
|
|
4093
|
+
*/
|
|
4094
|
+
amount: number;
|
|
4095
|
+
/**
|
|
4096
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
4097
|
+
* amount's currency.
|
|
4098
|
+
*/
|
|
4099
|
+
currency: string;
|
|
4100
|
+
}
|
|
4101
|
+
/**
|
|
4102
|
+
* The original pre-authorized amount.
|
|
4103
|
+
*/
|
|
4104
|
+
interface Original {
|
|
4105
|
+
/**
|
|
4106
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
4107
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
4108
|
+
* subtracted from the amount (such as a discount).
|
|
4109
|
+
*/
|
|
4110
|
+
amount: number;
|
|
4111
|
+
/**
|
|
4112
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
4113
|
+
* amount's currency.
|
|
4114
|
+
*/
|
|
4115
|
+
currency: string;
|
|
4116
|
+
}
|
|
4117
|
+
/**
|
|
4118
|
+
* The part of this transaction amount that was for healthcare prescriptions.
|
|
4119
|
+
*/
|
|
4120
|
+
interface Prescription {
|
|
4121
|
+
/**
|
|
4122
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
4123
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
4124
|
+
* subtracted from the amount (such as a discount).
|
|
4125
|
+
*/
|
|
4126
|
+
amount: number;
|
|
4127
|
+
/**
|
|
4128
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
4129
|
+
* amount's currency.
|
|
4130
|
+
*/
|
|
4131
|
+
currency: string;
|
|
4132
|
+
}
|
|
4133
|
+
/**
|
|
4134
|
+
* The surcharge amount charged for this transaction by the merchant.
|
|
4135
|
+
*/
|
|
4136
|
+
interface Surcharge {
|
|
4137
|
+
/**
|
|
4138
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
4139
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
4140
|
+
* subtracted from the amount (such as a discount).
|
|
4141
|
+
*/
|
|
4142
|
+
amount: number;
|
|
4143
|
+
/**
|
|
4144
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
4145
|
+
* amount's currency.
|
|
4146
|
+
*/
|
|
4147
|
+
currency: string;
|
|
4148
|
+
}
|
|
4149
|
+
/**
|
|
4150
|
+
* The total amount of a series of incremental authorizations, optionally provided.
|
|
4151
|
+
*/
|
|
4152
|
+
interface TotalCumulative {
|
|
4153
|
+
/**
|
|
4154
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
4155
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
4156
|
+
* subtracted from the amount (such as a discount).
|
|
4157
|
+
*/
|
|
4158
|
+
amount: number;
|
|
4159
|
+
/**
|
|
4160
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
4161
|
+
* amount's currency.
|
|
4162
|
+
*/
|
|
4163
|
+
currency: string;
|
|
4164
|
+
}
|
|
4165
|
+
/**
|
|
4166
|
+
* The total amount of healthcare-related additional amounts.
|
|
4167
|
+
*/
|
|
4168
|
+
interface TotalHealthcare {
|
|
4169
|
+
/**
|
|
4170
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
4171
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
4172
|
+
* subtracted from the amount (such as a discount).
|
|
4173
|
+
*/
|
|
4174
|
+
amount: number;
|
|
4175
|
+
/**
|
|
4176
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
4177
|
+
* amount's currency.
|
|
4178
|
+
*/
|
|
4179
|
+
currency: string;
|
|
4180
|
+
}
|
|
4181
|
+
/**
|
|
4182
|
+
* The part of this transaction amount that was for transit-related services.
|
|
4183
|
+
*/
|
|
4184
|
+
interface Transit {
|
|
4185
|
+
/**
|
|
4186
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
4187
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
4188
|
+
* subtracted from the amount (such as a discount).
|
|
4189
|
+
*/
|
|
4190
|
+
amount: number;
|
|
4191
|
+
/**
|
|
4192
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
4193
|
+
* amount's currency.
|
|
4194
|
+
*/
|
|
4195
|
+
currency: string;
|
|
4196
|
+
}
|
|
4197
|
+
/**
|
|
4198
|
+
* An unknown additional amount.
|
|
4199
|
+
*/
|
|
4200
|
+
interface Unknown {
|
|
4201
|
+
/**
|
|
4202
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
4203
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
4204
|
+
* subtracted from the amount (such as a discount).
|
|
4205
|
+
*/
|
|
4206
|
+
amount: number;
|
|
4207
|
+
/**
|
|
4208
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
4209
|
+
* amount's currency.
|
|
4210
|
+
*/
|
|
4211
|
+
currency: string;
|
|
4212
|
+
}
|
|
4213
|
+
/**
|
|
4214
|
+
* The part of this transaction amount that was for vision-related services.
|
|
4215
|
+
*/
|
|
4216
|
+
interface Vision {
|
|
4217
|
+
/**
|
|
4218
|
+
* The amount in minor units of the `currency` field. The amount is positive if it
|
|
4219
|
+
* is added to the amount (such as an ATM surcharge fee) and negative if it is
|
|
4220
|
+
* subtracted from the amount (such as a discount).
|
|
4221
|
+
*/
|
|
4222
|
+
amount: number;
|
|
4223
|
+
/**
|
|
4224
|
+
* The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional
|
|
4225
|
+
* amount's currency.
|
|
4226
|
+
*/
|
|
4227
|
+
currency: string;
|
|
4228
|
+
}
|
|
4229
|
+
}
|
|
4230
|
+
/**
|
|
4231
|
+
* Fields specific to the `network`.
|
|
4232
|
+
*/
|
|
4233
|
+
interface NetworkDetails {
|
|
4234
|
+
/**
|
|
4235
|
+
* The payment network used to process this card authorization.
|
|
4236
|
+
*
|
|
4237
|
+
* - `visa` - Visa
|
|
4238
|
+
* - `pulse` - Pulse
|
|
4239
|
+
*/
|
|
4240
|
+
category: 'visa' | 'pulse';
|
|
4241
|
+
/**
|
|
4242
|
+
* Fields specific to the `pulse` network.
|
|
4243
|
+
*/
|
|
4244
|
+
pulse: NetworkDetails.Pulse | null;
|
|
4245
|
+
/**
|
|
4246
|
+
* Fields specific to the `visa` network.
|
|
4247
|
+
*/
|
|
4248
|
+
visa: NetworkDetails.Visa | null;
|
|
4249
|
+
}
|
|
4250
|
+
namespace NetworkDetails {
|
|
4251
|
+
/**
|
|
4252
|
+
* Fields specific to the `pulse` network.
|
|
4253
|
+
*/
|
|
4254
|
+
interface Pulse {
|
|
4255
|
+
}
|
|
4256
|
+
/**
|
|
4257
|
+
* Fields specific to the `visa` network.
|
|
4258
|
+
*/
|
|
4259
|
+
interface Visa {
|
|
4260
|
+
/**
|
|
4261
|
+
* For electronic commerce transactions, this identifies the level of security used
|
|
4262
|
+
* in obtaining the customer's payment credential. For mail or telephone order
|
|
4263
|
+
* transactions, identifies the type of mail or telephone order.
|
|
4264
|
+
*
|
|
4265
|
+
* - `mail_phone_order` - Single transaction of a mail/phone order: Use to indicate
|
|
4266
|
+
* that the transaction is a mail/phone order purchase, not a recurring
|
|
4267
|
+
* transaction or installment payment. For domestic transactions in the US
|
|
4268
|
+
* region, this value may also indicate one bill payment transaction in the
|
|
4269
|
+
* card-present or card-absent environments.
|
|
4270
|
+
* - `recurring` - Recurring transaction: Payment indicator used to indicate a
|
|
4271
|
+
* recurring transaction that originates from an acquirer in the US region.
|
|
4272
|
+
* - `installment` - Installment payment: Payment indicator used to indicate one
|
|
4273
|
+
* purchase of goods or services that is billed to the account in multiple
|
|
4274
|
+
* charges over a period of time agreed upon by the cardholder and merchant from
|
|
4275
|
+
* transactions that originate from an acquirer in the US region.
|
|
4276
|
+
* - `unknown_mail_phone_order` - Unknown classification: other mail order: Use to
|
|
4277
|
+
* indicate that the type of mail/telephone order is unknown.
|
|
4278
|
+
* - `secure_electronic_commerce` - Secure electronic commerce transaction: Use to
|
|
4279
|
+
* indicate that the electronic commerce transaction has been authenticated using
|
|
4280
|
+
* e.g., 3-D Secure
|
|
4281
|
+
* - `non_authenticated_security_transaction_at_3ds_capable_merchant` -
|
|
4282
|
+
* Non-authenticated security transaction at a 3-D Secure-capable merchant, and
|
|
4283
|
+
* merchant attempted to authenticate the cardholder using 3-D Secure: Use to
|
|
4284
|
+
* identify an electronic commerce transaction where the merchant attempted to
|
|
4285
|
+
* authenticate the cardholder using 3-D Secure, but was unable to complete the
|
|
4286
|
+
* authentication because the issuer or cardholder does not participate in the
|
|
4287
|
+
* 3-D Secure program.
|
|
4288
|
+
* - `non_authenticated_security_transaction` - Non-authenticated security
|
|
4289
|
+
* transaction: Use to identify an electronic commerce transaction that uses data
|
|
4290
|
+
* encryption for security however, cardholder authentication is not performed
|
|
4291
|
+
* using 3-D Secure.
|
|
4292
|
+
* - `non_secure_transaction` - Non-secure transaction: Use to identify an
|
|
4293
|
+
* electronic commerce transaction that has no data protection.
|
|
4294
|
+
*/
|
|
4295
|
+
electronic_commerce_indicator: 'mail_phone_order' | 'recurring' | 'installment' | 'unknown_mail_phone_order' | 'secure_electronic_commerce' | 'non_authenticated_security_transaction_at_3ds_capable_merchant' | 'non_authenticated_security_transaction' | 'non_secure_transaction' | null;
|
|
4296
|
+
/**
|
|
4297
|
+
* The method used to enter the cardholder's primary account number and card
|
|
4298
|
+
* expiration date.
|
|
4299
|
+
*
|
|
4300
|
+
* - `unknown` - Unknown
|
|
4301
|
+
* - `manual` - Manual key entry
|
|
4302
|
+
* - `magnetic_stripe_no_cvv` - Magnetic stripe read, without card verification
|
|
4303
|
+
* value
|
|
4304
|
+
* - `optical_code` - Optical code
|
|
4305
|
+
* - `integrated_circuit_card` - Contact chip card
|
|
4306
|
+
* - `contactless` - Contactless read of chip card
|
|
4307
|
+
* - `credential_on_file` - Transaction initiated using a credential that has
|
|
4308
|
+
* previously been stored on file
|
|
4309
|
+
* - `magnetic_stripe` - Magnetic stripe read
|
|
4310
|
+
* - `contactless_magnetic_stripe` - Contactless read of magnetic stripe data
|
|
4311
|
+
* - `integrated_circuit_card_no_cvv` - Contact chip card, without card
|
|
4312
|
+
* verification value
|
|
4313
|
+
*/
|
|
4314
|
+
point_of_service_entry_mode: 'unknown' | 'manual' | 'magnetic_stripe_no_cvv' | 'optical_code' | 'integrated_circuit_card' | 'contactless' | 'credential_on_file' | 'magnetic_stripe' | 'contactless_magnetic_stripe' | 'integrated_circuit_card_no_cvv' | null;
|
|
4315
|
+
/**
|
|
4316
|
+
* Only present when `actioner: network`. Describes why a card authorization was
|
|
4317
|
+
* approved or declined by Visa through stand-in processing.
|
|
4318
|
+
*
|
|
4319
|
+
* - `issuer_error` - Increase failed to process the authorization in a timely
|
|
4320
|
+
* manner.
|
|
4321
|
+
* - `invalid_physical_card` - The physical card read had an invalid CVV, dCVV, or
|
|
4322
|
+
* authorization request cryptogram.
|
|
4323
|
+
* - `invalid_cardholder_authentication_verification_value` - The 3DS cardholder
|
|
4324
|
+
* authentication verification value was invalid.
|
|
4325
|
+
* - `internal_visa_error` - An internal Visa error occurred. Visa uses this reason
|
|
4326
|
+
* code for certain expected occurrences as well, such as Application Transaction
|
|
4327
|
+
* Counter (ATC) replays.
|
|
4328
|
+
* - `merchant_transaction_advisory_service_authentication_required` - The merchant
|
|
4329
|
+
* has enabled Visa's Transaction Advisory Service and requires further
|
|
4330
|
+
* authentication to perform the transaction. In practice this is often utilized
|
|
4331
|
+
* at fuel pumps to tell the cardholder to see the cashier.
|
|
4332
|
+
* - `payment_fraud_disruption_acquirer_block` - The transaction was blocked by
|
|
4333
|
+
* Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior,
|
|
4334
|
+
* such as card testing.
|
|
4335
|
+
* - `other` - An unspecific reason for stand-in processing.
|
|
4336
|
+
*/
|
|
4337
|
+
stand_in_processing_reason: 'issuer_error' | 'invalid_physical_card' | 'invalid_cardholder_authentication_verification_value' | 'internal_visa_error' | 'merchant_transaction_advisory_service_authentication_required' | 'payment_fraud_disruption_acquirer_block' | 'other' | null;
|
|
4338
|
+
}
|
|
4339
|
+
}
|
|
4340
|
+
/**
|
|
4341
|
+
* Network-specific identifiers for a specific request or transaction.
|
|
4342
|
+
*/
|
|
4343
|
+
interface NetworkIdentifiers {
|
|
4344
|
+
/**
|
|
4345
|
+
* The randomly generated 6-character Authorization Identification Response code
|
|
4346
|
+
* sent back to the acquirer in an approved response.
|
|
4347
|
+
*/
|
|
4348
|
+
authorization_identification_response: string | null;
|
|
4349
|
+
/**
|
|
4350
|
+
* A life-cycle identifier used across e.g., an authorization and a reversal.
|
|
4351
|
+
* Expected to be unique per acquirer within a window of time. For some card
|
|
4352
|
+
* networks the retrieval reference number includes the trace counter.
|
|
4353
|
+
*/
|
|
4354
|
+
retrieval_reference_number: string | null;
|
|
4355
|
+
/**
|
|
4356
|
+
* A counter used to verify an individual authorization. Expected to be unique per
|
|
4357
|
+
* acquirer within a window of time.
|
|
4358
|
+
*/
|
|
4359
|
+
trace_number: string | null;
|
|
4360
|
+
/**
|
|
4361
|
+
* A globally unique transaction identifier provided by the card network, used
|
|
4362
|
+
* across multiple life-cycle requests.
|
|
4363
|
+
*/
|
|
4364
|
+
transaction_id: string | null;
|
|
4365
|
+
}
|
|
4366
|
+
/**
|
|
4367
|
+
* Fields related to verification of cardholder-provided values.
|
|
4368
|
+
*/
|
|
4369
|
+
interface Verification {
|
|
4370
|
+
/**
|
|
4371
|
+
* Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
4372
|
+
* the back of the card.
|
|
4373
|
+
*/
|
|
4374
|
+
card_verification_code: Verification.CardVerificationCode;
|
|
4375
|
+
/**
|
|
4376
|
+
* Cardholder address provided in the authorization request and the address on file
|
|
4377
|
+
* we verified it against.
|
|
4378
|
+
*/
|
|
4379
|
+
cardholder_address: Verification.CardholderAddress;
|
|
4380
|
+
}
|
|
4381
|
+
namespace Verification {
|
|
4382
|
+
/**
|
|
4383
|
+
* Fields related to verification of the Card Verification Code, a 3-digit code on
|
|
4384
|
+
* the back of the card.
|
|
4385
|
+
*/
|
|
4386
|
+
interface CardVerificationCode {
|
|
4387
|
+
/**
|
|
4388
|
+
* The result of verifying the Card Verification Code.
|
|
4389
|
+
*
|
|
4390
|
+
* - `not_checked` - No card verification code was provided in the authorization
|
|
4391
|
+
* request.
|
|
4392
|
+
* - `match` - The card verification code matched the one on file.
|
|
4393
|
+
* - `no_match` - The card verification code did not match the one on file.
|
|
4394
|
+
*/
|
|
4395
|
+
result: 'not_checked' | 'match' | 'no_match';
|
|
4396
|
+
}
|
|
4397
|
+
/**
|
|
4398
|
+
* Cardholder address provided in the authorization request and the address on file
|
|
4399
|
+
* we verified it against.
|
|
4400
|
+
*/
|
|
4401
|
+
interface CardholderAddress {
|
|
4402
|
+
/**
|
|
4403
|
+
* Line 1 of the address on file for the cardholder.
|
|
4404
|
+
*/
|
|
4405
|
+
actual_line1: string | null;
|
|
4406
|
+
/**
|
|
4407
|
+
* The postal code of the address on file for the cardholder.
|
|
4408
|
+
*/
|
|
4409
|
+
actual_postal_code: string | null;
|
|
4410
|
+
/**
|
|
4411
|
+
* The cardholder address line 1 provided for verification in the authorization
|
|
4412
|
+
* request.
|
|
4413
|
+
*/
|
|
4414
|
+
provided_line1: string | null;
|
|
4415
|
+
/**
|
|
4416
|
+
* The postal code provided for verification in the authorization request.
|
|
4417
|
+
*/
|
|
4418
|
+
provided_postal_code: string | null;
|
|
4419
|
+
/**
|
|
4420
|
+
* The address verification result returned to the card network.
|
|
4421
|
+
*
|
|
4422
|
+
* - `not_checked` - No address information was provided in the authorization
|
|
4423
|
+
* request.
|
|
4424
|
+
* - `postal_code_match_address_no_match` - Postal code matches, but the street
|
|
4425
|
+
* address does not match or was not provided.
|
|
4426
|
+
* - `postal_code_no_match_address_match` - Postal code does not match, but the
|
|
4427
|
+
* street address matches or was not provided.
|
|
4428
|
+
* - `match` - Postal code and street address match.
|
|
4429
|
+
* - `no_match` - Postal code and street address do not match.
|
|
4430
|
+
* - `postal_code_match_address_not_checked` - Postal code matches, but the street
|
|
4431
|
+
* address was not verified. (deprecated)
|
|
4432
|
+
*/
|
|
4433
|
+
result: 'not_checked' | 'postal_code_match_address_no_match' | 'postal_code_no_match_address_match' | 'match' | 'no_match' | 'postal_code_match_address_not_checked';
|
|
4434
|
+
}
|
|
4435
|
+
}
|
|
4436
|
+
}
|
|
4437
|
+
/**
|
|
4438
|
+
* If the category of this Transaction source is equal to `other`, this field will
|
|
4439
|
+
* contain an empty object, otherwise it will contain null.
|
|
4440
|
+
*/
|
|
4441
|
+
interface Other {
|
|
4442
|
+
}
|
|
4443
|
+
}
|
|
4444
|
+
/**
|
|
4445
|
+
* The summarized state of this card payment.
|
|
4446
|
+
*/
|
|
4447
|
+
interface State {
|
|
4448
|
+
/**
|
|
4449
|
+
* The total authorized amount in the minor unit of the transaction's currency. For
|
|
4450
|
+
* dollars, for example, this is cents.
|
|
4451
|
+
*/
|
|
4452
|
+
authorized_amount: number;
|
|
4453
|
+
/**
|
|
4454
|
+
* The total amount from fuel confirmations in the minor unit of the transaction's
|
|
4455
|
+
* currency. For dollars, for example, this is cents.
|
|
4456
|
+
*/
|
|
4457
|
+
fuel_confirmed_amount: number;
|
|
4458
|
+
/**
|
|
4459
|
+
* The total incrementally updated authorized amount in the minor unit of the
|
|
4460
|
+
* transaction's currency. For dollars, for example, this is cents.
|
|
4461
|
+
*/
|
|
4462
|
+
incremented_amount: number;
|
|
4463
|
+
/**
|
|
4464
|
+
* The total refund authorized amount in the minor unit of the transaction's
|
|
4465
|
+
* currency. For dollars, for example, this is cents.
|
|
4466
|
+
*/
|
|
4467
|
+
refund_authorized_amount: number;
|
|
4468
|
+
/**
|
|
4469
|
+
* The total refunded amount in the minor unit of the transaction's currency. For
|
|
4470
|
+
* dollars, for example, this is cents.
|
|
4471
|
+
*/
|
|
4472
|
+
refunded_amount: number;
|
|
4473
|
+
/**
|
|
4474
|
+
* The total reversed amount in the minor unit of the transaction's currency. For
|
|
4475
|
+
* dollars, for example, this is cents.
|
|
4476
|
+
*/
|
|
4477
|
+
reversed_amount: number;
|
|
4478
|
+
/**
|
|
4479
|
+
* The total settled amount in the minor unit of the transaction's currency. For
|
|
4480
|
+
* dollars, for example, this is cents.
|
|
4481
|
+
*/
|
|
4482
|
+
settled_amount: number;
|
|
4483
|
+
}
|
|
4484
|
+
}
|
|
4485
|
+
export interface CardPaymentListParams extends PageParams {
|
|
4486
|
+
/**
|
|
4487
|
+
* Filter Card Payments to ones belonging to the specified Account.
|
|
4488
|
+
*/
|
|
4489
|
+
account_id?: string;
|
|
4490
|
+
/**
|
|
4491
|
+
* Filter Card Payments to ones belonging to the specified Card.
|
|
4492
|
+
*/
|
|
4493
|
+
card_id?: string;
|
|
4494
|
+
created_at?: CardPaymentListParams.CreatedAt;
|
|
4495
|
+
}
|
|
4496
|
+
export declare namespace CardPaymentListParams {
|
|
4497
|
+
interface CreatedAt {
|
|
4498
|
+
/**
|
|
4499
|
+
* Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
4500
|
+
* timestamp.
|
|
4501
|
+
*/
|
|
4502
|
+
after?: string;
|
|
4503
|
+
/**
|
|
4504
|
+
* Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
4505
|
+
* timestamp.
|
|
4506
|
+
*/
|
|
4507
|
+
before?: string;
|
|
4508
|
+
/**
|
|
4509
|
+
* Return results on or after this
|
|
4510
|
+
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
4511
|
+
*/
|
|
4512
|
+
on_or_after?: string;
|
|
4513
|
+
/**
|
|
4514
|
+
* Return results on or before this
|
|
4515
|
+
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
4516
|
+
*/
|
|
4517
|
+
on_or_before?: string;
|
|
4518
|
+
}
|
|
4519
|
+
}
|
|
4520
|
+
export declare namespace CardPayments {
|
|
4521
|
+
export { type CardPayment as CardPayment, type CardPaymentsPage as CardPaymentsPage, type CardPaymentListParams as CardPaymentListParams, };
|
|
4522
|
+
}
|
|
4523
|
+
//# sourceMappingURL=card-payments.d.mts.map
|