increase 0.8.0 → 0.9.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.
Files changed (336) hide show
  1. package/CHANGELOG.md +63 -0
  2. package/README.md +37 -13
  3. package/_shims/ReadableStream.d.ts +38 -0
  4. package/_shims/ReadableStream.js +5 -0
  5. package/_shims/ReadableStream.mjs +7 -0
  6. package/_shims/ReadableStream.node.d.ts +6 -0
  7. package/_shims/ReadableStream.node.d.ts.map +1 -0
  8. package/_shims/ReadableStream.node.js +14 -0
  9. package/_shims/ReadableStream.node.js.map +1 -0
  10. package/_shims/ReadableStream.node.mjs +3 -0
  11. package/_shims/ReadableStream.node.mjs.map +1 -0
  12. package/_shims/fetch.d.ts +8 -1
  13. package/_shims/fetch.node.d.ts +11 -1
  14. package/core.d.ts +85 -27
  15. package/core.d.ts.map +1 -1
  16. package/core.js +208 -51
  17. package/core.js.map +1 -1
  18. package/core.mjs +194 -51
  19. package/core.mjs.map +1 -1
  20. package/error.d.ts +1 -0
  21. package/error.d.ts.map +1 -1
  22. package/error.js +12 -3
  23. package/error.js.map +1 -1
  24. package/error.mjs +12 -3
  25. package/error.mjs.map +1 -1
  26. package/index.d.mts +6 -1
  27. package/index.d.ts +6 -1
  28. package/index.d.ts.map +1 -1
  29. package/index.js +11 -8
  30. package/index.js.map +1 -1
  31. package/index.mjs +11 -8
  32. package/index.mjs.map +1 -1
  33. package/package.json +1 -1
  34. package/pagination.d.ts +2 -2
  35. package/pagination.d.ts.map +1 -1
  36. package/pagination.js +4 -4
  37. package/pagination.js.map +1 -1
  38. package/pagination.mjs +4 -4
  39. package/pagination.mjs.map +1 -1
  40. package/resources/account-numbers.d.ts +8 -8
  41. package/resources/account-numbers.d.ts.map +1 -1
  42. package/resources/account-numbers.js.map +1 -1
  43. package/resources/account-numbers.mjs.map +1 -1
  44. package/resources/account-statements.d.ts +3 -6
  45. package/resources/account-statements.d.ts.map +1 -1
  46. package/resources/account-statements.js.map +1 -1
  47. package/resources/account-statements.mjs.map +1 -1
  48. package/resources/account-transfers.d.ts +6 -18
  49. package/resources/account-transfers.d.ts.map +1 -1
  50. package/resources/account-transfers.js.map +1 -1
  51. package/resources/account-transfers.mjs.map +1 -1
  52. package/resources/accounts.d.ts +6 -6
  53. package/resources/accounts.d.ts.map +1 -1
  54. package/resources/ach-prenotifications.d.ts +51 -7
  55. package/resources/ach-prenotifications.d.ts.map +1 -1
  56. package/resources/ach-prenotifications.js.map +1 -1
  57. package/resources/ach-prenotifications.mjs.map +1 -1
  58. package/resources/ach-transfers.d.ts +16 -9
  59. package/resources/ach-transfers.d.ts.map +1 -1
  60. package/resources/ach-transfers.js.map +1 -1
  61. package/resources/ach-transfers.mjs.map +1 -1
  62. package/resources/balance-lookups.d.ts +1 -1
  63. package/resources/balance-lookups.d.ts.map +1 -1
  64. package/resources/bookkeeping-accounts.d.ts +3 -3
  65. package/resources/bookkeeping-accounts.d.ts.map +1 -1
  66. package/resources/bookkeeping-entries.d.ts +2 -2
  67. package/resources/bookkeeping-entries.d.ts.map +1 -1
  68. package/resources/bookkeeping-entry-sets.d.ts +1 -1
  69. package/resources/bookkeeping-entry-sets.d.ts.map +1 -1
  70. package/resources/card-disputes.d.ts +7 -7
  71. package/resources/card-disputes.d.ts.map +1 -1
  72. package/resources/card-disputes.js.map +1 -1
  73. package/resources/card-disputes.mjs.map +1 -1
  74. package/resources/card-profiles.d.ts +32 -11
  75. package/resources/card-profiles.d.ts.map +1 -1
  76. package/resources/card-profiles.js +6 -0
  77. package/resources/card-profiles.js.map +1 -1
  78. package/resources/card-profiles.mjs +6 -0
  79. package/resources/card-profiles.mjs.map +1 -1
  80. package/resources/card-purchase-supplements.d.ts +270 -0
  81. package/resources/card-purchase-supplements.d.ts.map +1 -0
  82. package/resources/card-purchase-supplements.js +28 -0
  83. package/resources/card-purchase-supplements.js.map +1 -0
  84. package/resources/card-purchase-supplements.mjs +21 -0
  85. package/resources/card-purchase-supplements.mjs.map +1 -0
  86. package/resources/cards.d.ts +6 -13
  87. package/resources/cards.d.ts.map +1 -1
  88. package/resources/cards.js.map +1 -1
  89. package/resources/cards.mjs.map +1 -1
  90. package/resources/check-deposits.d.ts +7 -7
  91. package/resources/check-deposits.d.ts.map +1 -1
  92. package/resources/check-deposits.js.map +1 -1
  93. package/resources/check-deposits.mjs.map +1 -1
  94. package/resources/check-transfers.d.ts +18 -11
  95. package/resources/check-transfers.d.ts.map +1 -1
  96. package/resources/check-transfers.js.map +1 -1
  97. package/resources/check-transfers.mjs.map +1 -1
  98. package/resources/declined-transactions.d.ts +25 -28
  99. package/resources/declined-transactions.d.ts.map +1 -1
  100. package/resources/declined-transactions.js.map +1 -1
  101. package/resources/declined-transactions.mjs.map +1 -1
  102. package/resources/digital-wallet-tokens.d.ts +3 -6
  103. package/resources/digital-wallet-tokens.d.ts.map +1 -1
  104. package/resources/digital-wallet-tokens.js.map +1 -1
  105. package/resources/digital-wallet-tokens.mjs.map +1 -1
  106. package/resources/documents.d.ts +3 -3
  107. package/resources/documents.d.ts.map +1 -1
  108. package/resources/entities/beneficial-owners.d.ts +215 -0
  109. package/resources/entities/beneficial-owners.d.ts.map +1 -0
  110. package/resources/entities/beneficial-owners.js +18 -0
  111. package/resources/entities/beneficial-owners.js.map +1 -0
  112. package/resources/entities/beneficial-owners.mjs +12 -0
  113. package/resources/entities/beneficial-owners.mjs.map +1 -0
  114. package/resources/entities/entities.d.ts +15 -11
  115. package/resources/entities/entities.d.ts.map +1 -1
  116. package/resources/entities/entities.js +9 -0
  117. package/resources/entities/entities.js.map +1 -1
  118. package/resources/entities/entities.mjs +9 -0
  119. package/resources/entities/entities.mjs.map +1 -1
  120. package/resources/entities/index.d.ts +1 -0
  121. package/resources/entities/index.d.ts.map +1 -1
  122. package/resources/entities/index.js +8 -0
  123. package/resources/entities/index.js.map +1 -1
  124. package/resources/entities/index.mjs +1 -0
  125. package/resources/entities/index.mjs.map +1 -1
  126. package/resources/entities/supplemental-documents.d.ts +2 -2
  127. package/resources/entities/supplemental-documents.d.ts.map +1 -1
  128. package/resources/event-subscriptions.d.ts +5 -8
  129. package/resources/event-subscriptions.d.ts.map +1 -1
  130. package/resources/event-subscriptions.js.map +1 -1
  131. package/resources/event-subscriptions.mjs.map +1 -1
  132. package/resources/events.d.ts +7 -5
  133. package/resources/events.d.ts.map +1 -1
  134. package/resources/events.js.map +1 -1
  135. package/resources/events.mjs.map +1 -1
  136. package/resources/exports.d.ts +4 -4
  137. package/resources/exports.d.ts.map +1 -1
  138. package/resources/external-accounts.d.ts +5 -11
  139. package/resources/external-accounts.d.ts.map +1 -1
  140. package/resources/external-accounts.js.map +1 -1
  141. package/resources/external-accounts.mjs.map +1 -1
  142. package/resources/files.d.ts +9 -4
  143. package/resources/files.d.ts.map +1 -1
  144. package/resources/files.js +2 -2
  145. package/resources/files.js.map +1 -1
  146. package/resources/files.mjs +2 -2
  147. package/resources/files.mjs.map +1 -1
  148. package/resources/groups.d.ts +1 -1
  149. package/resources/groups.d.ts.map +1 -1
  150. package/resources/inbound-ach-transfer-returns.d.ts +6 -4
  151. package/resources/inbound-ach-transfer-returns.d.ts.map +1 -1
  152. package/resources/inbound-ach-transfer-returns.js.map +1 -1
  153. package/resources/inbound-ach-transfer-returns.mjs.map +1 -1
  154. package/resources/inbound-wire-drawdown-requests.d.ts +5 -3
  155. package/resources/inbound-wire-drawdown-requests.d.ts.map +1 -1
  156. package/resources/inbound-wire-drawdown-requests.js.map +1 -1
  157. package/resources/inbound-wire-drawdown-requests.mjs.map +1 -1
  158. package/resources/index.d.ts +6 -0
  159. package/resources/index.d.ts.map +1 -1
  160. package/resources/index.js +18 -3
  161. package/resources/index.js.map +1 -1
  162. package/resources/index.mjs +1 -0
  163. package/resources/index.mjs.map +1 -1
  164. package/resources/limits.d.ts +5 -9
  165. package/resources/limits.d.ts.map +1 -1
  166. package/resources/limits.js.map +1 -1
  167. package/resources/limits.mjs.map +1 -1
  168. package/resources/oauth-connections.d.ts +3 -6
  169. package/resources/oauth-connections.d.ts.map +1 -1
  170. package/resources/oauth-connections.js.map +1 -1
  171. package/resources/oauth-connections.mjs.map +1 -1
  172. package/resources/pending-transactions.d.ts +32 -37
  173. package/resources/pending-transactions.d.ts.map +1 -1
  174. package/resources/pending-transactions.js.map +1 -1
  175. package/resources/pending-transactions.mjs.map +1 -1
  176. package/resources/programs.d.ts +3 -3
  177. package/resources/programs.d.ts.map +1 -1
  178. package/resources/real-time-decisions.d.ts +2 -5
  179. package/resources/real-time-decisions.d.ts.map +1 -1
  180. package/resources/real-time-decisions.js.map +1 -1
  181. package/resources/real-time-decisions.mjs.map +1 -1
  182. package/resources/real-time-payments-transfers.d.ts +6 -4
  183. package/resources/real-time-payments-transfers.d.ts.map +1 -1
  184. package/resources/real-time-payments-transfers.js.map +1 -1
  185. package/resources/real-time-payments-transfers.mjs.map +1 -1
  186. package/resources/routing-numbers.d.ts +4 -1
  187. package/resources/routing-numbers.d.ts.map +1 -1
  188. package/resources/routing-numbers.js.map +1 -1
  189. package/resources/routing-numbers.mjs.map +1 -1
  190. package/resources/simulations/account-statements.d.ts +1 -1
  191. package/resources/simulations/account-statements.d.ts.map +1 -1
  192. package/resources/simulations/account-transfers.d.ts +1 -1
  193. package/resources/simulations/account-transfers.d.ts.map +1 -1
  194. package/resources/simulations/ach-transfers.d.ts +1063 -157
  195. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  196. package/resources/simulations/ach-transfers.js.map +1 -1
  197. package/resources/simulations/ach-transfers.mjs.map +1 -1
  198. package/resources/simulations/card-disputes.d.ts +1 -1
  199. package/resources/simulations/card-disputes.d.ts.map +1 -1
  200. package/resources/simulations/card-profiles.d.ts +1 -4
  201. package/resources/simulations/card-profiles.d.ts.map +1 -1
  202. package/resources/simulations/card-profiles.js.map +1 -1
  203. package/resources/simulations/card-profiles.mjs.map +1 -1
  204. package/resources/simulations/card-refunds.d.ts +1 -1
  205. package/resources/simulations/card-refunds.d.ts.map +1 -1
  206. package/resources/simulations/cards.d.ts +53 -58
  207. package/resources/simulations/cards.d.ts.map +1 -1
  208. package/resources/simulations/cards.js.map +1 -1
  209. package/resources/simulations/cards.mjs.map +1 -1
  210. package/resources/simulations/check-deposits.d.ts +3 -12
  211. package/resources/simulations/check-deposits.d.ts.map +1 -1
  212. package/resources/simulations/check-transfers.d.ts +2 -2
  213. package/resources/simulations/check-transfers.d.ts.map +1 -1
  214. package/resources/simulations/digital-wallet-token-requests.d.ts +1 -1
  215. package/resources/simulations/digital-wallet-token-requests.d.ts.map +1 -1
  216. package/resources/simulations/documents.d.ts +1 -4
  217. package/resources/simulations/documents.d.ts.map +1 -1
  218. package/resources/simulations/documents.js.map +1 -1
  219. package/resources/simulations/documents.mjs.map +1 -1
  220. package/resources/simulations/inbound-funds-holds.d.ts +5 -1
  221. package/resources/simulations/inbound-funds-holds.d.ts.map +1 -1
  222. package/resources/simulations/inbound-funds-holds.js.map +1 -1
  223. package/resources/simulations/inbound-funds-holds.mjs.map +1 -1
  224. package/resources/simulations/inbound-wire-drawdown-requests.d.ts +1 -1
  225. package/resources/simulations/inbound-wire-drawdown-requests.d.ts.map +1 -1
  226. package/resources/simulations/interest-payments.d.ts +1047 -127
  227. package/resources/simulations/interest-payments.d.ts.map +1 -1
  228. package/resources/simulations/interest-payments.js.map +1 -1
  229. package/resources/simulations/interest-payments.mjs.map +1 -1
  230. package/resources/simulations/programs.d.ts +1 -4
  231. package/resources/simulations/programs.d.ts.map +1 -1
  232. package/resources/simulations/programs.js.map +1 -1
  233. package/resources/simulations/programs.mjs.map +1 -1
  234. package/resources/simulations/real-time-payments-transfers.d.ts +1062 -153
  235. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  236. package/resources/simulations/real-time-payments-transfers.js.map +1 -1
  237. package/resources/simulations/real-time-payments-transfers.mjs.map +1 -1
  238. package/resources/simulations/simulations.d.ts.map +1 -1
  239. package/resources/simulations/simulations.js.map +1 -1
  240. package/resources/simulations/wire-transfers.d.ts +1039 -127
  241. package/resources/simulations/wire-transfers.d.ts.map +1 -1
  242. package/resources/simulations/wire-transfers.js.map +1 -1
  243. package/resources/simulations/wire-transfers.mjs.map +1 -1
  244. package/resources/transactions.d.ts +1044 -130
  245. package/resources/transactions.d.ts.map +1 -1
  246. package/resources/transactions.js.map +1 -1
  247. package/resources/transactions.mjs.map +1 -1
  248. package/resources/wire-drawdown-requests.d.ts +4 -4
  249. package/resources/wire-drawdown-requests.d.ts.map +1 -1
  250. package/resources/wire-transfers.d.ts +11 -11
  251. package/resources/wire-transfers.d.ts.map +1 -1
  252. package/resources/wire-transfers.js.map +1 -1
  253. package/resources/wire-transfers.mjs.map +1 -1
  254. package/src/_shims/ReadableStream.d.ts +38 -0
  255. package/src/_shims/ReadableStream.js +5 -0
  256. package/src/_shims/ReadableStream.mjs +7 -0
  257. package/src/_shims/ReadableStream.node.ts +6 -0
  258. package/src/_shims/fetch.d.ts +8 -1
  259. package/src/_shims/fetch.deno.ts +23 -0
  260. package/src/_shims/fetch.node.d.ts +11 -1
  261. package/src/_shims/formdata.deno.ts +16 -0
  262. package/src/core.ts +270 -74
  263. package/src/error.ts +11 -1
  264. package/src/index.ts +16 -9
  265. package/src/pagination.ts +5 -5
  266. package/src/resources/account-numbers.ts +10 -10
  267. package/src/resources/account-statements.ts +5 -8
  268. package/src/resources/account-transfers.ts +8 -20
  269. package/src/resources/accounts.ts +8 -8
  270. package/src/resources/ach-prenotifications.ts +57 -9
  271. package/src/resources/ach-transfers.ts +19 -11
  272. package/src/resources/balance-lookups.ts +2 -2
  273. package/src/resources/bookkeeping-accounts.ts +5 -5
  274. package/src/resources/bookkeeping-entries.ts +4 -4
  275. package/src/resources/bookkeeping-entry-sets.ts +2 -2
  276. package/src/resources/card-disputes.ts +9 -9
  277. package/src/resources/card-profiles.ts +39 -13
  278. package/src/resources/card-purchase-supplements.ts +331 -0
  279. package/src/resources/cards.ts +8 -15
  280. package/src/resources/check-deposits.ts +9 -9
  281. package/src/resources/check-transfers.ts +21 -13
  282. package/src/resources/declined-transactions.ts +27 -30
  283. package/src/resources/digital-wallet-tokens.ts +5 -8
  284. package/src/resources/documents.ts +5 -5
  285. package/src/resources/entities/beneficial-owners.ts +251 -0
  286. package/src/resources/entities/entities.ts +21 -13
  287. package/src/resources/entities/index.ts +1 -0
  288. package/src/resources/entities/supplemental-documents.ts +3 -3
  289. package/src/resources/event-subscriptions.ts +7 -10
  290. package/src/resources/events.ts +9 -7
  291. package/src/resources/exports.ts +6 -6
  292. package/src/resources/external-accounts.ts +7 -13
  293. package/src/resources/files.ts +12 -7
  294. package/src/resources/groups.ts +2 -2
  295. package/src/resources/inbound-ach-transfer-returns.ts +8 -6
  296. package/src/resources/inbound-wire-drawdown-requests.ts +7 -5
  297. package/src/resources/index.ts +6 -0
  298. package/src/resources/limits.ts +7 -11
  299. package/src/resources/oauth-connections.ts +5 -8
  300. package/src/resources/pending-transactions.ts +35 -39
  301. package/src/resources/programs.ts +5 -5
  302. package/src/resources/real-time-decisions.ts +3 -6
  303. package/src/resources/real-time-payments-transfers.ts +8 -6
  304. package/src/resources/routing-numbers.ts +5 -2
  305. package/src/resources/simulations/account-statements.ts +2 -2
  306. package/src/resources/simulations/account-transfers.ts +1 -1
  307. package/src/resources/simulations/ach-transfers.ts +1200 -160
  308. package/src/resources/simulations/card-disputes.ts +2 -2
  309. package/src/resources/simulations/card-profiles.ts +1 -4
  310. package/src/resources/simulations/card-refunds.ts +2 -2
  311. package/src/resources/simulations/cards.ts +55 -59
  312. package/src/resources/simulations/check-deposits.ts +3 -3
  313. package/src/resources/simulations/check-transfers.ts +2 -2
  314. package/src/resources/simulations/digital-wallet-token-requests.ts +2 -2
  315. package/src/resources/simulations/documents.ts +2 -5
  316. package/src/resources/simulations/inbound-funds-holds.ts +7 -2
  317. package/src/resources/simulations/inbound-wire-drawdown-requests.ts +2 -2
  318. package/src/resources/simulations/interest-payments.ts +1186 -130
  319. package/src/resources/simulations/programs.ts +2 -5
  320. package/src/resources/simulations/real-time-payments-transfers.ts +1199 -156
  321. package/src/resources/simulations/simulations.ts +1 -1
  322. package/src/resources/simulations/wire-transfers.ts +1176 -130
  323. package/src/resources/transactions.ts +1182 -134
  324. package/src/resources/wire-drawdown-requests.ts +6 -6
  325. package/src/resources/wire-transfers.ts +13 -13
  326. package/src/uploads.ts +7 -6
  327. package/src/version.ts +1 -1
  328. package/uploads.d.ts +5 -4
  329. package/uploads.d.ts.map +1 -1
  330. package/uploads.js +2 -2
  331. package/uploads.js.map +1 -1
  332. package/uploads.mjs +2 -2
  333. package/uploads.mjs.map +1 -1
  334. package/version.d.ts +1 -1
  335. package/version.js +1 -1
  336. package/version.mjs +1 -1
