increase 0.370.0 → 0.372.0

package/src/resources/card-push-transfers.ts

@@ -13,7 +13,6 @@ export class CardPushTransfers extends APIResource {
    * ```ts
    * const cardPushTransfer =
    *   await client.cardPushTransfers.create({
-   *     amount: 100,
    *     business_application_identifier: 'funds_disbursement',
    *     card_token_id:
    *       'outbound_card_token_zlt0ml6youq3q7vcdlg0',
@@ -23,6 +22,10 @@ export class CardPushTransfers extends APIResource {
    *     merchant_name_prefix: 'Acme',
    *     merchant_postal_code: '10045',
    *     merchant_state: 'NY',
+   *     presentment_amount: {
+   *       currency: 'USD',
+   *       value: '1234.56',
+   *     },
    *     recipient_name: 'Ian Crease',
    *     sender_address_city: 'New York',
    *     sender_address_line1: '33 Liberty Street',
@@ -135,11 +138,6 @@ export interface CardPushTransfer {
    */
   account_id: string;
 
-  /**
-   * The transfer amount in USD cents.
-   */
-  amount: number;
-
   /**
    * If your account requires approvals for transfers and the transfer was approved,
    * this will contain details of the approval.
@@ -199,14 +197,6 @@ export interface CardPushTransfer {
    */
   created_by: CardPushTransfer.CreatedBy | null;
 
-  /**
-   * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's
-   * currency.
-   *
-   * - `USD` - US Dollar (USD)
-   */
-  currency: 'USD';
-
   /**
    * If the transfer is rejected by the card network or the destination financial
    * institution, this will contain supplemental details.
@@ -256,6 +246,13 @@ export interface CardPushTransfer {
    */
   merchant_state: string;
 
+  /**
+   * The amount that was transferred. The receiving bank will have converted this to
+   * the cardholder's currency. The amount that is applied to your Increase account
+   * matches the currency of your account.
+   */
+  presentment_amount: CardPushTransfer.PresentmentAmount;
+
   /**
    * The name of the funds recipient.
    */
@@ -361,6 +358,11 @@ export namespace CardPushTransfer {
      * A unique identifier for the transaction on the card network.
      */
     network_transaction_identifier: string | null;
+
+    /**
+     * The transfer amount in USD cents.
+     */
+    settlement_amount: number;
   }
 
   /**
@@ -600,6 +602,345 @@ export namespace CardPushTransfer {
       | 'revocation_of_all_authorizations_order';
   }
 
+  /**
+   * The amount that was transferred. The receiving bank will have converted this to
+   * the cardholder's currency. The amount that is applied to your Increase account
+   * matches the currency of your account.
+   */
+  export interface PresentmentAmount {
+    /**
+     * The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
+     *
+     * - `AFN` - AFN
+     * - `EUR` - EUR
+     * - `ALL` - ALL
+     * - `DZD` - DZD
+     * - `USD` - USD
+     * - `AOA` - AOA
+     * - `ARS` - ARS
+     * - `AMD` - AMD
+     * - `AWG` - AWG
+     * - `AUD` - AUD
+     * - `AZN` - AZN
+     * - `BSD` - BSD
+     * - `BHD` - BHD
+     * - `BDT` - BDT
+     * - `BBD` - BBD
+     * - `BYN` - BYN
+     * - `BZD` - BZD
+     * - `BMD` - BMD
+     * - `INR` - INR
+     * - `BTN` - BTN
+     * - `BOB` - BOB
+     * - `BOV` - BOV
+     * - `BAM` - BAM
+     * - `BWP` - BWP
+     * - `NOK` - NOK
+     * - `BRL` - BRL
+     * - `BND` - BND
+     * - `BGN` - BGN
+     * - `BIF` - BIF
+     * - `CVE` - CVE
+     * - `KHR` - KHR
+     * - `CAD` - CAD
+     * - `KYD` - KYD
+     * - `CLP` - CLP
+     * - `CLF` - CLF
+     * - `CNY` - CNY
+     * - `COP` - COP
+     * - `COU` - COU
+     * - `KMF` - KMF
+     * - `CDF` - CDF
+     * - `NZD` - NZD
+     * - `CRC` - CRC
+     * - `CUP` - CUP
+     * - `CZK` - CZK
+     * - `DKK` - DKK
+     * - `DJF` - DJF
+     * - `DOP` - DOP
+     * - `EGP` - EGP
+     * - `SVC` - SVC
+     * - `ERN` - ERN
+     * - `SZL` - SZL
+     * - `ETB` - ETB
+     * - `FKP` - FKP
+     * - `FJD` - FJD
+     * - `GMD` - GMD
+     * - `GEL` - GEL
+     * - `GHS` - GHS
+     * - `GIP` - GIP
+     * - `GTQ` - GTQ
+     * - `GBP` - GBP
+     * - `GNF` - GNF
+     * - `GYD` - GYD
+     * - `HTG` - HTG
+     * - `HNL` - HNL
+     * - `HKD` - HKD
+     * - `HUF` - HUF
+     * - `ISK` - ISK
+     * - `IDR` - IDR
+     * - `IRR` - IRR
+     * - `IQD` - IQD
+     * - `ILS` - ILS
+     * - `JMD` - JMD
+     * - `JPY` - JPY
+     * - `JOD` - JOD
+     * - `KZT` - KZT
+     * - `KES` - KES
+     * - `KPW` - KPW
+     * - `KRW` - KRW
+     * - `KWD` - KWD
+     * - `KGS` - KGS
+     * - `LAK` - LAK
+     * - `LBP` - LBP
+     * - `LSL` - LSL
+     * - `ZAR` - ZAR
+     * - `LRD` - LRD
+     * - `LYD` - LYD
+     * - `CHF` - CHF
+     * - `MOP` - MOP
+     * - `MKD` - MKD
+     * - `MGA` - MGA
+     * - `MWK` - MWK
+     * - `MYR` - MYR
+     * - `MVR` - MVR
+     * - `MRU` - MRU
+     * - `MUR` - MUR
+     * - `MXN` - MXN
+     * - `MXV` - MXV
+     * - `MDL` - MDL
+     * - `MNT` - MNT
+     * - `MAD` - MAD
+     * - `MZN` - MZN
+     * - `MMK` - MMK
+     * - `NAD` - NAD
+     * - `NPR` - NPR
+     * - `NIO` - NIO
+     * - `NGN` - NGN
+     * - `OMR` - OMR
+     * - `PKR` - PKR
+     * - `PAB` - PAB
+     * - `PGK` - PGK
+     * - `PYG` - PYG
+     * - `PEN` - PEN
+     * - `PHP` - PHP
+     * - `PLN` - PLN
+     * - `QAR` - QAR
+     * - `RON` - RON
+     * - `RUB` - RUB
+     * - `RWF` - RWF
+     * - `SHP` - SHP
+     * - `WST` - WST
+     * - `STN` - STN
+     * - `SAR` - SAR
+     * - `RSD` - RSD
+     * - `SCR` - SCR
+     * - `SLE` - SLE
+     * - `SGD` - SGD
+     * - `SBD` - SBD
+     * - `SOS` - SOS
+     * - `SSP` - SSP
+     * - `LKR` - LKR
+     * - `SDG` - SDG
+     * - `SRD` - SRD
+     * - `SEK` - SEK
+     * - `CHE` - CHE
+     * - `CHW` - CHW
+     * - `SYP` - SYP
+     * - `TWD` - TWD
+     * - `TJS` - TJS
+     * - `TZS` - TZS
+     * - `THB` - THB
+     * - `TOP` - TOP
+     * - `TTD` - TTD
+     * - `TND` - TND
+     * - `TRY` - TRY
+     * - `TMT` - TMT
+     * - `UGX` - UGX
+     * - `UAH` - UAH
+     * - `AED` - AED
+     * - `USN` - USN
+     * - `UYU` - UYU
+     * - `UYI` - UYI
+     * - `UYW` - UYW
+     * - `UZS` - UZS
+     * - `VUV` - VUV
+     * - `VES` - VES
+     * - `VED` - VED
+     * - `VND` - VND
+     * - `YER` - YER
+     * - `ZMW` - ZMW
+     * - `ZWG` - ZWG
+     */
+    currency:
+      | 'AFN'
+      | 'EUR'
+      | 'ALL'
+      | 'DZD'
+      | 'USD'
+      | 'AOA'
+      | 'ARS'
+      | 'AMD'
+      | 'AWG'
+      | 'AUD'
+      | 'AZN'
+      | 'BSD'
+      | 'BHD'
+      | 'BDT'
+      | 'BBD'
+      | 'BYN'
+      | 'BZD'
+      | 'BMD'
+      | 'INR'
+      | 'BTN'
+      | 'BOB'
+      | 'BOV'
+      | 'BAM'
+      | 'BWP'
+      | 'NOK'
+      | 'BRL'
+      | 'BND'
+      | 'BGN'
+      | 'BIF'
+      | 'CVE'
+      | 'KHR'
+      | 'CAD'
+      | 'KYD'
+      | 'CLP'
+      | 'CLF'
+      | 'CNY'
+      | 'COP'
+      | 'COU'
+      | 'KMF'
+      | 'CDF'
+      | 'NZD'
+      | 'CRC'
+      | 'CUP'
+      | 'CZK'
+      | 'DKK'
+      | 'DJF'
+      | 'DOP'
+      | 'EGP'
+      | 'SVC'
+      | 'ERN'
+      | 'SZL'
+      | 'ETB'
+      | 'FKP'
+      | 'FJD'
+      | 'GMD'
+      | 'GEL'
+      | 'GHS'
+      | 'GIP'
+      | 'GTQ'
+      | 'GBP'
+      | 'GNF'
+      | 'GYD'
+      | 'HTG'
+      | 'HNL'
+      | 'HKD'
+      | 'HUF'
+      | 'ISK'
+      | 'IDR'
+      | 'IRR'
+      | 'IQD'
+      | 'ILS'
+      | 'JMD'
+      | 'JPY'
+      | 'JOD'
+      | 'KZT'
+      | 'KES'
+      | 'KPW'
+      | 'KRW'
+      | 'KWD'
+      | 'KGS'
+      | 'LAK'
+      | 'LBP'
+      | 'LSL'
+      | 'ZAR'
+      | 'LRD'
+      | 'LYD'
+      | 'CHF'
+      | 'MOP'
+      | 'MKD'
+      | 'MGA'
+      | 'MWK'
+      | 'MYR'
+      | 'MVR'
+      | 'MRU'
+      | 'MUR'
+      | 'MXN'
+      | 'MXV'
+      | 'MDL'
+      | 'MNT'
+      | 'MAD'
+      | 'MZN'
+      | 'MMK'
+      | 'NAD'
+      | 'NPR'
+      | 'NIO'
+      | 'NGN'
+      | 'OMR'
+      | 'PKR'
+      | 'PAB'
+      | 'PGK'
+      | 'PYG'
+      | 'PEN'
+      | 'PHP'
+      | 'PLN'
+      | 'QAR'
+      | 'RON'
+      | 'RUB'
+      | 'RWF'
+      | 'SHP'
+      | 'WST'
+      | 'STN'
+      | 'SAR'
+      | 'RSD'
+      | 'SCR'
+      | 'SLE'
+      | 'SGD'
+      | 'SBD'
+      | 'SOS'
+      | 'SSP'
+      | 'LKR'
+      | 'SDG'
+      | 'SRD'
+      | 'SEK'
+      | 'CHE'
+      | 'CHW'
+      | 'SYP'
+      | 'TWD'
+      | 'TJS'
+      | 'TZS'
+      | 'THB'
+      | 'TOP'
+      | 'TTD'
+      | 'TND'
+      | 'TRY'
+      | 'TMT'
+      | 'UGX'
+      | 'UAH'
+      | 'AED'
+      | 'USN'
+      | 'UYU'
+      | 'UYI'
+      | 'UYW'
+      | 'UZS'
+      | 'VUV'
+      | 'VES'
+      | 'VED'
+      | 'VND'
+      | 'YER'
+      | 'ZMW'
+      | 'ZWG';
+
+    /**
+     * The amount value represented as a string containing a decimal number in major
+     * units (so e.g., "12.34" for $12.34).
+     */
+    value: string;
+  }
+
   /**
    * After the transfer is submitted to the card network, this will contain
    * supplemental details.
@@ -631,11 +972,6 @@ export namespace CardPushTransfer {
 }
 
 export interface CardPushTransferCreateParams {
-  /**
-   * The transfer amount in USD cents. For Card Push transfers, must be positive.
-   */
-  amount: number;
-
   /**
    * The Business Application Identifier describes the type of transaction being
    * performed. Your program must be approved for the specified Business Application
@@ -714,6 +1050,13 @@ export interface CardPushTransferCreateParams {
    */
   merchant_state: string;
 
+  /**
+   * The amount to transfer. The receiving bank will convert this to the cardholder's
+   * currency. The amount that is applied to your Increase account matches the
+   * currency of your account.
+   */
+  presentment_amount: CardPushTransferCreateParams.PresentmentAmount;
+
   /**
    * The name of the funds recipient.
    */
@@ -757,6 +1100,350 @@ export interface CardPushTransferCreateParams {
   [k: string]: unknown;
 }
 
+export namespace CardPushTransferCreateParams {
+  /**
+   * The amount to transfer. The receiving bank will convert this to the cardholder's
+   * currency. The amount that is applied to your Increase account matches the
+   * currency of your account.
+   */
+  export interface PresentmentAmount {
+    /**
+     * The ISO 4217 currency code representing the currency of the amount.
+     *
+     * - `AFN` - AFN
+     * - `EUR` - EUR
+     * - `ALL` - ALL
+     * - `DZD` - DZD
+     * - `USD` - USD
+     * - `AOA` - AOA
+     * - `ARS` - ARS
+     * - `AMD` - AMD
+     * - `AWG` - AWG
+     * - `AUD` - AUD
+     * - `AZN` - AZN
+     * - `BSD` - BSD
+     * - `BHD` - BHD
+     * - `BDT` - BDT
+     * - `BBD` - BBD
+     * - `BYN` - BYN
+     * - `BZD` - BZD
+     * - `BMD` - BMD
+     * - `INR` - INR
+     * - `BTN` - BTN
+     * - `BOB` - BOB
+     * - `BOV` - BOV
+     * - `BAM` - BAM
+     * - `BWP` - BWP
+     * - `NOK` - NOK
+     * - `BRL` - BRL
+     * - `BND` - BND
+     * - `BGN` - BGN
+     * - `BIF` - BIF
+     * - `CVE` - CVE
+     * - `KHR` - KHR
+     * - `CAD` - CAD
+     * - `KYD` - KYD
+     * - `CLP` - CLP
+     * - `CLF` - CLF
+     * - `CNY` - CNY
+     * - `COP` - COP
+     * - `COU` - COU
+     * - `KMF` - KMF
+     * - `CDF` - CDF
+     * - `NZD` - NZD
+     * - `CRC` - CRC
+     * - `CUP` - CUP
+     * - `CZK` - CZK
+     * - `DKK` - DKK
+     * - `DJF` - DJF
+     * - `DOP` - DOP
+     * - `EGP` - EGP
+     * - `SVC` - SVC
+     * - `ERN` - ERN
+     * - `SZL` - SZL
+     * - `ETB` - ETB
+     * - `FKP` - FKP
+     * - `FJD` - FJD
+     * - `GMD` - GMD
+     * - `GEL` - GEL
+     * - `GHS` - GHS
+     * - `GIP` - GIP
+     * - `GTQ` - GTQ
+     * - `GBP` - GBP
+     * - `GNF` - GNF
+     * - `GYD` - GYD
+     * - `HTG` - HTG
+     * - `HNL` - HNL
+     * - `HKD` - HKD
+     * - `HUF` - HUF
+     * - `ISK` - ISK
+     * - `IDR` - IDR
+     * - `IRR` - IRR
+     * - `IQD` - IQD
+     * - `ILS` - ILS
+     * - `JMD` - JMD
+     * - `JPY` - JPY
+     * - `JOD` - JOD
+     * - `KZT` - KZT
+     * - `KES` - KES
+     * - `KPW` - KPW
+     * - `KRW` - KRW
+     * - `KWD` - KWD
+     * - `KGS` - KGS
+     * - `LAK` - LAK
+     * - `LBP` - LBP
+     * - `LSL` - LSL
+     * - `ZAR` - ZAR
+     * - `LRD` - LRD
+     * - `LYD` - LYD
+     * - `CHF` - CHF
+     * - `MOP` - MOP
+     * - `MKD` - MKD
+     * - `MGA` - MGA
+     * - `MWK` - MWK
+     * - `MYR` - MYR
+     * - `MVR` - MVR
+     * - `MRU` - MRU
+     * - `MUR` - MUR
+     * - `MXN` - MXN
+     * - `MXV` - MXV
+     * - `MDL` - MDL
+     * - `MNT` - MNT
+     * - `MAD` - MAD
+     * - `MZN` - MZN
+     * - `MMK` - MMK
+     * - `NAD` - NAD
+     * - `NPR` - NPR
+     * - `NIO` - NIO
+     * - `NGN` - NGN
+     * - `OMR` - OMR
+     * - `PKR` - PKR
+     * - `PAB` - PAB
+     * - `PGK` - PGK
+     * - `PYG` - PYG
+     * - `PEN` - PEN
+     * - `PHP` - PHP
+     * - `PLN` - PLN
+     * - `QAR` - QAR
+     * - `RON` - RON
+     * - `RUB` - RUB
+     * - `RWF` - RWF
+     * - `SHP` - SHP
+     * - `WST` - WST
+     * - `STN` - STN
+     * - `SAR` - SAR
+     * - `RSD` - RSD
+     * - `SCR` - SCR
+     * - `SLE` - SLE
+     * - `SGD` - SGD
+     * - `SBD` - SBD
+     * - `SOS` - SOS
+     * - `SSP` - SSP
+     * - `LKR` - LKR
+     * - `SDG` - SDG
+     * - `SRD` - SRD
+     * - `SEK` - SEK
+     * - `CHE` - CHE
+     * - `CHW` - CHW
+     * - `SYP` - SYP
+     * - `TWD` - TWD
+     * - `TJS` - TJS
+     * - `TZS` - TZS
+     * - `THB` - THB
+     * - `TOP` - TOP
+     * - `TTD` - TTD
+     * - `TND` - TND
+     * - `TRY` - TRY
+     * - `TMT` - TMT
+     * - `UGX` - UGX
+     * - `UAH` - UAH
+     * - `AED` - AED
+     * - `USN` - USN
+     * - `UYU` - UYU
+     * - `UYI` - UYI
+     * - `UYW` - UYW
+     * - `UZS` - UZS
+     * - `VUV` - VUV
+     * - `VES` - VES
+     * - `VED` - VED
+     * - `VND` - VND
+     * - `YER` - YER
+     * - `ZMW` - ZMW
+     * - `ZWG` - ZWG
+     */
+    currency:
+      | 'AFN'
+      | 'EUR'
+      | 'ALL'
+      | 'DZD'
+      | 'USD'
+      | 'AOA'
+      | 'ARS'
+      | 'AMD'
+      | 'AWG'
+      | 'AUD'
+      | 'AZN'
+      | 'BSD'
+      | 'BHD'
+      | 'BDT'
+      | 'BBD'
+      | 'BYN'
+      | 'BZD'
+      | 'BMD'
+      | 'INR'
+      | 'BTN'
+      | 'BOB'
+      | 'BOV'
+      | 'BAM'
+      | 'BWP'
+      | 'NOK'
+      | 'BRL'
+      | 'BND'
+      | 'BGN'
+      | 'BIF'
+      | 'CVE'
+      | 'KHR'
+      | 'CAD'
+      | 'KYD'
+      | 'CLP'
+      | 'CLF'
+      | 'CNY'
+      | 'COP'
+      | 'COU'
+      | 'KMF'
+      | 'CDF'
+      | 'NZD'
+      | 'CRC'
+      | 'CUP'
+      | 'CZK'
+      | 'DKK'
+      | 'DJF'
+      | 'DOP'
+      | 'EGP'
+      | 'SVC'
+      | 'ERN'
+      | 'SZL'
+      | 'ETB'
+      | 'FKP'
+      | 'FJD'
+      | 'GMD'
+      | 'GEL'
+      | 'GHS'
+      | 'GIP'
+      | 'GTQ'
+      | 'GBP'
+      | 'GNF'
+      | 'GYD'
+      | 'HTG'
+      | 'HNL'
+      | 'HKD'
+      | 'HUF'
+      | 'ISK'
+      | 'IDR'
+      | 'IRR'
+      | 'IQD'
+      | 'ILS'
+      | 'JMD'
+      | 'JPY'
+      | 'JOD'
+      | 'KZT'
+      | 'KES'
+      | 'KPW'
+      | 'KRW'
+      | 'KWD'
+      | 'KGS'
+      | 'LAK'
+      | 'LBP'
+      | 'LSL'
+      | 'ZAR'
+      | 'LRD'
+      | 'LYD'
+      | 'CHF'
+      | 'MOP'
+      | 'MKD'
+      | 'MGA'
+      | 'MWK'
+      | 'MYR'
+      | 'MVR'
+      | 'MRU'
+      | 'MUR'
+      | 'MXN'
+      | 'MXV'
+      | 'MDL'
+      | 'MNT'
+      | 'MAD'
+      | 'MZN'
+      | 'MMK'
+      | 'NAD'
+      | 'NPR'
+      | 'NIO'
+      | 'NGN'
+      | 'OMR'
+      | 'PKR'
+      | 'PAB'
+      | 'PGK'
+      | 'PYG'
+      | 'PEN'
+      | 'PHP'
+      | 'PLN'
+      | 'QAR'
+      | 'RON'
+      | 'RUB'
+      | 'RWF'
+      | 'SHP'
+      | 'WST'
+      | 'STN'
+      | 'SAR'
+      | 'RSD'
+      | 'SCR'
+      | 'SLE'
+      | 'SGD'
+      | 'SBD'
+      | 'SOS'
+      | 'SSP'
+      | 'LKR'
+      | 'SDG'
+      | 'SRD'
+      | 'SEK'
+      | 'CHE'
+      | 'CHW'
+      | 'SYP'
+      | 'TWD'
+      | 'TJS'
+      | 'TZS'
+      | 'THB'
+      | 'TOP'
+      | 'TTD'
+      | 'TND'
+      | 'TRY'
+      | 'TMT'
+      | 'UGX'
+      | 'UAH'
+      | 'AED'
+      | 'USN'
+      | 'UYU'
+      | 'UYI'
+      | 'UYW'
+      | 'UZS'
+      | 'VUV'
+      | 'VES'
+      | 'VED'
+      | 'VND'
+      | 'YER'
+      | 'ZMW'
+      | 'ZWG';
+
+    /**
+     * The amount value as a decimal string in the currency's major unit. For example,
+     * for USD, '1234.56' represents 1234 dollars and 56 cents. For JPY, '1234'
+     * represents 1234 yen. A currency with minor units requires at least one decimal
+     * place and supports up to the number of decimal places defined by the currency's
+     * minor units. A currency without minor units does not support any decimal places.
+     */
+    value: string;
+  }
+}
+
 export interface CardPushTransferListParams extends PageParams {
   /**
    * Filter Card Push Transfers to ones belonging to the specified Account.