@@ -3,26 +3,29 @@
3
3
  import * as Core from '../core';
4
4
  import { APIResource } from '../resource';
5
5
  import { isRequestOptions } from '../core';
6
- import * as API from '.';
6
+ import * as API from './index';
7
7
  import { Page, PageParams } from '../pagination';
8
8
 
9
9
  export class Transactions extends APIResource {
10
10
  /**
11
11
  * Retrieve a Transaction
12
12
  */
13
- retrieve(transactionId: string, options?: Core.RequestOptions): Promise<Core.APIResponse<Transaction>> {
13
+ retrieve(transactionId: string, options?: Core.RequestOptions): Core.APIPromise<Transaction> {
14
14
  return this.get(`/transactions/${transactionId}`, options);
15
15
  }
16
16
 
17
17
  /**
18
18
  * List Transactions
19
19
  */
20
- list(query?: TransactionListParams, options?: Core.RequestOptions): Core.PagePromise<TransactionsPage>;
21
- list(options?: Core.RequestOptions): Core.PagePromise<TransactionsPage>;
20
+ list(
21
+ query?: TransactionListParams,
22
+ options?: Core.RequestOptions,
23
+ ): Core.PagePromise<TransactionsPage, Transaction>;
24
+ list(options?: Core.RequestOptions): Core.PagePromise<TransactionsPage, Transaction>;
22
25
  list(
23
26
  query: TransactionListParams | Core.RequestOptions = {},
24
27
  options?: Core.RequestOptions,
25
- ): Core.PagePromise<TransactionsPage> {
28
+ ): Core.PagePromise<TransactionsPage, Transaction> {
26
29
  if (isRequestOptions(query)) {
27
30
  return this.list({}, query);
28
31
  }
@@ -120,26 +123,26 @@ export namespace Transaction {
120
123
  */
121
124
  export interface Source {
122
125
  /**
123
- * A Account Transfer Intention object. This field will be present in the JSON
126
+ * An Account Transfer Intention object. This field will be present in the JSON
124
127
  * response if and only if `category` is equal to `account_transfer_intention`.
125
128
  */
126
129
  account_transfer_intention: Source.AccountTransferIntention | null;
127
130
 
128
131
  /**
129
- * A ACH Transfer Intention object. This field will be present in the JSON response
130
- * if and only if `category` is equal to `ach_transfer_intention`.
132
+ * An ACH Transfer Intention object. This field will be present in the JSON
133
+ * response if and only if `category` is equal to `ach_transfer_intention`.
131
134
  */
132
135
  ach_transfer_intention: Source.ACHTransferIntention | null;
133
136
 
134
137
  /**
135
- * A ACH Transfer Rejection object. This field will be present in the JSON response
136
- * if and only if `category` is equal to `ach_transfer_rejection`.
138
+ * An ACH Transfer Rejection object. This field will be present in the JSON
139
+ * response if and only if `category` is equal to `ach_transfer_rejection`.
137
140
  */
138
141
  ach_transfer_rejection: Source.ACHTransferRejection | null;
139
142
 
140
143
  /**
141
- * A ACH Transfer Return object. This field will be present in the JSON response if
142
- * and only if `category` is equal to `ach_transfer_return`.
144
+ * An ACH Transfer Return object. This field will be present in the JSON response
145
+ * if and only if `category` is equal to `ach_transfer_return`.
143
146
  */
144
147
  ach_transfer_return: Source.ACHTransferReturn | null;
145
148
 
@@ -168,79 +171,69 @@ export namespace Transaction {
168
171
  card_settlement: Source.CardSettlement | null;
169
172
 
170
173
  /**
171
- * The type of transaction that took place. We may add additional possible values
172
- * for this enum over time; your application should be able to handle such
173
- * additions gracefully.
174
+ * The type of the resource. We may add additional possible values for this enum
175
+ * over time; your application should be able to handle such additions gracefully.
174
176
  *
175
- * - `account_transfer_intention` - The Transaction was created by a Account
176
- * Transfer Intention object. Details will be under the
177
- * `account_transfer_intention` object.
178
- * - `ach_transfer_intention` - The Transaction was created by a ACH Transfer
179
- * Intention object. Details will be under the `ach_transfer_intention` object.
180
- * - `ach_transfer_rejection` - The Transaction was created by a ACH Transfer
181
- * Rejection object. Details will be under the `ach_transfer_rejection` object.
182
- * - `ach_transfer_return` - The Transaction was created by a ACH Transfer Return
183
- * object. Details will be under the `ach_transfer_return` object.
184
- * - `card_dispute_acceptance` - The Transaction was created by a Card Dispute
185
- * Acceptance object. Details will be under the `card_dispute_acceptance` object.
186
- * - `card_refund` - The Transaction was created by a Card Refund object. Details
187
- * will be under the `card_refund` object.
188
- * - `card_revenue_payment` - The Transaction was created by a Card Revenue Payment
189
- * object. Details will be under the `card_revenue_payment` object.
190
- * - `card_settlement` - The Transaction was created by a Card Settlement object.
191
- * Details will be under the `card_settlement` object.
192
- * - `check_deposit_acceptance` - The Transaction was created by a Check Deposit
193
- * Acceptance object. Details will be under the `check_deposit_acceptance`
177
+ * - `account_transfer_intention` - Account Transfer Intention: details will be
178
+ * under the `account_transfer_intention` object.
179
+ * - `ach_transfer_intention` - ACH Transfer Intention: details will be under the
180
+ * `ach_transfer_intention` object.
181
+ * - `ach_transfer_rejection` - ACH Transfer Rejection: details will be under the
182
+ * `ach_transfer_rejection` object.
183
+ * - `ach_transfer_return` - ACH Transfer Return: details will be under the
184
+ * `ach_transfer_return` object.
185
+ * - `card_dispute_acceptance` - Card Dispute Acceptance: details will be under the
186
+ * `card_dispute_acceptance` object.
187
+ * - `card_refund` - Card Refund: details will be under the `card_refund` object.
188
+ * - `card_revenue_payment` - Card Revenue Payment: details will be under the
189
+ * `card_revenue_payment` object.
190
+ * - `card_settlement` - Card Settlement: details will be under the
191
+ * `card_settlement` object.
192
+ * - `check_deposit_acceptance` - Check Deposit Acceptance: details will be under
193
+ * the `check_deposit_acceptance` object.
194
+ * - `check_deposit_return` - Check Deposit Return: details will be under the
195
+ * `check_deposit_return` object.
196
+ * - `check_transfer_deposit` - Check Transfer Deposit: details will be under the
197
+ * `check_transfer_deposit` object.
198
+ * - `check_transfer_intention` - Check Transfer Intention: details will be under
199
+ * the `check_transfer_intention` object.
200
+ * - `check_transfer_stop_payment_request` - Check Transfer Stop Payment Request:
201
+ * details will be under the `check_transfer_stop_payment_request` object.
202
+ * - `fee_payment` - Fee Payment: details will be under the `fee_payment` object.
203
+ * - `inbound_ach_transfer` - Inbound ACH Transfer Intention: details will be under
204
+ * the `inbound_ach_transfer` object.
205
+ * - `inbound_ach_transfer_return_intention` - Inbound ACH Transfer Return
206
+ * Intention: details will be under the `inbound_ach_transfer_return_intention`
207
+ * object.
208
+ * - `inbound_check` - Inbound Check: details will be under the `inbound_check`
209
+ * object.
210
+ * - `inbound_international_ach_transfer` - Inbound International ACH Transfer:
211
+ * details will be under the `inbound_international_ach_transfer` object.
212
+ * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real Time
213
+ * Payments Transfer Confirmation: details will be under the
214
+ * `inbound_real_time_payments_transfer_confirmation` object.
215
+ * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
216
+ * be under the `inbound_wire_drawdown_payment` object.
217
+ * - `inbound_wire_drawdown_payment_reversal` - Inbound Wire Drawdown Payment
218
+ * Reversal: details will be under the `inbound_wire_drawdown_payment_reversal`
194
219
  * object.
195
- * - `check_deposit_return` - The Transaction was created by a Check Deposit Return
196
- * object. Details will be under the `check_deposit_return` object.
197
- * - `check_transfer_deposit` - The Transaction was created by a Check Transfer
198
- * Deposit object. Details will be under the `check_transfer_deposit` object.
199
- * - `check_transfer_intention` - The Transaction was created by a Check Transfer
200
- * Intention object. Details will be under the `check_transfer_intention` object.
201
- * - `check_transfer_rejection` - The Transaction was created by a Check Transfer
202
- * Rejection object. Details will be under the `check_transfer_rejection` object.
203
- * - `check_transfer_stop_payment_request` - The Transaction was created by a Check
204
- * Transfer Stop Payment Request object. Details will be under the
205
- * `check_transfer_stop_payment_request` object.
206
- * - `fee_payment` - The Transaction was created by a Fee Payment object. Details
207
- * will be under the `fee_payment` object.
208
- * - `inbound_ach_transfer` - The Transaction was created by a Inbound ACH Transfer
209
- * object. Details will be under the `inbound_ach_transfer` object.
210
- * - `inbound_ach_transfer_return_intention` - The Transaction was created by a
211
- * Inbound ACH Transfer Return Intention object. Details will be under the
212
- * `inbound_ach_transfer_return_intention` object.
213
- * - `inbound_check` - The Transaction was created by a Inbound Check object.
214
- * Details will be under the `inbound_check` object.
215
- * - `inbound_international_ach_transfer` - The Transaction was created by a
216
- * Inbound International ACH Transfer object. Details will be under the
217
- * `inbound_international_ach_transfer` object.
218
- * - `inbound_real_time_payments_transfer_confirmation` - The Transaction was
219
- * created by a Inbound Real Time Payments Transfer Confirmation object. Details
220
- * will be under the `inbound_real_time_payments_transfer_confirmation` object.
221
- * - `inbound_wire_drawdown_payment` - The Transaction was created by a Inbound
222
- * Wire Drawdown Payment object. Details will be under the
223
- * `inbound_wire_drawdown_payment` object.
224
- * - `inbound_wire_drawdown_payment_reversal` - The Transaction was created by a
225
- * Inbound Wire Drawdown Payment Reversal object. Details will be under the
226
- * `inbound_wire_drawdown_payment_reversal` object.
227
- * - `inbound_wire_reversal` - The Transaction was created by a Inbound Wire
228
- * Reversal object. Details will be under the `inbound_wire_reversal` object.
229
- * - `inbound_wire_transfer` - The Transaction was created by a Inbound Wire
230
- * Transfer object. Details will be under the `inbound_wire_transfer` object.
231
- * - `interest_payment` - The Transaction was created by a Interest Payment object.
232
- * Details will be under the `interest_payment` object.
233
- * - `internal_source` - The Transaction was created by a Internal Source object.
234
- * Details will be under the `internal_source` object.
235
- * - `real_time_payments_transfer_acknowledgement` - The Transaction was created by
236
- * a Real Time Payments Transfer Acknowledgement object. Details will be under
237
- * the `real_time_payments_transfer_acknowledgement` object.
238
- * - `sample_funds` - The Transaction was created by a Sample Funds object. Details
239
- * will be under the `sample_funds` object.
240
- * - `wire_transfer_intention` - The Transaction was created by a Wire Transfer
241
- * Intention object. Details will be under the `wire_transfer_intention` object.
242
- * - `wire_transfer_rejection` - The Transaction was created by a Wire Transfer
243
- * Rejection object. Details will be under the `wire_transfer_rejection` object.
220
+ * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
221
+ * `inbound_wire_reversal` object.
222
+ * - `inbound_wire_transfer` - Inbound Wire Transfer: details will be under the
223
+ * `inbound_wire_transfer` object.
224
+ * - `interest_payment` - Interest Payment: details will be under the
225
+ * `interest_payment` object.
226
+ * - `internal_source` - Internal Source: details will be under the
227
+ * `internal_source` object.
228
+ * - `real_time_payments_transfer_acknowledgement` - Real Time Payments Transfer
229
+ * Acknowledgement: details will be under the
230
+ * `real_time_payments_transfer_acknowledgement` object.
231
+ * - `sample_funds` - Sample Funds: details will be under the `sample_funds`
232
+ * object.
233
+ * - `wire_transfer_intention` - Wire Transfer Intention: details will be under the
234
+ * `wire_transfer_intention` object.
235
+ * - `wire_transfer_rejection` - Wire Transfer Rejection: details will be under the
236
+ * `wire_transfer_rejection` object.
244
237
  * - `other` - The Transaction was made for an undocumented or deprecated reason.
245
238
  */
246
239
  category:
@@ -256,7 +249,6 @@ export namespace Transaction {
256
249
  | 'check_deposit_return'
257
250
  | 'check_transfer_deposit'
258
251
  | 'check_transfer_intention'
259
- | 'check_transfer_rejection'
260
252
  | 'check_transfer_stop_payment_request'
261
253
  | 'fee_payment'
262
254
  | 'inbound_ach_transfer'
@@ -300,12 +292,6 @@ export namespace Transaction {
300
292
  */
301
293
  check_transfer_intention: Source.CheckTransferIntention | null;
302
294
 
303
- /**
304
- * A Check Transfer Rejection object. This field will be present in the JSON
305
- * response if and only if `category` is equal to `check_transfer_rejection`.
306
- */
307
- check_transfer_rejection: Source.CheckTransferRejection | null;
308
-
309
295
  /**
310
296
  * A Check Transfer Stop Payment Request object. This field will be present in the
311
297
  * JSON response if and only if `category` is equal to
@@ -320,65 +306,65 @@ export namespace Transaction {
320
306
  fee_payment: Source.FeePayment | null;
321
307
 
322
308
  /**
323
- * A Inbound ACH Transfer object. This field will be present in the JSON response
324
- * if and only if `category` is equal to `inbound_ach_transfer`.
309
+ * An Inbound ACH Transfer Intention object. This field will be present in the JSON
310
+ * response if and only if `category` is equal to `inbound_ach_transfer`.
325
311
  */
326
312
  inbound_ach_transfer: Source.InboundACHTransfer | null;
327
313
 
328
314
  /**
329
- * A Inbound Check object. This field will be present in the JSON response if and
315
+ * An Inbound Check object. This field will be present in the JSON response if and
330
316
  * only if `category` is equal to `inbound_check`.
331
317
  */
332
318
  inbound_check: Source.InboundCheck | null;
333
319
 
334
320
  /**
335
- * A Inbound International ACH Transfer object. This field will be present in the
321
+ * An Inbound International ACH Transfer object. This field will be present in the
336
322
  * JSON response if and only if `category` is equal to
337
323
  * `inbound_international_ach_transfer`.
338
324
  */
339
325
  inbound_international_ach_transfer: Source.InboundInternationalACHTransfer | null;
340
326
 
341
327
  /**
342
- * A Inbound Real Time Payments Transfer Confirmation object. This field will be
328
+ * An Inbound Real Time Payments Transfer Confirmation object. This field will be
343
329
  * present in the JSON response if and only if `category` is equal to
344
330
  * `inbound_real_time_payments_transfer_confirmation`.
345
331
  */
346
332
  inbound_real_time_payments_transfer_confirmation: Source.InboundRealTimePaymentsTransferConfirmation | null;
347
333
 
348
334
  /**
349
- * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
335
+ * An Inbound Wire Drawdown Payment object. This field will be present in the JSON
350
336
  * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
351
337
  */
352
338
  inbound_wire_drawdown_payment: Source.InboundWireDrawdownPayment | null;
353
339
 
354
340
  /**
355
- * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
341
+ * An Inbound Wire Drawdown Payment Reversal object. This field will be present in
356
342
  * the JSON response if and only if `category` is equal to
357
343
  * `inbound_wire_drawdown_payment_reversal`.
358
344
  */
359
345
  inbound_wire_drawdown_payment_reversal: Source.InboundWireDrawdownPaymentReversal | null;
360
346
 
361
347
  /**
362
- * A Inbound Wire Reversal object. This field will be present in the JSON response
348
+ * An Inbound Wire Reversal object. This field will be present in the JSON response
363
349
  * if and only if `category` is equal to `inbound_wire_reversal`.
364
350
  */
365
351
  inbound_wire_reversal: Source.InboundWireReversal | null;
366
352
 
367
353
  /**
368
- * A Inbound Wire Transfer object. This field will be present in the JSON response
354
+ * An Inbound Wire Transfer object. This field will be present in the JSON response
369
355
  * if and only if `category` is equal to `inbound_wire_transfer`.
370
356
  */
371
357
  inbound_wire_transfer: Source.InboundWireTransfer | null;
372
358
 
373
359
  /**
374
- * A Interest Payment object. This field will be present in the JSON response if
360
+ * An Interest Payment object. This field will be present in the JSON response if
375
361
  * and only if `category` is equal to `interest_payment`.
376
362
  */
377
363
  interest_payment: Source.InterestPayment | null;
378
364
 
379
365
  /**
380
- * A Internal Source object. This field will be present in the JSON response if and
381
- * only if `category` is equal to `internal_source`.
366
+ * An Internal Source object. This field will be present in the JSON response if
367
+ * and only if `category` is equal to `internal_source`.
382
368
  */
383
369
  internal_source: Source.InternalSource | null;
384
370
 
@@ -410,7 +396,7 @@ export namespace Transaction {
410
396
 
411
397
  export namespace Source {
412
398
  /**
413
- * A Account Transfer Intention object. This field will be present in the JSON
399
+ * An Account Transfer Intention object. This field will be present in the JSON
414
400
  * response if and only if `category` is equal to `account_transfer_intention`.
415
401
  */
416
402
  export interface AccountTransferIntention {
@@ -455,8 +441,8 @@ export namespace Transaction {
455
441
  }
456
442
 
457
443
  /**
458
- * A ACH Transfer Intention object. This field will be present in the JSON response
459
- * if and only if `category` is equal to `ach_transfer_intention`.
444
+ * An ACH Transfer Intention object. This field will be present in the JSON
445
+ * response if and only if `category` is equal to `ach_transfer_intention`.
460
446
  */
461
447
  export interface ACHTransferIntention {
462
448
  account_number: string;
@@ -478,8 +464,8 @@ export namespace Transaction {
478
464
  }
479
465
 
480
466
  /**
481
- * A ACH Transfer Rejection object. This field will be present in the JSON response
482
- * if and only if `category` is equal to `ach_transfer_rejection`.
467
+ * An ACH Transfer Rejection object. This field will be present in the JSON
468
+ * response if and only if `category` is equal to `ach_transfer_rejection`.
483
469
  */
484
470
  export interface ACHTransferRejection {
485
471
  /**
@@ -489,8 +475,8 @@ export namespace Transaction {
489
475
  }
490
476
 
491
477
  /**
492
- * A ACH Transfer Return object. This field will be present in the JSON response if
493
- * and only if `category` is equal to `ach_transfer_return`.
478
+ * An ACH Transfer Return object. This field will be present in the JSON response
479
+ * if and only if `category` is equal to `ach_transfer_return`.
494
480
  */
495
481
  export interface ACHTransferReturn {
496
482
  /**
@@ -818,6 +804,12 @@ export namespace Transaction {
818
804
  */
819
805
  merchant_state: string | null;
820
806
 
807
+ /**
808
+ * Additional details about the card purchase, such as tax and industry-specific
809
+ * fields.
810
+ */
811
+ purchase_details: CardRefund.PurchaseDetails | null;
812
+
821
813
  /**
822
814
  * The identifier of the Transaction associated with this Transaction.
823
815
  */
@@ -830,6 +822,535 @@ export namespace Transaction {
830
822
  type: 'card_refund';
831
823
  }
832
824
 
825
+ export namespace CardRefund {
826
+ /**
827
+ * Additional details about the card purchase, such as tax and industry-specific
828
+ * fields.
829
+ */
830
+ export interface PurchaseDetails {
831
+ /**
832
+ * Fields specific to car rentals.
833
+ */
834
+ car_rental: PurchaseDetails.CarRental | null;
835
+
836
+ /**
837
+ * An identifier from the merchant for the customer or consumer.
838
+ */
839
+ customer_reference_identifier: string | null;
840
+
841
+ /**
842
+ * The state or provincial tax amount in minor units.
843
+ */
844
+ local_tax_amount: number | null;
845
+
846
+ /**
847
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
848
+ * assessed.
849
+ */
850
+ local_tax_currency: string | null;
851
+
852
+ /**
853
+ * Fields specific to lodging.
854
+ */
855
+ lodging: PurchaseDetails.Lodging | null;
856
+
857
+ /**
858
+ * The national tax amount in minor units.
859
+ */
860
+ national_tax_amount: number | null;
861
+
862
+ /**
863
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
864
+ * assessed.
865
+ */
866
+ national_tax_currency: string | null;
867
+
868
+ /**
869
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
870
+ */
871
+ purchase_identifier: string | null;
872
+
873
+ /**
874
+ * The format of the purchase identifier.
875
+ *
876
+ * - `free_text` - Free text
877
+ * - `order_number` - Order number
878
+ * - `rental_agreement_number` - Rental agreement number
879
+ * - `hotel_folio_number` - Hotel folio number
880
+ * - `invoice_number` - Invoice number
881
+ */
882
+ purchase_identifier_format:
883
+ | 'free_text'
884
+ | 'order_number'
885
+ | 'rental_agreement_number'
886
+ | 'hotel_folio_number'
887
+ | 'invoice_number'
888
+ | null;
889
+
890
+ /**
891
+ * Fields specific to travel.
892
+ */
893
+ travel: PurchaseDetails.Travel | null;
894
+ }
895
+
896
+ export namespace PurchaseDetails {
897
+ /**
898
+ * Fields specific to car rentals.
899
+ */
900
+ export interface CarRental {
901
+ /**
902
+ * Code indicating the vehicle's class.
903
+ */
904
+ car_class_code: string | null;
905
+
906
+ /**
907
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
908
+ * transaction, the scheduled pick up date.
909
+ */
910
+ checkout_date: string | null;
911
+
912
+ /**
913
+ * Daily rate being charged for the vehicle.
914
+ */
915
+ daily_rental_rate_amount: number | null;
916
+
917
+ /**
918
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
919
+ * rate.
920
+ */
921
+ daily_rental_rate_currency: string | null;
922
+
923
+ /**
924
+ * Number of days the vehicle was rented.
925
+ */
926
+ days_rented: number | null;
927
+
928
+ /**
929
+ * Additional charges (gas, late fee, etc.) being billed.
930
+ *
931
+ * - `no_extra_charge` - No extra charge
932
+ * - `gas` - Gas
933
+ * - `extra_mileage` - Extra mileage
934
+ * - `late_return` - Late return
935
+ * - `one_way_service_fee` - One way service fee
936
+ * - `parking_violation` - Parking violation
937
+ */
938
+ extra_charges:
939
+ | 'no_extra_charge'
940
+ | 'gas'
941
+ | 'extra_mileage'
942
+ | 'late_return'
943
+ | 'one_way_service_fee'
944
+ | 'parking_violation'
945
+ | null;
946
+
947
+ /**
948
+ * Fuel charges for the vehicle.
949
+ */
950
+ fuel_charges_amount: number | null;
951
+
952
+ /**
953
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
954
+ * assessed.
955
+ */
956
+ fuel_charges_currency: string | null;
957
+
958
+ /**
959
+ * Any insurance being charged for the vehicle.
960
+ */
961
+ insurance_charges_amount: number | null;
962
+
963
+ /**
964
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
965
+ * charges assessed.
966
+ */
967
+ insurance_charges_currency: string | null;
968
+
969
+ /**
970
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
971
+ * not actually rented (that is, a "no-show" charge).
972
+ *
973
+ * - `not_applicable` - Not applicable
974
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
975
+ */
976
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
977
+
978
+ /**
979
+ * Charges for returning the vehicle at a different location than where it was
980
+ * picked up.
981
+ */
982
+ one_way_drop_off_charges_amount: number | null;
983
+
984
+ /**
985
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
986
+ * drop-off charges assessed.
987
+ */
988
+ one_way_drop_off_charges_currency: string | null;
989
+
990
+ /**
991
+ * Name of the person renting the vehicle.
992
+ */
993
+ renter_name: string | null;
994
+
995
+ /**
996
+ * Weekly rate being charged for the vehicle.
997
+ */
998
+ weekly_rental_rate_amount: number | null;
999
+
1000
+ /**
1001
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
1002
+ * rental rate.
1003
+ */
1004
+ weekly_rental_rate_currency: string | null;
1005
+ }
1006
+
1007
+ /**
1008
+ * Fields specific to lodging.
1009
+ */
1010
+ export interface Lodging {
1011
+ /**
1012
+ * Date the customer checked in.
1013
+ */
1014
+ check_in_date: string | null;
1015
+
1016
+ /**
1017
+ * Daily rate being charged for the room.
1018
+ */
1019
+ daily_room_rate_amount: number | null;
1020
+
1021
+ /**
1022
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
1023
+ * rate.
1024
+ */
1025
+ daily_room_rate_currency: string | null;
1026
+
1027
+ /**
1028
+ * Additional charges (phone, late check-out, etc.) being billed.
1029
+ *
1030
+ * - `no_extra_charge` - No extra charge
1031
+ * - `restaurant` - Restaurant
1032
+ * - `gift_shop` - Gift shop
1033
+ * - `mini_bar` - Mini bar
1034
+ * - `telephone` - Telephone
1035
+ * - `other` - Other
1036
+ * - `laundry` - Laundry
1037
+ */
1038
+ extra_charges:
1039
+ | 'no_extra_charge'
1040
+ | 'restaurant'
1041
+ | 'gift_shop'
1042
+ | 'mini_bar'
1043
+ | 'telephone'
1044
+ | 'other'
1045
+ | 'laundry'
1046
+ | null;
1047
+
1048
+ /**
1049
+ * Folio cash advances for the room.
1050
+ */
1051
+ folio_cash_advances_amount: number | null;
1052
+
1053
+ /**
1054
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
1055
+ * advances.
1056
+ */
1057
+ folio_cash_advances_currency: string | null;
1058
+
1059
+ /**
1060
+ * Food and beverage charges for the room.
1061
+ */
1062
+ food_beverage_charges_amount: number | null;
1063
+
1064
+ /**
1065
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
1066
+ * beverage charges.
1067
+ */
1068
+ food_beverage_charges_currency: string | null;
1069
+
1070
+ /**
1071
+ * Indicator that the cardholder is being billed for a reserved room that was not
1072
+ * actually used.
1073
+ *
1074
+ * - `not_applicable` - Not applicable
1075
+ * - `no_show` - No show
1076
+ */
1077
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
1078
+
1079
+ /**
1080
+ * Prepaid expenses being charged for the room.
1081
+ */
1082
+ prepaid_expenses_amount: number | null;
1083
+
1084
+ /**
1085
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
1086
+ * expenses.
1087
+ */
1088
+ prepaid_expenses_currency: string | null;
1089
+
1090
+ /**
1091
+ * Number of nights the room was rented.
1092
+ */
1093
+ room_nights: number | null;
1094
+
1095
+ /**
1096
+ * Total room tax being charged.
1097
+ */
1098
+ total_room_tax_amount: number | null;
1099
+
1100
+ /**
1101
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
1102
+ * tax.
1103
+ */
1104
+ total_room_tax_currency: string | null;
1105
+
1106
+ /**
1107
+ * Total tax being charged for the room.
1108
+ */
1109
+ total_tax_amount: number | null;
1110
+
1111
+ /**
1112
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
1113
+ * assessed.
1114
+ */
1115
+ total_tax_currency: string | null;
1116
+ }
1117
+
1118
+ /**
1119
+ * Fields specific to travel.
1120
+ */
1121
+ export interface Travel {
1122
+ /**
1123
+ * Ancillary purchases in addition to the airfare.
1124
+ */
1125
+ ancillary: Travel.Ancillary | null;
1126
+
1127
+ /**
1128
+ * Indicates the computerized reservation system used to book the ticket.
1129
+ */
1130
+ computerized_reservation_system: string | null;
1131
+
1132
+ /**
1133
+ * Indicates the reason for a credit to the cardholder.
1134
+ *
1135
+ * - `no_credit` - No credit
1136
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1137
+ * ancillary purchase cancellation
1138
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1139
+ * Airline ticket and passenger transport ancillary purchase cancellation
1140
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
1141
+ * - `other` - Other
1142
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
1143
+ */
1144
+ credit_reason_indicator:
1145
+ | 'no_credit'
1146
+ | 'passenger_transport_ancillary_purchase_cancellation'
1147
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1148
+ | 'airline_ticket_cancellation'
1149
+ | 'other'
1150
+ | 'partial_refund_of_airline_ticket'
1151
+ | null;
1152
+
1153
+ /**
1154
+ * Date of departure.
1155
+ */
1156
+ departure_date: string | null;
1157
+
1158
+ /**
1159
+ * Code for the originating city or airport.
1160
+ */
1161
+ origination_city_airport_code: string | null;
1162
+
1163
+ /**
1164
+ * Name of the passenger.
1165
+ */
1166
+ passenger_name: string | null;
1167
+
1168
+ /**
1169
+ * Indicates whether this ticket is non-refundable.
1170
+ *
1171
+ * - `no_restrictions` - No restrictions
1172
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
1173
+ */
1174
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
1175
+
1176
+ /**
1177
+ * Indicates why a ticket was changed.
1178
+ *
1179
+ * - `none` - None
1180
+ * - `change_to_existing_ticket` - Change to existing ticket
1181
+ * - `new_ticket` - New ticket
1182
+ */
1183
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
1184
+
1185
+ /**
1186
+ * Ticket number.
1187
+ */
1188
+ ticket_number: string | null;
1189
+
1190
+ /**
1191
+ * Code for the travel agency if the ticket was issued by a travel agency.
1192
+ */
1193
+ travel_agency_code: string | null;
1194
+
1195
+ /**
1196
+ * Name of the travel agency if the ticket was issued by a travel agency.
1197
+ */
1198
+ travel_agency_name: string | null;
1199
+
1200
+ /**
1201
+ * Fields specific to each leg of the journey.
1202
+ */
1203
+ trip_legs: Array<Travel.TripLeg> | null;
1204
+ }
1205
+
1206
+ export namespace Travel {
1207
+ /**
1208
+ * Ancillary purchases in addition to the airfare.
1209
+ */
1210
+ export interface Ancillary {
1211
+ /**
1212
+ * If this purchase has a connection or relationship to another purchase, such as a
1213
+ * baggage fee for a passenger transport ticket, this field should contain the
1214
+ * ticket document number for the other purchase.
1215
+ */
1216
+ connected_ticket_document_number: string | null;
1217
+
1218
+ /**
1219
+ * Indicates the reason for a credit to the cardholder.
1220
+ *
1221
+ * - `no_credit` - No credit
1222
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1223
+ * ancillary purchase cancellation
1224
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1225
+ * Airline ticket and passenger transport ancillary purchase cancellation
1226
+ * - `other` - Other
1227
+ */
1228
+ credit_reason_indicator:
1229
+ | 'no_credit'
1230
+ | 'passenger_transport_ancillary_purchase_cancellation'
1231
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1232
+ | 'other'
1233
+ | null;
1234
+
1235
+ /**
1236
+ * Name of the passenger or description of the ancillary purchase.
1237
+ */
1238
+ passenger_name_or_description: string | null;
1239
+
1240
+ /**
1241
+ * Additional travel charges, such as baggage fees.
1242
+ */
1243
+ services: Array<Ancillary.Service>;
1244
+
1245
+ /**
1246
+ * Ticket document number.
1247
+ */
1248
+ ticket_document_number: string | null;
1249
+ }
1250
+
1251
+ export namespace Ancillary {
1252
+ export interface Service {
1253
+ /**
1254
+ * Category of the ancillary service.
1255
+ *
1256
+ * - `none` - None
1257
+ * - `bundled_service` - Bundled service
1258
+ * - `baggage_fee` - Baggage fee
1259
+ * - `change_fee` - Change fee
1260
+ * - `cargo` - Cargo
1261
+ * - `carbon_offset` - Carbon offset
1262
+ * - `frequent_flyer` - Frequent flyer
1263
+ * - `gift_card` - Gift card
1264
+ * - `ground_transport` - Ground transport
1265
+ * - `in_flight_entertainment` - In-flight entertainment
1266
+ * - `lounge` - Lounge
1267
+ * - `medical` - Medical
1268
+ * - `meal_beverage` - Meal beverage
1269
+ * - `other` - Other
1270
+ * - `passenger_assist_fee` - Passenger assist fee
1271
+ * - `pets` - Pets
1272
+ * - `seat_fees` - Seat fees
1273
+ * - `standby` - Standby
1274
+ * - `service_fee` - Service fee
1275
+ * - `store` - Store
1276
+ * - `travel_service` - Travel service
1277
+ * - `unaccompanied_travel` - Unaccompanied travel
1278
+ * - `upgrades` - Upgrades
1279
+ * - `wifi` - Wi-fi
1280
+ */
1281
+ category:
1282
+ | 'none'
1283
+ | 'bundled_service'
1284
+ | 'baggage_fee'
1285
+ | 'change_fee'
1286
+ | 'cargo'
1287
+ | 'carbon_offset'
1288
+ | 'frequent_flyer'
1289
+ | 'gift_card'
1290
+ | 'ground_transport'
1291
+ | 'in_flight_entertainment'
1292
+ | 'lounge'
1293
+ | 'medical'
1294
+ | 'meal_beverage'
1295
+ | 'other'
1296
+ | 'passenger_assist_fee'
1297
+ | 'pets'
1298
+ | 'seat_fees'
1299
+ | 'standby'
1300
+ | 'service_fee'
1301
+ | 'store'
1302
+ | 'travel_service'
1303
+ | 'unaccompanied_travel'
1304
+ | 'upgrades'
1305
+ | 'wifi'
1306
+ | null;
1307
+
1308
+ /**
1309
+ * Sub-category of the ancillary service, free-form.
1310
+ */
1311
+ sub_category: string | null;
1312
+ }
1313
+ }
1314
+
1315
+ export interface TripLeg {
1316
+ /**
1317
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
1318
+ */
1319
+ carrier_code: string | null;
1320
+
1321
+ /**
1322
+ * Code for the destination city or airport.
1323
+ */
1324
+ destination_city_airport_code: string | null;
1325
+
1326
+ /**
1327
+ * Fare basis code.
1328
+ */
1329
+ fare_basis_code: string | null;
1330
+
1331
+ /**
1332
+ * Flight number.
1333
+ */
1334
+ flight_number: string | null;
1335
+
1336
+ /**
1337
+ * Service class (e.g., first class, business class, etc.).
1338
+ */
1339
+ service_class: string | null;
1340
+
1341
+ /**
1342
+ * Indicates whether a stopover is allowed on this ticket.
1343
+ *
1344
+ * - `none` - None
1345
+ * - `stop_over_allowed` - Stop over allowed
1346
+ * - `stop_over_not_allowed` - Stop over not allowed
1347
+ */
1348
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
1349
+ }
1350
+ }
1351
+ }
1352
+ }
1353
+
833
1354
  /**
834
1355
  * A Card Revenue Payment object. This field will be present in the JSON response
835
1356
  * if and only if `category` is equal to `card_revenue_payment`.
@@ -952,6 +1473,12 @@ export namespace Transaction {
952
1473
  */
953
1474
  presentment_currency: string;
954
1475
 
1476
+ /**
1477
+ * Additional details about the card purchase, such as tax and industry-specific
1478
+ * fields.
1479
+ */
1480
+ purchase_details: CardSettlement.PurchaseDetails | null;
1481
+
955
1482
  /**
956
1483
  * The identifier of the Transaction associated with this Transaction.
957
1484
  */
@@ -964,6 +1491,535 @@ export namespace Transaction {
964
1491
  type: 'card_settlement';
965
1492
  }
966
1493
 
1494
+ export namespace CardSettlement {
1495
+ /**
1496
+ * Additional details about the card purchase, such as tax and industry-specific
1497
+ * fields.
1498
+ */
1499
+ export interface PurchaseDetails {
1500
+ /**
1501
+ * Fields specific to car rentals.
1502
+ */
1503
+ car_rental: PurchaseDetails.CarRental | null;
1504
+
1505
+ /**
1506
+ * An identifier from the merchant for the customer or consumer.
1507
+ */
1508
+ customer_reference_identifier: string | null;
1509
+
1510
+ /**
1511
+ * The state or provincial tax amount in minor units.
1512
+ */
1513
+ local_tax_amount: number | null;
1514
+
1515
+ /**
1516
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1517
+ * assessed.
1518
+ */
1519
+ local_tax_currency: string | null;
1520
+
1521
+ /**
1522
+ * Fields specific to lodging.
1523
+ */
1524
+ lodging: PurchaseDetails.Lodging | null;
1525
+
1526
+ /**
1527
+ * The national tax amount in minor units.
1528
+ */
1529
+ national_tax_amount: number | null;
1530
+
1531
+ /**
1532
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax
1533
+ * assessed.
1534
+ */
1535
+ national_tax_currency: string | null;
1536
+
1537
+ /**
1538
+ * An identifier from the merchant for the purchase to the issuer and cardholder.
1539
+ */
1540
+ purchase_identifier: string | null;
1541
+
1542
+ /**
1543
+ * The format of the purchase identifier.
1544
+ *
1545
+ * - `free_text` - Free text
1546
+ * - `order_number` - Order number
1547
+ * - `rental_agreement_number` - Rental agreement number
1548
+ * - `hotel_folio_number` - Hotel folio number
1549
+ * - `invoice_number` - Invoice number
1550
+ */
1551
+ purchase_identifier_format:
1552
+ | 'free_text'
1553
+ | 'order_number'
1554
+ | 'rental_agreement_number'
1555
+ | 'hotel_folio_number'
1556
+ | 'invoice_number'
1557
+ | null;
1558
+
1559
+ /**
1560
+ * Fields specific to travel.
1561
+ */
1562
+ travel: PurchaseDetails.Travel | null;
1563
+ }
1564
+
1565
+ export namespace PurchaseDetails {
1566
+ /**
1567
+ * Fields specific to car rentals.
1568
+ */
1569
+ export interface CarRental {
1570
+ /**
1571
+ * Code indicating the vehicle's class.
1572
+ */
1573
+ car_class_code: string | null;
1574
+
1575
+ /**
1576
+ * Date the customer picked up the car or, in the case of a no-show or pre-pay
1577
+ * transaction, the scheduled pick up date.
1578
+ */
1579
+ checkout_date: string | null;
1580
+
1581
+ /**
1582
+ * Daily rate being charged for the vehicle.
1583
+ */
1584
+ daily_rental_rate_amount: number | null;
1585
+
1586
+ /**
1587
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental
1588
+ * rate.
1589
+ */
1590
+ daily_rental_rate_currency: string | null;
1591
+
1592
+ /**
1593
+ * Number of days the vehicle was rented.
1594
+ */
1595
+ days_rented: number | null;
1596
+
1597
+ /**
1598
+ * Additional charges (gas, late fee, etc.) being billed.
1599
+ *
1600
+ * - `no_extra_charge` - No extra charge
1601
+ * - `gas` - Gas
1602
+ * - `extra_mileage` - Extra mileage
1603
+ * - `late_return` - Late return
1604
+ * - `one_way_service_fee` - One way service fee
1605
+ * - `parking_violation` - Parking violation
1606
+ */
1607
+ extra_charges:
1608
+ | 'no_extra_charge'
1609
+ | 'gas'
1610
+ | 'extra_mileage'
1611
+ | 'late_return'
1612
+ | 'one_way_service_fee'
1613
+ | 'parking_violation'
1614
+ | null;
1615
+
1616
+ /**
1617
+ * Fuel charges for the vehicle.
1618
+ */
1619
+ fuel_charges_amount: number | null;
1620
+
1621
+ /**
1622
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges
1623
+ * assessed.
1624
+ */
1625
+ fuel_charges_currency: string | null;
1626
+
1627
+ /**
1628
+ * Any insurance being charged for the vehicle.
1629
+ */
1630
+ insurance_charges_amount: number | null;
1631
+
1632
+ /**
1633
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance
1634
+ * charges assessed.
1635
+ */
1636
+ insurance_charges_currency: string | null;
1637
+
1638
+ /**
1639
+ * An indicator that the cardholder is being billed for a reserved vehicle that was
1640
+ * not actually rented (that is, a "no-show" charge).
1641
+ *
1642
+ * - `not_applicable` - Not applicable
1643
+ * - `no_show_for_specialized_vehicle` - No show for specialized vehicle
1644
+ */
1645
+ no_show_indicator: 'not_applicable' | 'no_show_for_specialized_vehicle' | null;
1646
+
1647
+ /**
1648
+ * Charges for returning the vehicle at a different location than where it was
1649
+ * picked up.
1650
+ */
1651
+ one_way_drop_off_charges_amount: number | null;
1652
+
1653
+ /**
1654
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way
1655
+ * drop-off charges assessed.
1656
+ */
1657
+ one_way_drop_off_charges_currency: string | null;
1658
+
1659
+ /**
1660
+ * Name of the person renting the vehicle.
1661
+ */
1662
+ renter_name: string | null;
1663
+
1664
+ /**
1665
+ * Weekly rate being charged for the vehicle.
1666
+ */
1667
+ weekly_rental_rate_amount: number | null;
1668
+
1669
+ /**
1670
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly
1671
+ * rental rate.
1672
+ */
1673
+ weekly_rental_rate_currency: string | null;
1674
+ }
1675
+
1676
+ /**
1677
+ * Fields specific to lodging.
1678
+ */
1679
+ export interface Lodging {
1680
+ /**
1681
+ * Date the customer checked in.
1682
+ */
1683
+ check_in_date: string | null;
1684
+
1685
+ /**
1686
+ * Daily rate being charged for the room.
1687
+ */
1688
+ daily_room_rate_amount: number | null;
1689
+
1690
+ /**
1691
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room
1692
+ * rate.
1693
+ */
1694
+ daily_room_rate_currency: string | null;
1695
+
1696
+ /**
1697
+ * Additional charges (phone, late check-out, etc.) being billed.
1698
+ *
1699
+ * - `no_extra_charge` - No extra charge
1700
+ * - `restaurant` - Restaurant
1701
+ * - `gift_shop` - Gift shop
1702
+ * - `mini_bar` - Mini bar
1703
+ * - `telephone` - Telephone
1704
+ * - `other` - Other
1705
+ * - `laundry` - Laundry
1706
+ */
1707
+ extra_charges:
1708
+ | 'no_extra_charge'
1709
+ | 'restaurant'
1710
+ | 'gift_shop'
1711
+ | 'mini_bar'
1712
+ | 'telephone'
1713
+ | 'other'
1714
+ | 'laundry'
1715
+ | null;
1716
+
1717
+ /**
1718
+ * Folio cash advances for the room.
1719
+ */
1720
+ folio_cash_advances_amount: number | null;
1721
+
1722
+ /**
1723
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash
1724
+ * advances.
1725
+ */
1726
+ folio_cash_advances_currency: string | null;
1727
+
1728
+ /**
1729
+ * Food and beverage charges for the room.
1730
+ */
1731
+ food_beverage_charges_amount: number | null;
1732
+
1733
+ /**
1734
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the foor and
1735
+ * beverage charges.
1736
+ */
1737
+ food_beverage_charges_currency: string | null;
1738
+
1739
+ /**
1740
+ * Indicator that the cardholder is being billed for a reserved room that was not
1741
+ * actually used.
1742
+ *
1743
+ * - `not_applicable` - Not applicable
1744
+ * - `no_show` - No show
1745
+ */
1746
+ no_show_indicator: 'not_applicable' | 'no_show' | null;
1747
+
1748
+ /**
1749
+ * Prepaid expenses being charged for the room.
1750
+ */
1751
+ prepaid_expenses_amount: number | null;
1752
+
1753
+ /**
1754
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid
1755
+ * expenses.
1756
+ */
1757
+ prepaid_expenses_currency: string | null;
1758
+
1759
+ /**
1760
+ * Number of nights the room was rented.
1761
+ */
1762
+ room_nights: number | null;
1763
+
1764
+ /**
1765
+ * Total room tax being charged.
1766
+ */
1767
+ total_room_tax_amount: number | null;
1768
+
1769
+ /**
1770
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room
1771
+ * tax.
1772
+ */
1773
+ total_room_tax_currency: string | null;
1774
+
1775
+ /**
1776
+ * Total tax being charged for the room.
1777
+ */
1778
+ total_tax_amount: number | null;
1779
+
1780
+ /**
1781
+ * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax
1782
+ * assessed.
1783
+ */
1784
+ total_tax_currency: string | null;
1785
+ }
1786
+
1787
+ /**
1788
+ * Fields specific to travel.
1789
+ */
1790
+ export interface Travel {
1791
+ /**
1792
+ * Ancillary purchases in addition to the airfare.
1793
+ */
1794
+ ancillary: Travel.Ancillary | null;
1795
+
1796
+ /**
1797
+ * Indicates the computerized reservation system used to book the ticket.
1798
+ */
1799
+ computerized_reservation_system: string | null;
1800
+
1801
+ /**
1802
+ * Indicates the reason for a credit to the cardholder.
1803
+ *
1804
+ * - `no_credit` - No credit
1805
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1806
+ * ancillary purchase cancellation
1807
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1808
+ * Airline ticket and passenger transport ancillary purchase cancellation
1809
+ * - `airline_ticket_cancellation` - Airline ticket cancellation
1810
+ * - `other` - Other
1811
+ * - `partial_refund_of_airline_ticket` - Partial refund of airline ticket
1812
+ */
1813
+ credit_reason_indicator:
1814
+ | 'no_credit'
1815
+ | 'passenger_transport_ancillary_purchase_cancellation'
1816
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1817
+ | 'airline_ticket_cancellation'
1818
+ | 'other'
1819
+ | 'partial_refund_of_airline_ticket'
1820
+ | null;
1821
+
1822
+ /**
1823
+ * Date of departure.
1824
+ */
1825
+ departure_date: string | null;
1826
+
1827
+ /**
1828
+ * Code for the originating city or airport.
1829
+ */
1830
+ origination_city_airport_code: string | null;
1831
+
1832
+ /**
1833
+ * Name of the passenger.
1834
+ */
1835
+ passenger_name: string | null;
1836
+
1837
+ /**
1838
+ * Indicates whether this ticket is non-refundable.
1839
+ *
1840
+ * - `no_restrictions` - No restrictions
1841
+ * - `restricted_non_refundable_ticket` - Restricted non-refundable ticket
1842
+ */
1843
+ restricted_ticket_indicator: 'no_restrictions' | 'restricted_non_refundable_ticket' | null;
1844
+
1845
+ /**
1846
+ * Indicates why a ticket was changed.
1847
+ *
1848
+ * - `none` - None
1849
+ * - `change_to_existing_ticket` - Change to existing ticket
1850
+ * - `new_ticket` - New ticket
1851
+ */
1852
+ ticket_change_indicator: 'none' | 'change_to_existing_ticket' | 'new_ticket' | null;
1853
+
1854
+ /**
1855
+ * Ticket number.
1856
+ */
1857
+ ticket_number: string | null;
1858
+
1859
+ /**
1860
+ * Code for the travel agency if the ticket was issued by a travel agency.
1861
+ */
1862
+ travel_agency_code: string | null;
1863
+
1864
+ /**
1865
+ * Name of the travel agency if the ticket was issued by a travel agency.
1866
+ */
1867
+ travel_agency_name: string | null;
1868
+
1869
+ /**
1870
+ * Fields specific to each leg of the journey.
1871
+ */
1872
+ trip_legs: Array<Travel.TripLeg> | null;
1873
+ }
1874
+
1875
+ export namespace Travel {
1876
+ /**
1877
+ * Ancillary purchases in addition to the airfare.
1878
+ */
1879
+ export interface Ancillary {
1880
+ /**
1881
+ * If this purchase has a connection or relationship to another purchase, such as a
1882
+ * baggage fee for a passenger transport ticket, this field should contain the
1883
+ * ticket document number for the other purchase.
1884
+ */
1885
+ connected_ticket_document_number: string | null;
1886
+
1887
+ /**
1888
+ * Indicates the reason for a credit to the cardholder.
1889
+ *
1890
+ * - `no_credit` - No credit
1891
+ * - `passenger_transport_ancillary_purchase_cancellation` - Passenger transport
1892
+ * ancillary purchase cancellation
1893
+ * - `airline_ticket_and_passenger_transport_ancillary_purchase_cancellation` -
1894
+ * Airline ticket and passenger transport ancillary purchase cancellation
1895
+ * - `other` - Other
1896
+ */
1897
+ credit_reason_indicator:
1898
+ | 'no_credit'
1899
+ | 'passenger_transport_ancillary_purchase_cancellation'
1900
+ | 'airline_ticket_and_passenger_transport_ancillary_purchase_cancellation'
1901
+ | 'other'
1902
+ | null;
1903
+
1904
+ /**
1905
+ * Name of the passenger or description of the ancillary purchase.
1906
+ */
1907
+ passenger_name_or_description: string | null;
1908
+
1909
+ /**
1910
+ * Additional travel charges, such as baggage fees.
1911
+ */
1912
+ services: Array<Ancillary.Service>;
1913
+
1914
+ /**
1915
+ * Ticket document number.
1916
+ */
1917
+ ticket_document_number: string | null;
1918
+ }
1919
+
1920
+ export namespace Ancillary {
1921
+ export interface Service {
1922
+ /**
1923
+ * Category of the ancillary service.
1924
+ *
1925
+ * - `none` - None
1926
+ * - `bundled_service` - Bundled service
1927
+ * - `baggage_fee` - Baggage fee
1928
+ * - `change_fee` - Change fee
1929
+ * - `cargo` - Cargo
1930
+ * - `carbon_offset` - Carbon offset
1931
+ * - `frequent_flyer` - Frequent flyer
1932
+ * - `gift_card` - Gift card
1933
+ * - `ground_transport` - Ground transport
1934
+ * - `in_flight_entertainment` - In-flight entertainment
1935
+ * - `lounge` - Lounge
1936
+ * - `medical` - Medical
1937
+ * - `meal_beverage` - Meal beverage
1938
+ * - `other` - Other
1939
+ * - `passenger_assist_fee` - Passenger assist fee
1940
+ * - `pets` - Pets
1941
+ * - `seat_fees` - Seat fees
1942
+ * - `standby` - Standby
1943
+ * - `service_fee` - Service fee
1944
+ * - `store` - Store
1945
+ * - `travel_service` - Travel service
1946
+ * - `unaccompanied_travel` - Unaccompanied travel
1947
+ * - `upgrades` - Upgrades
1948
+ * - `wifi` - Wi-fi
1949
+ */
1950
+ category:
1951
+ | 'none'
1952
+ | 'bundled_service'
1953
+ | 'baggage_fee'
1954
+ | 'change_fee'
1955
+ | 'cargo'
1956
+ | 'carbon_offset'
1957
+ | 'frequent_flyer'
1958
+ | 'gift_card'
1959
+ | 'ground_transport'
1960
+ | 'in_flight_entertainment'
1961
+ | 'lounge'
1962
+ | 'medical'
1963
+ | 'meal_beverage'
1964
+ | 'other'
1965
+ | 'passenger_assist_fee'
1966
+ | 'pets'
1967
+ | 'seat_fees'
1968
+ | 'standby'
1969
+ | 'service_fee'
1970
+ | 'store'
1971
+ | 'travel_service'
1972
+ | 'unaccompanied_travel'
1973
+ | 'upgrades'
1974
+ | 'wifi'
1975
+ | null;
1976
+
1977
+ /**
1978
+ * Sub-category of the ancillary service, free-form.
1979
+ */
1980
+ sub_category: string | null;
1981
+ }
1982
+ }
1983
+
1984
+ export interface TripLeg {
1985
+ /**
1986
+ * Carrier code (e.g., United Airlines, Jet Blue, etc.).
1987
+ */
1988
+ carrier_code: string | null;
1989
+
1990
+ /**
1991
+ * Code for the destination city or airport.
1992
+ */
1993
+ destination_city_airport_code: string | null;
1994
+
1995
+ /**
1996
+ * Fare basis code.
1997
+ */
1998
+ fare_basis_code: string | null;
1999
+
2000
+ /**
2001
+ * Flight number.
2002
+ */
2003
+ flight_number: string | null;
2004
+
2005
+ /**
2006
+ * Service class (e.g., first class, business class, etc.).
2007
+ */
2008
+ service_class: string | null;
2009
+
2010
+ /**
2011
+ * Indicates whether a stopover is allowed on this ticket.
2012
+ *
2013
+ * - `none` - None
2014
+ * - `stop_over_allowed` - Stop over allowed
2015
+ * - `stop_over_not_allowed` - Stop over not allowed
2016
+ */
2017
+ stop_over_code: 'none' | 'stop_over_allowed' | 'stop_over_not_allowed' | null;
2018
+ }
2019
+ }
2020
+ }
2021
+ }
2022
+
967
2023
  /**
968
2024
  * A Check Deposit Acceptance object. This field will be present in the JSON
969
2025
  * response if and only if `category` is equal to `check_deposit_acceptance`.
@@ -1179,17 +2235,6 @@ export namespace Transaction {
1179
2235
  transfer_id: string;
1180
2236
  }
1181
2237
 
1182
- /**
1183
- * A Check Transfer Rejection object. This field will be present in the JSON
1184
- * response if and only if `category` is equal to `check_transfer_rejection`.
1185
- */
1186
- export interface CheckTransferRejection {
1187
- /**
1188
- * The identifier of the Check Transfer that led to this Transaction.
1189
- */
1190
- transfer_id: string;
1191
- }
1192
-
1193
2238
  /**
1194
2239
  * A Check Transfer Stop Payment Request object. This field will be present in the
1195
2240
  * JSON response if and only if `category` is equal to
@@ -1200,9 +2245,11 @@ export namespace Transaction {
1200
2245
  * The reason why this transfer was stopped.
1201
2246
  *
1202
2247
  * - `mail_delivery_failed` - The check could not be delivered.
2248
+ * - `rejected_by_increase` - The check was cancelled by an Increase operator who
2249
+ * will provide details out-of-band.
1203
2250
  * - `unknown` - The check was stopped for another reason.
1204
2251
  */
1205
- reason: 'mail_delivery_failed' | 'unknown';
2252
+ reason: 'mail_delivery_failed' | 'rejected_by_increase' | 'unknown';
1206
2253
 
1207
2254
  /**
1208
2255
  * The time the stop-payment was requested.
@@ -1252,8 +2299,8 @@ export namespace Transaction {
1252
2299
  }
1253
2300
 
1254
2301
  /**
1255
- * A Inbound ACH Transfer object. This field will be present in the JSON response
1256
- * if and only if `category` is equal to `inbound_ach_transfer`.
2302
+ * An Inbound ACH Transfer Intention object. This field will be present in the JSON
2303
+ * response if and only if `category` is equal to `inbound_ach_transfer`.
1257
2304
  */
1258
2305
  export interface InboundACHTransfer {
1259
2306
  /**
@@ -1280,7 +2327,7 @@ export namespace Transaction {
1280
2327
  }
1281
2328
 
1282
2329
  /**
1283
- * A Inbound Check object. This field will be present in the JSON response if and
2330
+ * An Inbound Check object. This field will be present in the JSON response if and
1284
2331
  * only if `category` is equal to `inbound_check`.
1285
2332
  */
1286
2333
  export interface InboundCheck {
@@ -1311,7 +2358,7 @@ export namespace Transaction {
1311
2358
  }
1312
2359
 
1313
2360
  /**
1314
- * A Inbound International ACH Transfer object. This field will be present in the
2361
+ * An Inbound International ACH Transfer object. This field will be present in the
1315
2362
  * JSON response if and only if `category` is equal to
1316
2363
  * `inbound_international_ach_transfer`.
1317
2364
  */
@@ -1394,7 +2441,7 @@ export namespace Transaction {
1394
2441
  }
1395
2442
 
1396
2443
  /**
1397
- * A Inbound Real Time Payments Transfer Confirmation object. This field will be
2444
+ * An Inbound Real Time Payments Transfer Confirmation object. This field will be
1398
2445
  * present in the JSON response if and only if `category` is equal to
1399
2446
  * `inbound_real_time_payments_transfer_confirmation`.
1400
2447
  */
@@ -1450,7 +2497,7 @@ export namespace Transaction {
1450
2497
  }
1451
2498
 
1452
2499
  /**
1453
- * A Inbound Wire Drawdown Payment object. This field will be present in the JSON
2500
+ * An Inbound Wire Drawdown Payment object. This field will be present in the JSON
1454
2501
  * response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
1455
2502
  */
1456
2503
  export interface InboundWireDrawdownPayment {
@@ -1486,7 +2533,7 @@ export namespace Transaction {
1486
2533
  }
1487
2534
 
1488
2535
  /**
1489
- * A Inbound Wire Drawdown Payment Reversal object. This field will be present in
2536
+ * An Inbound Wire Drawdown Payment Reversal object. This field will be present in
1490
2537
  * the JSON response if and only if `category` is equal to
1491
2538
  * `inbound_wire_drawdown_payment_reversal`.
1492
2539
  */
@@ -1543,7 +2590,7 @@ export namespace Transaction {
1543
2590
  }
1544
2591
 
1545
2592
  /**
1546
- * A Inbound Wire Reversal object. This field will be present in the JSON response
2593
+ * An Inbound Wire Reversal object. This field will be present in the JSON response
1547
2594
  * if and only if `category` is equal to `inbound_wire_reversal`.
1548
2595
  */
1549
2596
  export interface InboundWireReversal {
@@ -1626,7 +2673,7 @@ export namespace Transaction {
1626
2673
  }
1627
2674
 
1628
2675
  /**
1629
- * A Inbound Wire Transfer object. This field will be present in the JSON response
2676
+ * An Inbound Wire Transfer object. This field will be present in the JSON response
1630
2677
  * if and only if `category` is equal to `inbound_wire_transfer`.
1631
2678
  */
1632
2679
  export interface InboundWireTransfer {
@@ -1670,7 +2717,7 @@ export namespace Transaction {
1670
2717
  }
1671
2718
 
1672
2719
  /**
1673
- * A Interest Payment object. This field will be present in the JSON response if
2720
+ * An Interest Payment object. This field will be present in the JSON response if
1674
2721
  * and only if `category` is equal to `interest_payment`.
1675
2722
  */
1676
2723
  export interface InterestPayment {
@@ -1710,8 +2757,8 @@ export namespace Transaction {
1710
2757
  }
1711
2758
 
1712
2759
  /**
1713
- * A Internal Source object. This field will be present in the JSON response if and
1714
- * only if `category` is equal to `internal_source`.
2760
+ * An Internal Source object. This field will be present in the JSON response if
2761
+ * and only if `category` is equal to `internal_source`.
1715
2762
  */
1716
2763
  export interface InternalSource {
1717
2764
  /**
@@ -1737,6 +2784,7 @@ export namespace Transaction {
1737
2784
  * - `account_closure` - Account closure
1738
2785
  * - `bank_migration` - Bank migration
1739
2786
  * - `cashback` - Cashback
2787
+ * - `check_adjustment` - Check adjustment
1740
2788
  * - `collection_receivable` - Collection receivable
1741
2789
  * - `empyreal_adjustment` - Empyreal adjustment
1742
2790
  * - `error` - Error
@@ -1751,6 +2799,7 @@ export namespace Transaction {
1751
2799
  | 'account_closure'
1752
2800
  | 'bank_migration'
1753
2801
  | 'cashback'
2802
+ | 'check_adjustment'
1754
2803
  | 'collection_receivable'
1755
2804
  | 'empyreal_adjustment'
1756
2805
  | 'error'
@@ -1879,7 +2928,6 @@ export namespace TransactionListParams {
1879
2928
  | 'check_deposit_return'
1880
2929
  | 'check_transfer_deposit'
1881
2930
  | 'check_transfer_intention'
1882
- | 'check_transfer_rejection'
1883
2931
  | 'check_transfer_stop_payment_request'
1884
2932
  | 'fee_payment'
1885
2933
  | 'inbound_ach_transfer'