diff --git a/.release-please-manifest.json b/.release-please-manifest.json index d05d9de1..ce10d673 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.462.0" + ".": "0.463.0" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index 46d00e01..d76d554a 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 236 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-57310f0e57b0996b79f938ef778b40e54f5b62cefb78c3e6405cefacfa704c66.yml -openapi_spec_hash: c6d65e9ebf76cb81a5395b8ab4251a95 -config_hash: 0997ade8b52ec04e82d5b0c3b61bb51e +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-1537e933795625528b93b601e286a513458f9aad05160ee018383e6b29986956.yml +openapi_spec_hash: f34d800917618bf012b466c1f88e8eca +config_hash: 4945e03affdf289484733306e4797f81 diff --git a/CHANGELOG.md b/CHANGELOG.md index 85c6f314..f3b3e2f7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 0.463.0 (2026-03-30) + +Full Changelog: [v0.462.0...v0.463.0](https://github.com/Increase/increase-python/compare/v0.462.0...v0.463.0) + +### Features + +* **api:** api update ([3585bbe](https://github.com/Increase/increase-python/commit/3585bbe398ac70ab932cc2374e021dc4fd717255)) + ## 0.462.0 (2026-03-27) Full Changelog: [v0.461.0...v0.462.0](https://github.com/Increase/increase-python/compare/v0.461.0...v0.462.0) diff --git a/pyproject.toml b/pyproject.toml index 883c7551..e77b9a34 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "increase" -version = "0.462.0" +version = "0.463.0" description = "The official Python library for the increase API" dynamic = ["readme"] license = "Apache-2.0" diff --git a/src/increase/_version.py b/src/increase/_version.py index 538075a5..60623d87 100644 --- a/src/increase/_version.py +++ b/src/increase/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. __title__ = "increase" -__version__ = "0.462.0" # x-release-please-version +__version__ = "0.463.0" # x-release-please-version diff --git a/src/increase/types/card_payment.py b/src/increase/types/card_payment.py index a2788095..1b37c193 100644 --- a/src/increase/types/card_payment.py +++ b/src/increase/types/card_payment.py @@ -36,6 +36,7 @@ "ElementCardAuthorizationNetworkDetailsPulse", "ElementCardAuthorizationNetworkDetailsVisa", "ElementCardAuthorizationNetworkIdentifiers", + "ElementCardAuthorizationSchemeFee", "ElementCardAuthorizationVerification", "ElementCardAuthorizationVerificationCardVerificationCode", "ElementCardAuthorizationVerificationCardholderAddress", @@ -57,6 +58,7 @@ "ElementCardBalanceInquiryNetworkDetailsPulse", "ElementCardBalanceInquiryNetworkDetailsVisa", "ElementCardBalanceInquiryNetworkIdentifiers", + "ElementCardBalanceInquirySchemeFee", "ElementCardBalanceInquiryVerification", "ElementCardBalanceInquiryVerificationCardVerificationCode", "ElementCardBalanceInquiryVerificationCardholderAddress", @@ -77,6 +79,7 @@ "ElementCardDeclineNetworkDetailsPulse", "ElementCardDeclineNetworkDetailsVisa", "ElementCardDeclineNetworkIdentifiers", + "ElementCardDeclineSchemeFee", "ElementCardDeclineVerification", "ElementCardDeclineVerificationCardVerificationCode", "ElementCardDeclineVerificationCardholderAddress", @@ -97,12 +100,14 @@ "ElementCardFinancialNetworkDetailsPulse", "ElementCardFinancialNetworkDetailsVisa", "ElementCardFinancialNetworkIdentifiers", + "ElementCardFinancialSchemeFee", "ElementCardFinancialVerification", "ElementCardFinancialVerificationCardVerificationCode", "ElementCardFinancialVerificationCardholderAddress", "ElementCardFinancialVerificationCardholderName", "ElementCardFuelConfirmation", "ElementCardFuelConfirmationNetworkIdentifiers", + "ElementCardFuelConfirmationSchemeFee", "ElementCardIncrement", "ElementCardIncrementAdditionalAmounts", "ElementCardIncrementAdditionalAmountsClinic", @@ -116,6 +121,7 @@ "ElementCardIncrementAdditionalAmountsUnknown", "ElementCardIncrementAdditionalAmountsVision", "ElementCardIncrementNetworkIdentifiers", + "ElementCardIncrementSchemeFee", "ElementCardRefund", "ElementCardRefundCashback", "ElementCardRefundInterchange", @@ -127,8 +133,10 @@ "ElementCardRefundPurchaseDetailsTravelAncillary", "ElementCardRefundPurchaseDetailsTravelAncillaryService", "ElementCardRefundPurchaseDetailsTravelTripLeg", + "ElementCardRefundSchemeFee", "ElementCardReversal", "ElementCardReversalNetworkIdentifiers", + "ElementCardReversalSchemeFee", "ElementCardSettlement", "ElementCardSettlementCashback", "ElementCardSettlementInterchange", @@ -140,6 +148,7 @@ "ElementCardSettlementPurchaseDetailsTravelAncillary", "ElementCardSettlementPurchaseDetailsTravelAncillaryService", "ElementCardSettlementPurchaseDetailsTravelTripLeg", + "ElementCardSettlementSchemeFee", "ElementCardSettlementSurcharge", "ElementCardValidation", "ElementCardValidationAdditionalAmounts", @@ -157,12 +166,12 @@ "ElementCardValidationNetworkDetailsPulse", "ElementCardValidationNetworkDetailsVisa", "ElementCardValidationNetworkIdentifiers", + "ElementCardValidationSchemeFee", "ElementCardValidationVerification", "ElementCardValidationVerificationCardVerificationCode", "ElementCardValidationVerificationCardholderAddress", "ElementCardValidationVerificationCardholderName", "ElementOther", - "SchemeFee", "State", ] @@ -1064,6 +1073,158 @@ class ElementCardAuthorizationNetworkIdentifiers(BaseModel): """ +class ElementCardAuthorizationSchemeFee(BaseModel): + amount: str + """The fee amount given as a string containing a decimal number.""" + + created_at: datetime + """ + The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was + created. + """ + + currency: Literal["USD"] + """ + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee + reimbursement. + + - `USD` - US Dollar (USD) + """ + + fee_type: Literal[ + "visa_international_service_assessment_single_currency", + "visa_international_service_assessment_cross_currency", + "visa_authorization_domestic_point_of_sale", + "visa_authorization_international_point_of_sale", + "visa_authorization_canada_point_of_sale", + "visa_authorization_reversal_point_of_sale", + "visa_authorization_reversal_international_point_of_sale", + "visa_authorization_address_verification_service", + "visa_advanced_authorization", + "visa_message_transmission", + "visa_account_verification_domestic", + "visa_account_verification_international", + "visa_account_verification_canada", + "visa_corporate_acceptance_fee", + "visa_consumer_debit_acceptance_fee", + "visa_business_debit_acceptance_fee", + "visa_purchasing_acceptance_fee", + "visa_purchase_domestic", + "visa_purchase_international", + "visa_credit_purchase_token", + "visa_debit_purchase_token", + "visa_clearing_transmission", + "visa_direct_authorization", + "visa_direct_transaction_domestic", + "visa_service_commercial_credit", + "visa_advertising_service_commercial_credit", + "visa_community_growth_acceleration_program", + "visa_processing_guarantee_commercial_credit", + "pulse_switch_fee", + ] + """The type of fee being assessed. + + - `visa_international_service_assessment_single_currency` - International + Service Assessment (ISA) single-currency is a fee assessed by the card network + for cross-border transactions presented and settled in the same currency. + - `visa_international_service_assessment_cross_currency` - International Service + Assessment (ISA) cross-currency is a fee assessed by the card network for + cross-border transactions presented and settled in different currencies. + - `visa_authorization_domestic_point_of_sale` - Activity and charges for Visa + Settlement System processing for POS (Point-Of-Sale) authorization + transactions. Authorization is the process of approving or declining the + transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_international_point_of_sale` - Activity and charges for + Visa Settlement System processing for POS (Point-Of-Sale) International + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_canada_point_of_sale` - Activity and charges for Visa + Settlement System processing for Canada Region POS (Point-of-Sale) + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. + - `visa_authorization_reversal_point_of_sale` - Activity only for Visa + Settlement System authorization processing of POS (Point-Of-Sale) reversal + transactions. Authorization reversal represents a VSS message that undoes the + complete or partial actions of a previous authorization request. + - `visa_authorization_reversal_international_point_of_sale` - Activity only for + Visa Settlement System authorization processing of POS (Point-Of-Sale) + International reversal transactions. Authorization reversal represents a VSS + message that undoes the complete or partial actions of a previous + authorization request. + - `visa_authorization_address_verification_service` - A per Address Verification + Service (AVS) result fee. Applies to all usable AVS result codes. + - `visa_advanced_authorization` - Advanced Authorization is a fraud detection + tool that monitors and risk evaluates 100 percent of US VisaNet authorizations + in real-time. Activity related to Purchase (includes Signature Authenticated + Visa and PIN Authenticated Visa Debit (PAVD) transactions). + - `visa_message_transmission` - Issuer Transactions Visa represents a charge + based on total actual monthly processing (Visa transactions only) through a + VisaNet Access Point (VAP). Charges are assessed to the processor for each + VisaNet Access Point. + - `visa_account_verification_domestic` - Activity, per inquiry, related to the + domestic Issuer for Account Number Verification. + - `visa_account_verification_international` - Activity, per inquiry, related to + the international Issuer for Account Number Verification. + - `visa_account_verification_canada` - Activity, per inquiry, related to the + US-Canada Issuer for Account Number Verification. + - `visa_corporate_acceptance_fee` - The Corporate Acceptance Fee is charged to + issuers and is based on the monthly sales volume on Commercial and Government + Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. + - `visa_consumer_debit_acceptance_fee` - The Consumer Debit Acceptance Fee is + charged to issuers and is based on the monthly sales volume of Consumer Debit + or Prepaid card transactions. The cashback portion of a Debit and Prepaid card + transaction is excluded from the sales volume calculation. + - `visa_business_debit_acceptance_fee` - The Business Acceptance Fee is charged + to issuers and is based on the monthly sales volume on Business Debit, + Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback + portion is included in the sales volume calculation with the exception of a + Debit and Prepaid card transactions. + - `visa_purchasing_acceptance_fee` - The Purchasing Card Acceptance Fee is + charged to issuers and is based on the monthly sales volume on Commercial and + Government Debit, Prepaid, Credit, Charge, or Deferred Debit card + transactions. + - `visa_purchase_domestic` - Activity and fees for the processing of a sales + draft original for a purchase transaction. + - `visa_purchase_international` - Activity and fees for the processing of an + international sales draft original for a purchase transaction. + - `visa_credit_purchase_token` - Apple Pay Credit Product Token Purchase + Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for + Apple Pay transactions. + - `visa_debit_purchase_token` - Apple Pay Debit Product Token Purchase Original + Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay + transactions. + - `visa_clearing_transmission` - A per transaction fee assessed for Base II + financial draft - Issuer. + - `visa_direct_authorization` - Issuer charge for Non-Financial OCT/AFT + Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. + - `visa_direct_transaction_domestic` - Data processing charge for Visa Direct + OCTs for all business application identifiers (BAIs) other than money + transfer-bank initiated (BI). BASE II transactions. + - `visa_service_commercial_credit` - Issuer card service fee for Commercial + Credit cards. + - `visa_advertising_service_commercial_credit` - Issuer Advertising Service Fee + for Commercial Credit cards. + - `visa_community_growth_acceleration_program` - Issuer Community Growth + Acceleration Program Fee. + - `visa_processing_guarantee_commercial_credit` - Issuer Processing Guarantee + for Commercial Credit cards. + - `pulse_switch_fee` - Pulse Switch Fee is a fee charged by the Pulse network + for processing transactions on its network. + """ + + fixed_component: Optional[str] = None + """ + The fixed component of the fee, if applicable, given in major units of the fee + amount. + """ + + variable_rate: Optional[str] = None + """ + The variable rate component of the fee, if applicable, given as a decimal (e.g., + 0.015 for 1.5%). + """ + + class ElementCardAuthorizationVerificationCardVerificationCode(BaseModel): """ Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. @@ -1327,6 +1488,9 @@ class ElementCardAuthorization(BaseModel): transaction. """ + scheme_fees: List[ElementCardAuthorizationSchemeFee] + """The scheme fees associated with this card authorization.""" + terminal_id: Optional[str] = None """ The terminal identifier (commonly abbreviated as TID) of the terminal the card @@ -1827,78 +1991,230 @@ class ElementCardBalanceInquiryNetworkIdentifiers(BaseModel): """ -class ElementCardBalanceInquiryVerificationCardVerificationCode(BaseModel): - """ - Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. - """ - - result: Literal["not_checked", "match", "no_match"] - """The result of verifying the Card Verification Code. - - - `not_checked` - No card verification code was provided in the authorization - request. - - `match` - The card verification code matched the one on file. - - `no_match` - The card verification code did not match the one on file. - """ - +class ElementCardBalanceInquirySchemeFee(BaseModel): + amount: str + """The fee amount given as a string containing a decimal number.""" -class ElementCardBalanceInquiryVerificationCardholderAddress(BaseModel): + created_at: datetime """ - Cardholder address provided in the authorization request and the address on file we verified it against. + The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was + created. """ - actual_line1: Optional[str] = None - """Line 1 of the address on file for the cardholder.""" - - actual_postal_code: Optional[str] = None - """The postal code of the address on file for the cardholder.""" - - provided_line1: Optional[str] = None - """ - The cardholder address line 1 provided for verification in the authorization - request. + currency: Literal["USD"] """ + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee + reimbursement. - provided_postal_code: Optional[str] = None - """The postal code provided for verification in the authorization request.""" - - result: Literal[ - "not_checked", - "postal_code_match_address_no_match", - "postal_code_no_match_address_match", - "match", - "no_match", - "postal_code_match_address_not_checked", - ] - """The address verification result returned to the card network. - - - `not_checked` - No address information was provided in the authorization - request. - - `postal_code_match_address_no_match` - Postal code matches, but the street - address does not match or was not provided. - - `postal_code_no_match_address_match` - Postal code does not match, but the - street address matches or was not provided. - - `match` - Postal code and street address match. - - `no_match` - Postal code and street address do not match. - - `postal_code_match_address_not_checked` - Postal code matches, but the street - address was not verified. (deprecated) + - `USD` - US Dollar (USD) """ + fee_type: Literal[ + "visa_international_service_assessment_single_currency", + "visa_international_service_assessment_cross_currency", + "visa_authorization_domestic_point_of_sale", + "visa_authorization_international_point_of_sale", + "visa_authorization_canada_point_of_sale", + "visa_authorization_reversal_point_of_sale", + "visa_authorization_reversal_international_point_of_sale", + "visa_authorization_address_verification_service", + "visa_advanced_authorization", + "visa_message_transmission", + "visa_account_verification_domestic", + "visa_account_verification_international", + "visa_account_verification_canada", + "visa_corporate_acceptance_fee", + "visa_consumer_debit_acceptance_fee", + "visa_business_debit_acceptance_fee", + "visa_purchasing_acceptance_fee", + "visa_purchase_domestic", + "visa_purchase_international", + "visa_credit_purchase_token", + "visa_debit_purchase_token", + "visa_clearing_transmission", + "visa_direct_authorization", + "visa_direct_transaction_domestic", + "visa_service_commercial_credit", + "visa_advertising_service_commercial_credit", + "visa_community_growth_acceleration_program", + "visa_processing_guarantee_commercial_credit", + "pulse_switch_fee", + ] + """The type of fee being assessed. -class ElementCardBalanceInquiryVerificationCardholderName(BaseModel): - """Cardholder name provided in the authorization request.""" - - provided_first_name: Optional[str] = None - """The first name provided for verification in the authorization request.""" - - provided_last_name: Optional[str] = None - """The last name provided for verification in the authorization request.""" - - provided_middle_name: Optional[str] = None - """The middle name provided for verification in the authorization request.""" - - -class ElementCardBalanceInquiryVerification(BaseModel): + - `visa_international_service_assessment_single_currency` - International + Service Assessment (ISA) single-currency is a fee assessed by the card network + for cross-border transactions presented and settled in the same currency. + - `visa_international_service_assessment_cross_currency` - International Service + Assessment (ISA) cross-currency is a fee assessed by the card network for + cross-border transactions presented and settled in different currencies. + - `visa_authorization_domestic_point_of_sale` - Activity and charges for Visa + Settlement System processing for POS (Point-Of-Sale) authorization + transactions. Authorization is the process of approving or declining the + transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_international_point_of_sale` - Activity and charges for + Visa Settlement System processing for POS (Point-Of-Sale) International + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_canada_point_of_sale` - Activity and charges for Visa + Settlement System processing for Canada Region POS (Point-of-Sale) + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. + - `visa_authorization_reversal_point_of_sale` - Activity only for Visa + Settlement System authorization processing of POS (Point-Of-Sale) reversal + transactions. Authorization reversal represents a VSS message that undoes the + complete or partial actions of a previous authorization request. + - `visa_authorization_reversal_international_point_of_sale` - Activity only for + Visa Settlement System authorization processing of POS (Point-Of-Sale) + International reversal transactions. Authorization reversal represents a VSS + message that undoes the complete or partial actions of a previous + authorization request. + - `visa_authorization_address_verification_service` - A per Address Verification + Service (AVS) result fee. Applies to all usable AVS result codes. + - `visa_advanced_authorization` - Advanced Authorization is a fraud detection + tool that monitors and risk evaluates 100 percent of US VisaNet authorizations + in real-time. Activity related to Purchase (includes Signature Authenticated + Visa and PIN Authenticated Visa Debit (PAVD) transactions). + - `visa_message_transmission` - Issuer Transactions Visa represents a charge + based on total actual monthly processing (Visa transactions only) through a + VisaNet Access Point (VAP). Charges are assessed to the processor for each + VisaNet Access Point. + - `visa_account_verification_domestic` - Activity, per inquiry, related to the + domestic Issuer for Account Number Verification. + - `visa_account_verification_international` - Activity, per inquiry, related to + the international Issuer for Account Number Verification. + - `visa_account_verification_canada` - Activity, per inquiry, related to the + US-Canada Issuer for Account Number Verification. + - `visa_corporate_acceptance_fee` - The Corporate Acceptance Fee is charged to + issuers and is based on the monthly sales volume on Commercial and Government + Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. + - `visa_consumer_debit_acceptance_fee` - The Consumer Debit Acceptance Fee is + charged to issuers and is based on the monthly sales volume of Consumer Debit + or Prepaid card transactions. The cashback portion of a Debit and Prepaid card + transaction is excluded from the sales volume calculation. + - `visa_business_debit_acceptance_fee` - The Business Acceptance Fee is charged + to issuers and is based on the monthly sales volume on Business Debit, + Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback + portion is included in the sales volume calculation with the exception of a + Debit and Prepaid card transactions. + - `visa_purchasing_acceptance_fee` - The Purchasing Card Acceptance Fee is + charged to issuers and is based on the monthly sales volume on Commercial and + Government Debit, Prepaid, Credit, Charge, or Deferred Debit card + transactions. + - `visa_purchase_domestic` - Activity and fees for the processing of a sales + draft original for a purchase transaction. + - `visa_purchase_international` - Activity and fees for the processing of an + international sales draft original for a purchase transaction. + - `visa_credit_purchase_token` - Apple Pay Credit Product Token Purchase + Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for + Apple Pay transactions. + - `visa_debit_purchase_token` - Apple Pay Debit Product Token Purchase Original + Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay + transactions. + - `visa_clearing_transmission` - A per transaction fee assessed for Base II + financial draft - Issuer. + - `visa_direct_authorization` - Issuer charge for Non-Financial OCT/AFT + Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. + - `visa_direct_transaction_domestic` - Data processing charge for Visa Direct + OCTs for all business application identifiers (BAIs) other than money + transfer-bank initiated (BI). BASE II transactions. + - `visa_service_commercial_credit` - Issuer card service fee for Commercial + Credit cards. + - `visa_advertising_service_commercial_credit` - Issuer Advertising Service Fee + for Commercial Credit cards. + - `visa_community_growth_acceleration_program` - Issuer Community Growth + Acceleration Program Fee. + - `visa_processing_guarantee_commercial_credit` - Issuer Processing Guarantee + for Commercial Credit cards. + - `pulse_switch_fee` - Pulse Switch Fee is a fee charged by the Pulse network + for processing transactions on its network. + """ + + fixed_component: Optional[str] = None + """ + The fixed component of the fee, if applicable, given in major units of the fee + amount. + """ + + variable_rate: Optional[str] = None + """ + The variable rate component of the fee, if applicable, given as a decimal (e.g., + 0.015 for 1.5%). + """ + + +class ElementCardBalanceInquiryVerificationCardVerificationCode(BaseModel): + """ + Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. + """ + + result: Literal["not_checked", "match", "no_match"] + """The result of verifying the Card Verification Code. + + - `not_checked` - No card verification code was provided in the authorization + request. + - `match` - The card verification code matched the one on file. + - `no_match` - The card verification code did not match the one on file. + """ + + +class ElementCardBalanceInquiryVerificationCardholderAddress(BaseModel): + """ + Cardholder address provided in the authorization request and the address on file we verified it against. + """ + + actual_line1: Optional[str] = None + """Line 1 of the address on file for the cardholder.""" + + actual_postal_code: Optional[str] = None + """The postal code of the address on file for the cardholder.""" + + provided_line1: Optional[str] = None + """ + The cardholder address line 1 provided for verification in the authorization + request. + """ + + provided_postal_code: Optional[str] = None + """The postal code provided for verification in the authorization request.""" + + result: Literal[ + "not_checked", + "postal_code_match_address_no_match", + "postal_code_no_match_address_match", + "match", + "no_match", + "postal_code_match_address_not_checked", + ] + """The address verification result returned to the card network. + + - `not_checked` - No address information was provided in the authorization + request. + - `postal_code_match_address_no_match` - Postal code matches, but the street + address does not match or was not provided. + - `postal_code_no_match_address_match` - Postal code does not match, but the + street address matches or was not provided. + - `match` - Postal code and street address match. + - `no_match` - Postal code and street address do not match. + - `postal_code_match_address_not_checked` - Postal code matches, but the street + address was not verified. (deprecated) + """ + + +class ElementCardBalanceInquiryVerificationCardholderName(BaseModel): + """Cardholder name provided in the authorization request.""" + + provided_first_name: Optional[str] = None + """The first name provided for verification in the authorization request.""" + + provided_last_name: Optional[str] = None + """The last name provided for verification in the authorization request.""" + + provided_middle_name: Optional[str] = None + """The middle name provided for verification in the authorization request.""" + + +class ElementCardBalanceInquiryVerification(BaseModel): """Fields related to verification of cardholder-provided values.""" card_verification_code: ElementCardBalanceInquiryVerificationCardVerificationCode @@ -2013,6 +2329,9 @@ class ElementCardBalanceInquiry(BaseModel): transaction. """ + scheme_fees: List[ElementCardBalanceInquirySchemeFee] + """The scheme fees associated with this card balance inquiry.""" + terminal_id: Optional[str] = None """ The terminal identifier (commonly abbreviated as TID) of the terminal the card @@ -2461,56 +2780,208 @@ class ElementCardDeclineNetworkIdentifiers(BaseModel): """ -class ElementCardDeclineVerificationCardVerificationCode(BaseModel): - """ - Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. - """ - - result: Literal["not_checked", "match", "no_match"] - """The result of verifying the Card Verification Code. - - - `not_checked` - No card verification code was provided in the authorization - request. - - `match` - The card verification code matched the one on file. - - `no_match` - The card verification code did not match the one on file. - """ - +class ElementCardDeclineSchemeFee(BaseModel): + amount: str + """The fee amount given as a string containing a decimal number.""" -class ElementCardDeclineVerificationCardholderAddress(BaseModel): + created_at: datetime """ - Cardholder address provided in the authorization request and the address on file we verified it against. + The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was + created. """ - actual_line1: Optional[str] = None - """Line 1 of the address on file for the cardholder.""" - - actual_postal_code: Optional[str] = None - """The postal code of the address on file for the cardholder.""" - - provided_line1: Optional[str] = None - """ - The cardholder address line 1 provided for verification in the authorization - request. + currency: Literal["USD"] """ + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee + reimbursement. - provided_postal_code: Optional[str] = None - """The postal code provided for verification in the authorization request.""" + - `USD` - US Dollar (USD) + """ - result: Literal[ - "not_checked", - "postal_code_match_address_no_match", - "postal_code_no_match_address_match", - "match", - "no_match", - "postal_code_match_address_not_checked", + fee_type: Literal[ + "visa_international_service_assessment_single_currency", + "visa_international_service_assessment_cross_currency", + "visa_authorization_domestic_point_of_sale", + "visa_authorization_international_point_of_sale", + "visa_authorization_canada_point_of_sale", + "visa_authorization_reversal_point_of_sale", + "visa_authorization_reversal_international_point_of_sale", + "visa_authorization_address_verification_service", + "visa_advanced_authorization", + "visa_message_transmission", + "visa_account_verification_domestic", + "visa_account_verification_international", + "visa_account_verification_canada", + "visa_corporate_acceptance_fee", + "visa_consumer_debit_acceptance_fee", + "visa_business_debit_acceptance_fee", + "visa_purchasing_acceptance_fee", + "visa_purchase_domestic", + "visa_purchase_international", + "visa_credit_purchase_token", + "visa_debit_purchase_token", + "visa_clearing_transmission", + "visa_direct_authorization", + "visa_direct_transaction_domestic", + "visa_service_commercial_credit", + "visa_advertising_service_commercial_credit", + "visa_community_growth_acceleration_program", + "visa_processing_guarantee_commercial_credit", + "pulse_switch_fee", ] - """The address verification result returned to the card network. + """The type of fee being assessed. - - `not_checked` - No address information was provided in the authorization - request. - - `postal_code_match_address_no_match` - Postal code matches, but the street - address does not match or was not provided. - - `postal_code_no_match_address_match` - Postal code does not match, but the + - `visa_international_service_assessment_single_currency` - International + Service Assessment (ISA) single-currency is a fee assessed by the card network + for cross-border transactions presented and settled in the same currency. + - `visa_international_service_assessment_cross_currency` - International Service + Assessment (ISA) cross-currency is a fee assessed by the card network for + cross-border transactions presented and settled in different currencies. + - `visa_authorization_domestic_point_of_sale` - Activity and charges for Visa + Settlement System processing for POS (Point-Of-Sale) authorization + transactions. Authorization is the process of approving or declining the + transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_international_point_of_sale` - Activity and charges for + Visa Settlement System processing for POS (Point-Of-Sale) International + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_canada_point_of_sale` - Activity and charges for Visa + Settlement System processing for Canada Region POS (Point-of-Sale) + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. + - `visa_authorization_reversal_point_of_sale` - Activity only for Visa + Settlement System authorization processing of POS (Point-Of-Sale) reversal + transactions. Authorization reversal represents a VSS message that undoes the + complete or partial actions of a previous authorization request. + - `visa_authorization_reversal_international_point_of_sale` - Activity only for + Visa Settlement System authorization processing of POS (Point-Of-Sale) + International reversal transactions. Authorization reversal represents a VSS + message that undoes the complete or partial actions of a previous + authorization request. + - `visa_authorization_address_verification_service` - A per Address Verification + Service (AVS) result fee. Applies to all usable AVS result codes. + - `visa_advanced_authorization` - Advanced Authorization is a fraud detection + tool that monitors and risk evaluates 100 percent of US VisaNet authorizations + in real-time. Activity related to Purchase (includes Signature Authenticated + Visa and PIN Authenticated Visa Debit (PAVD) transactions). + - `visa_message_transmission` - Issuer Transactions Visa represents a charge + based on total actual monthly processing (Visa transactions only) through a + VisaNet Access Point (VAP). Charges are assessed to the processor for each + VisaNet Access Point. + - `visa_account_verification_domestic` - Activity, per inquiry, related to the + domestic Issuer for Account Number Verification. + - `visa_account_verification_international` - Activity, per inquiry, related to + the international Issuer for Account Number Verification. + - `visa_account_verification_canada` - Activity, per inquiry, related to the + US-Canada Issuer for Account Number Verification. + - `visa_corporate_acceptance_fee` - The Corporate Acceptance Fee is charged to + issuers and is based on the monthly sales volume on Commercial and Government + Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. + - `visa_consumer_debit_acceptance_fee` - The Consumer Debit Acceptance Fee is + charged to issuers and is based on the monthly sales volume of Consumer Debit + or Prepaid card transactions. The cashback portion of a Debit and Prepaid card + transaction is excluded from the sales volume calculation. + - `visa_business_debit_acceptance_fee` - The Business Acceptance Fee is charged + to issuers and is based on the monthly sales volume on Business Debit, + Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback + portion is included in the sales volume calculation with the exception of a + Debit and Prepaid card transactions. + - `visa_purchasing_acceptance_fee` - The Purchasing Card Acceptance Fee is + charged to issuers and is based on the monthly sales volume on Commercial and + Government Debit, Prepaid, Credit, Charge, or Deferred Debit card + transactions. + - `visa_purchase_domestic` - Activity and fees for the processing of a sales + draft original for a purchase transaction. + - `visa_purchase_international` - Activity and fees for the processing of an + international sales draft original for a purchase transaction. + - `visa_credit_purchase_token` - Apple Pay Credit Product Token Purchase + Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for + Apple Pay transactions. + - `visa_debit_purchase_token` - Apple Pay Debit Product Token Purchase Original + Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay + transactions. + - `visa_clearing_transmission` - A per transaction fee assessed for Base II + financial draft - Issuer. + - `visa_direct_authorization` - Issuer charge for Non-Financial OCT/AFT + Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. + - `visa_direct_transaction_domestic` - Data processing charge for Visa Direct + OCTs for all business application identifiers (BAIs) other than money + transfer-bank initiated (BI). BASE II transactions. + - `visa_service_commercial_credit` - Issuer card service fee for Commercial + Credit cards. + - `visa_advertising_service_commercial_credit` - Issuer Advertising Service Fee + for Commercial Credit cards. + - `visa_community_growth_acceleration_program` - Issuer Community Growth + Acceleration Program Fee. + - `visa_processing_guarantee_commercial_credit` - Issuer Processing Guarantee + for Commercial Credit cards. + - `pulse_switch_fee` - Pulse Switch Fee is a fee charged by the Pulse network + for processing transactions on its network. + """ + + fixed_component: Optional[str] = None + """ + The fixed component of the fee, if applicable, given in major units of the fee + amount. + """ + + variable_rate: Optional[str] = None + """ + The variable rate component of the fee, if applicable, given as a decimal (e.g., + 0.015 for 1.5%). + """ + + +class ElementCardDeclineVerificationCardVerificationCode(BaseModel): + """ + Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. + """ + + result: Literal["not_checked", "match", "no_match"] + """The result of verifying the Card Verification Code. + + - `not_checked` - No card verification code was provided in the authorization + request. + - `match` - The card verification code matched the one on file. + - `no_match` - The card verification code did not match the one on file. + """ + + +class ElementCardDeclineVerificationCardholderAddress(BaseModel): + """ + Cardholder address provided in the authorization request and the address on file we verified it against. + """ + + actual_line1: Optional[str] = None + """Line 1 of the address on file for the cardholder.""" + + actual_postal_code: Optional[str] = None + """The postal code of the address on file for the cardholder.""" + + provided_line1: Optional[str] = None + """ + The cardholder address line 1 provided for verification in the authorization + request. + """ + + provided_postal_code: Optional[str] = None + """The postal code provided for verification in the authorization request.""" + + result: Literal[ + "not_checked", + "postal_code_match_address_no_match", + "postal_code_no_match_address_match", + "match", + "no_match", + "postal_code_match_address_not_checked", + ] + """The address verification result returned to the card network. + + - `not_checked` - No address information was provided in the authorization + request. + - `postal_code_match_address_no_match` - Postal code matches, but the street + address does not match or was not provided. + - `postal_code_no_match_address_match` - Postal code does not match, but the street address matches or was not provided. - `match` - Postal code and street address match. - `no_match` - Postal code and street address do not match. @@ -2812,6 +3283,9 @@ class ElementCardDecline(BaseModel): reach out to support@increase.com for more information. """ + scheme_fees: List[ElementCardDeclineSchemeFee] + """The scheme fees associated with this card decline.""" + terminal_id: Optional[str] = None """ The terminal identifier (commonly abbreviated as TID) of the terminal the card @@ -3254,78 +3728,230 @@ class ElementCardFinancialNetworkIdentifiers(BaseModel): """ -class ElementCardFinancialVerificationCardVerificationCode(BaseModel): - """ - Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. - """ - - result: Literal["not_checked", "match", "no_match"] - """The result of verifying the Card Verification Code. - - - `not_checked` - No card verification code was provided in the authorization - request. - - `match` - The card verification code matched the one on file. - - `no_match` - The card verification code did not match the one on file. - """ - +class ElementCardFinancialSchemeFee(BaseModel): + amount: str + """The fee amount given as a string containing a decimal number.""" -class ElementCardFinancialVerificationCardholderAddress(BaseModel): + created_at: datetime """ - Cardholder address provided in the authorization request and the address on file we verified it against. + The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was + created. """ - actual_line1: Optional[str] = None - """Line 1 of the address on file for the cardholder.""" - - actual_postal_code: Optional[str] = None - """The postal code of the address on file for the cardholder.""" - - provided_line1: Optional[str] = None - """ - The cardholder address line 1 provided for verification in the authorization - request. + currency: Literal["USD"] """ + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee + reimbursement. - provided_postal_code: Optional[str] = None - """The postal code provided for verification in the authorization request.""" - - result: Literal[ - "not_checked", - "postal_code_match_address_no_match", - "postal_code_no_match_address_match", - "match", - "no_match", - "postal_code_match_address_not_checked", - ] - """The address verification result returned to the card network. - - - `not_checked` - No address information was provided in the authorization - request. - - `postal_code_match_address_no_match` - Postal code matches, but the street - address does not match or was not provided. - - `postal_code_no_match_address_match` - Postal code does not match, but the - street address matches or was not provided. - - `match` - Postal code and street address match. - - `no_match` - Postal code and street address do not match. - - `postal_code_match_address_not_checked` - Postal code matches, but the street - address was not verified. (deprecated) + - `USD` - US Dollar (USD) """ + fee_type: Literal[ + "visa_international_service_assessment_single_currency", + "visa_international_service_assessment_cross_currency", + "visa_authorization_domestic_point_of_sale", + "visa_authorization_international_point_of_sale", + "visa_authorization_canada_point_of_sale", + "visa_authorization_reversal_point_of_sale", + "visa_authorization_reversal_international_point_of_sale", + "visa_authorization_address_verification_service", + "visa_advanced_authorization", + "visa_message_transmission", + "visa_account_verification_domestic", + "visa_account_verification_international", + "visa_account_verification_canada", + "visa_corporate_acceptance_fee", + "visa_consumer_debit_acceptance_fee", + "visa_business_debit_acceptance_fee", + "visa_purchasing_acceptance_fee", + "visa_purchase_domestic", + "visa_purchase_international", + "visa_credit_purchase_token", + "visa_debit_purchase_token", + "visa_clearing_transmission", + "visa_direct_authorization", + "visa_direct_transaction_domestic", + "visa_service_commercial_credit", + "visa_advertising_service_commercial_credit", + "visa_community_growth_acceleration_program", + "visa_processing_guarantee_commercial_credit", + "pulse_switch_fee", + ] + """The type of fee being assessed. -class ElementCardFinancialVerificationCardholderName(BaseModel): - """Cardholder name provided in the authorization request.""" - - provided_first_name: Optional[str] = None - """The first name provided for verification in the authorization request.""" - - provided_last_name: Optional[str] = None - """The last name provided for verification in the authorization request.""" - - provided_middle_name: Optional[str] = None - """The middle name provided for verification in the authorization request.""" - - -class ElementCardFinancialVerification(BaseModel): + - `visa_international_service_assessment_single_currency` - International + Service Assessment (ISA) single-currency is a fee assessed by the card network + for cross-border transactions presented and settled in the same currency. + - `visa_international_service_assessment_cross_currency` - International Service + Assessment (ISA) cross-currency is a fee assessed by the card network for + cross-border transactions presented and settled in different currencies. + - `visa_authorization_domestic_point_of_sale` - Activity and charges for Visa + Settlement System processing for POS (Point-Of-Sale) authorization + transactions. Authorization is the process of approving or declining the + transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_international_point_of_sale` - Activity and charges for + Visa Settlement System processing for POS (Point-Of-Sale) International + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_canada_point_of_sale` - Activity and charges for Visa + Settlement System processing for Canada Region POS (Point-of-Sale) + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. + - `visa_authorization_reversal_point_of_sale` - Activity only for Visa + Settlement System authorization processing of POS (Point-Of-Sale) reversal + transactions. Authorization reversal represents a VSS message that undoes the + complete or partial actions of a previous authorization request. + - `visa_authorization_reversal_international_point_of_sale` - Activity only for + Visa Settlement System authorization processing of POS (Point-Of-Sale) + International reversal transactions. Authorization reversal represents a VSS + message that undoes the complete or partial actions of a previous + authorization request. + - `visa_authorization_address_verification_service` - A per Address Verification + Service (AVS) result fee. Applies to all usable AVS result codes. + - `visa_advanced_authorization` - Advanced Authorization is a fraud detection + tool that monitors and risk evaluates 100 percent of US VisaNet authorizations + in real-time. Activity related to Purchase (includes Signature Authenticated + Visa and PIN Authenticated Visa Debit (PAVD) transactions). + - `visa_message_transmission` - Issuer Transactions Visa represents a charge + based on total actual monthly processing (Visa transactions only) through a + VisaNet Access Point (VAP). Charges are assessed to the processor for each + VisaNet Access Point. + - `visa_account_verification_domestic` - Activity, per inquiry, related to the + domestic Issuer for Account Number Verification. + - `visa_account_verification_international` - Activity, per inquiry, related to + the international Issuer for Account Number Verification. + - `visa_account_verification_canada` - Activity, per inquiry, related to the + US-Canada Issuer for Account Number Verification. + - `visa_corporate_acceptance_fee` - The Corporate Acceptance Fee is charged to + issuers and is based on the monthly sales volume on Commercial and Government + Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. + - `visa_consumer_debit_acceptance_fee` - The Consumer Debit Acceptance Fee is + charged to issuers and is based on the monthly sales volume of Consumer Debit + or Prepaid card transactions. The cashback portion of a Debit and Prepaid card + transaction is excluded from the sales volume calculation. + - `visa_business_debit_acceptance_fee` - The Business Acceptance Fee is charged + to issuers and is based on the monthly sales volume on Business Debit, + Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback + portion is included in the sales volume calculation with the exception of a + Debit and Prepaid card transactions. + - `visa_purchasing_acceptance_fee` - The Purchasing Card Acceptance Fee is + charged to issuers and is based on the monthly sales volume on Commercial and + Government Debit, Prepaid, Credit, Charge, or Deferred Debit card + transactions. + - `visa_purchase_domestic` - Activity and fees for the processing of a sales + draft original for a purchase transaction. + - `visa_purchase_international` - Activity and fees for the processing of an + international sales draft original for a purchase transaction. + - `visa_credit_purchase_token` - Apple Pay Credit Product Token Purchase + Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for + Apple Pay transactions. + - `visa_debit_purchase_token` - Apple Pay Debit Product Token Purchase Original + Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay + transactions. + - `visa_clearing_transmission` - A per transaction fee assessed for Base II + financial draft - Issuer. + - `visa_direct_authorization` - Issuer charge for Non-Financial OCT/AFT + Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. + - `visa_direct_transaction_domestic` - Data processing charge for Visa Direct + OCTs for all business application identifiers (BAIs) other than money + transfer-bank initiated (BI). BASE II transactions. + - `visa_service_commercial_credit` - Issuer card service fee for Commercial + Credit cards. + - `visa_advertising_service_commercial_credit` - Issuer Advertising Service Fee + for Commercial Credit cards. + - `visa_community_growth_acceleration_program` - Issuer Community Growth + Acceleration Program Fee. + - `visa_processing_guarantee_commercial_credit` - Issuer Processing Guarantee + for Commercial Credit cards. + - `pulse_switch_fee` - Pulse Switch Fee is a fee charged by the Pulse network + for processing transactions on its network. + """ + + fixed_component: Optional[str] = None + """ + The fixed component of the fee, if applicable, given in major units of the fee + amount. + """ + + variable_rate: Optional[str] = None + """ + The variable rate component of the fee, if applicable, given as a decimal (e.g., + 0.015 for 1.5%). + """ + + +class ElementCardFinancialVerificationCardVerificationCode(BaseModel): + """ + Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. + """ + + result: Literal["not_checked", "match", "no_match"] + """The result of verifying the Card Verification Code. + + - `not_checked` - No card verification code was provided in the authorization + request. + - `match` - The card verification code matched the one on file. + - `no_match` - The card verification code did not match the one on file. + """ + + +class ElementCardFinancialVerificationCardholderAddress(BaseModel): + """ + Cardholder address provided in the authorization request and the address on file we verified it against. + """ + + actual_line1: Optional[str] = None + """Line 1 of the address on file for the cardholder.""" + + actual_postal_code: Optional[str] = None + """The postal code of the address on file for the cardholder.""" + + provided_line1: Optional[str] = None + """ + The cardholder address line 1 provided for verification in the authorization + request. + """ + + provided_postal_code: Optional[str] = None + """The postal code provided for verification in the authorization request.""" + + result: Literal[ + "not_checked", + "postal_code_match_address_no_match", + "postal_code_no_match_address_match", + "match", + "no_match", + "postal_code_match_address_not_checked", + ] + """The address verification result returned to the card network. + + - `not_checked` - No address information was provided in the authorization + request. + - `postal_code_match_address_no_match` - Postal code matches, but the street + address does not match or was not provided. + - `postal_code_no_match_address_match` - Postal code does not match, but the + street address matches or was not provided. + - `match` - Postal code and street address match. + - `no_match` - Postal code and street address do not match. + - `postal_code_match_address_not_checked` - Postal code matches, but the street + address was not verified. (deprecated) + """ + + +class ElementCardFinancialVerificationCardholderName(BaseModel): + """Cardholder name provided in the authorization request.""" + + provided_first_name: Optional[str] = None + """The first name provided for verification in the authorization request.""" + + provided_last_name: Optional[str] = None + """The last name provided for verification in the authorization request.""" + + provided_middle_name: Optional[str] = None + """The middle name provided for verification in the authorization request.""" + + +class ElementCardFinancialVerification(BaseModel): """Fields related to verification of cardholder-provided values.""" card_verification_code: ElementCardFinancialVerificationCardVerificationCode @@ -3508,6 +4134,9 @@ class ElementCardFinancial(BaseModel): transaction. """ + scheme_fees: List[ElementCardFinancialSchemeFee] + """The scheme fees associated with this card financial.""" + terminal_id: Optional[str] = None """ The terminal identifier (commonly abbreviated as TID) of the terminal the card @@ -3568,58 +4197,213 @@ class ElementCardFuelConfirmationNetworkIdentifiers(BaseModel): """ -class ElementCardFuelConfirmation(BaseModel): - """A Card Fuel Confirmation object. +class ElementCardFuelConfirmationSchemeFee(BaseModel): + amount: str + """The fee amount given as a string containing a decimal number.""" - This field will be present in the JSON response if and only if `category` is equal to `card_fuel_confirmation`. Card Fuel Confirmations update the amount of a Card Authorization after a fuel pump transaction is completed. + created_at: datetime + """ + The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was + created. """ - - id: str - """The Card Fuel Confirmation identifier.""" - - card_authorization_id: str - """The identifier for the Card Authorization this updates.""" currency: Literal["USD"] """ - The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's - currency. + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee + reimbursement. - `USD` - US Dollar (USD) """ - network: Literal["visa", "pulse"] - """The card network used to process this card authorization. - - - `visa` - Visa - - `pulse` - Pulse - """ - - network_identifiers: ElementCardFuelConfirmationNetworkIdentifiers - """Network-specific identifiers for a specific request or transaction.""" - - pending_transaction_id: Optional[str] = None - """ - The identifier of the Pending Transaction associated with this Card Fuel - Confirmation. - """ - - type: Literal["card_fuel_confirmation"] - """A constant representing the object's type. - - For this resource it will always be `card_fuel_confirmation`. - """ - - updated_authorization_amount: int - """ - The updated authorization amount after this fuel confirmation, in the minor unit - of the transaction's currency. For dollars, for example, this is cents. - """ + fee_type: Literal[ + "visa_international_service_assessment_single_currency", + "visa_international_service_assessment_cross_currency", + "visa_authorization_domestic_point_of_sale", + "visa_authorization_international_point_of_sale", + "visa_authorization_canada_point_of_sale", + "visa_authorization_reversal_point_of_sale", + "visa_authorization_reversal_international_point_of_sale", + "visa_authorization_address_verification_service", + "visa_advanced_authorization", + "visa_message_transmission", + "visa_account_verification_domestic", + "visa_account_verification_international", + "visa_account_verification_canada", + "visa_corporate_acceptance_fee", + "visa_consumer_debit_acceptance_fee", + "visa_business_debit_acceptance_fee", + "visa_purchasing_acceptance_fee", + "visa_purchase_domestic", + "visa_purchase_international", + "visa_credit_purchase_token", + "visa_debit_purchase_token", + "visa_clearing_transmission", + "visa_direct_authorization", + "visa_direct_transaction_domestic", + "visa_service_commercial_credit", + "visa_advertising_service_commercial_credit", + "visa_community_growth_acceleration_program", + "visa_processing_guarantee_commercial_credit", + "pulse_switch_fee", + ] + """The type of fee being assessed. - if TYPE_CHECKING: - # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a - # value to this field, so for compatibility we avoid doing it at runtime. - __pydantic_extra__: Dict[str, object] = FieldInfo(init=False) # pyright: ignore[reportIncompatibleVariableOverride] + - `visa_international_service_assessment_single_currency` - International + Service Assessment (ISA) single-currency is a fee assessed by the card network + for cross-border transactions presented and settled in the same currency. + - `visa_international_service_assessment_cross_currency` - International Service + Assessment (ISA) cross-currency is a fee assessed by the card network for + cross-border transactions presented and settled in different currencies. + - `visa_authorization_domestic_point_of_sale` - Activity and charges for Visa + Settlement System processing for POS (Point-Of-Sale) authorization + transactions. Authorization is the process of approving or declining the + transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_international_point_of_sale` - Activity and charges for + Visa Settlement System processing for POS (Point-Of-Sale) International + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_canada_point_of_sale` - Activity and charges for Visa + Settlement System processing for Canada Region POS (Point-of-Sale) + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. + - `visa_authorization_reversal_point_of_sale` - Activity only for Visa + Settlement System authorization processing of POS (Point-Of-Sale) reversal + transactions. Authorization reversal represents a VSS message that undoes the + complete or partial actions of a previous authorization request. + - `visa_authorization_reversal_international_point_of_sale` - Activity only for + Visa Settlement System authorization processing of POS (Point-Of-Sale) + International reversal transactions. Authorization reversal represents a VSS + message that undoes the complete or partial actions of a previous + authorization request. + - `visa_authorization_address_verification_service` - A per Address Verification + Service (AVS) result fee. Applies to all usable AVS result codes. + - `visa_advanced_authorization` - Advanced Authorization is a fraud detection + tool that monitors and risk evaluates 100 percent of US VisaNet authorizations + in real-time. Activity related to Purchase (includes Signature Authenticated + Visa and PIN Authenticated Visa Debit (PAVD) transactions). + - `visa_message_transmission` - Issuer Transactions Visa represents a charge + based on total actual monthly processing (Visa transactions only) through a + VisaNet Access Point (VAP). Charges are assessed to the processor for each + VisaNet Access Point. + - `visa_account_verification_domestic` - Activity, per inquiry, related to the + domestic Issuer for Account Number Verification. + - `visa_account_verification_international` - Activity, per inquiry, related to + the international Issuer for Account Number Verification. + - `visa_account_verification_canada` - Activity, per inquiry, related to the + US-Canada Issuer for Account Number Verification. + - `visa_corporate_acceptance_fee` - The Corporate Acceptance Fee is charged to + issuers and is based on the monthly sales volume on Commercial and Government + Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. + - `visa_consumer_debit_acceptance_fee` - The Consumer Debit Acceptance Fee is + charged to issuers and is based on the monthly sales volume of Consumer Debit + or Prepaid card transactions. The cashback portion of a Debit and Prepaid card + transaction is excluded from the sales volume calculation. + - `visa_business_debit_acceptance_fee` - The Business Acceptance Fee is charged + to issuers and is based on the monthly sales volume on Business Debit, + Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback + portion is included in the sales volume calculation with the exception of a + Debit and Prepaid card transactions. + - `visa_purchasing_acceptance_fee` - The Purchasing Card Acceptance Fee is + charged to issuers and is based on the monthly sales volume on Commercial and + Government Debit, Prepaid, Credit, Charge, or Deferred Debit card + transactions. + - `visa_purchase_domestic` - Activity and fees for the processing of a sales + draft original for a purchase transaction. + - `visa_purchase_international` - Activity and fees for the processing of an + international sales draft original for a purchase transaction. + - `visa_credit_purchase_token` - Apple Pay Credit Product Token Purchase + Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for + Apple Pay transactions. + - `visa_debit_purchase_token` - Apple Pay Debit Product Token Purchase Original + Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay + transactions. + - `visa_clearing_transmission` - A per transaction fee assessed for Base II + financial draft - Issuer. + - `visa_direct_authorization` - Issuer charge for Non-Financial OCT/AFT + Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. + - `visa_direct_transaction_domestic` - Data processing charge for Visa Direct + OCTs for all business application identifiers (BAIs) other than money + transfer-bank initiated (BI). BASE II transactions. + - `visa_service_commercial_credit` - Issuer card service fee for Commercial + Credit cards. + - `visa_advertising_service_commercial_credit` - Issuer Advertising Service Fee + for Commercial Credit cards. + - `visa_community_growth_acceleration_program` - Issuer Community Growth + Acceleration Program Fee. + - `visa_processing_guarantee_commercial_credit` - Issuer Processing Guarantee + for Commercial Credit cards. + - `pulse_switch_fee` - Pulse Switch Fee is a fee charged by the Pulse network + for processing transactions on its network. + """ + + fixed_component: Optional[str] = None + """ + The fixed component of the fee, if applicable, given in major units of the fee + amount. + """ + + variable_rate: Optional[str] = None + """ + The variable rate component of the fee, if applicable, given as a decimal (e.g., + 0.015 for 1.5%). + """ + + +class ElementCardFuelConfirmation(BaseModel): + """A Card Fuel Confirmation object. + + This field will be present in the JSON response if and only if `category` is equal to `card_fuel_confirmation`. Card Fuel Confirmations update the amount of a Card Authorization after a fuel pump transaction is completed. + """ + + id: str + """The Card Fuel Confirmation identifier.""" + + card_authorization_id: str + """The identifier for the Card Authorization this updates.""" + + currency: Literal["USD"] + """ + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's + currency. + + - `USD` - US Dollar (USD) + """ + + network: Literal["visa", "pulse"] + """The card network used to process this card authorization. + + - `visa` - Visa + - `pulse` - Pulse + """ + + network_identifiers: ElementCardFuelConfirmationNetworkIdentifiers + """Network-specific identifiers for a specific request or transaction.""" + + pending_transaction_id: Optional[str] = None + """ + The identifier of the Pending Transaction associated with this Card Fuel + Confirmation. + """ + + scheme_fees: List[ElementCardFuelConfirmationSchemeFee] + """The scheme fees associated with this card fuel confirmation.""" + + type: Literal["card_fuel_confirmation"] + """A constant representing the object's type. + + For this resource it will always be `card_fuel_confirmation`. + """ + + updated_authorization_amount: int + """ + The updated authorization amount after this fuel confirmation, in the minor unit + of the transaction's currency. For dollars, for example, this is cents. + """ + + if TYPE_CHECKING: + # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a + # value to this field, so for compatibility we avoid doing it at runtime. + __pydantic_extra__: Dict[str, object] = FieldInfo(init=False) # pyright: ignore[reportIncompatibleVariableOverride] # Stub to indicate that arbitrary properties are accepted. # To access properties that are not valid identifiers you can use `getattr`, e.g. @@ -3868,80 +4652,232 @@ class ElementCardIncrementNetworkIdentifiers(BaseModel): """ -class ElementCardIncrement(BaseModel): - """A Card Increment object. - - This field will be present in the JSON response if and only if `category` is equal to `card_increment`. Card Increments increase the pending amount of an authorized transaction. - """ - - id: str - """The Card Increment identifier.""" - - actioner: Literal["user", "increase", "network"] - """ - Whether this authorization was approved by Increase, the card network through - stand-in processing, or the user through a real-time decision. - - - `user` - This object was actioned by the user through a real-time decision. - - `increase` - This object was actioned by Increase without user intervention. - - `network` - This object was actioned by the network, through stand-in - processing. - """ +class ElementCardIncrementSchemeFee(BaseModel): + amount: str + """The fee amount given as a string containing a decimal number.""" - additional_amounts: ElementCardIncrementAdditionalAmounts - """ - Additional amounts associated with the card authorization, such as ATM - surcharges fees. These are usually a subset of the `amount` field and are used - to provide more detailed information about the transaction. + created_at: datetime """ - - amount: int - """The amount of this increment in the minor unit of the transaction's currency. - - For dollars, for example, this is cents. + The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was + created. """ - card_authorization_id: str - """The identifier for the Card Authorization this increments.""" - currency: Literal["USD"] """ - The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's - currency. + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee + reimbursement. - `USD` - US Dollar (USD) """ - network: Literal["visa", "pulse"] - """The card network used to process this card authorization. - - - `visa` - Visa - - `pulse` - Pulse - """ - - network_identifiers: ElementCardIncrementNetworkIdentifiers - """Network-specific identifiers for a specific request or transaction.""" - - network_risk_score: Optional[int] = None - """The risk score generated by the card network. - - For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where - 99 is the riskiest. - """ - - pending_transaction_id: Optional[str] = None - """The identifier of the Pending Transaction associated with this Card Increment.""" - - presentment_amount: int - """ - The amount of this increment in the minor unit of the transaction's presentment - currency. - """ + fee_type: Literal[ + "visa_international_service_assessment_single_currency", + "visa_international_service_assessment_cross_currency", + "visa_authorization_domestic_point_of_sale", + "visa_authorization_international_point_of_sale", + "visa_authorization_canada_point_of_sale", + "visa_authorization_reversal_point_of_sale", + "visa_authorization_reversal_international_point_of_sale", + "visa_authorization_address_verification_service", + "visa_advanced_authorization", + "visa_message_transmission", + "visa_account_verification_domestic", + "visa_account_verification_international", + "visa_account_verification_canada", + "visa_corporate_acceptance_fee", + "visa_consumer_debit_acceptance_fee", + "visa_business_debit_acceptance_fee", + "visa_purchasing_acceptance_fee", + "visa_purchase_domestic", + "visa_purchase_international", + "visa_credit_purchase_token", + "visa_debit_purchase_token", + "visa_clearing_transmission", + "visa_direct_authorization", + "visa_direct_transaction_domestic", + "visa_service_commercial_credit", + "visa_advertising_service_commercial_credit", + "visa_community_growth_acceleration_program", + "visa_processing_guarantee_commercial_credit", + "pulse_switch_fee", + ] + """The type of fee being assessed. - presentment_currency: str - """ - The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the - transaction's presentment currency. + - `visa_international_service_assessment_single_currency` - International + Service Assessment (ISA) single-currency is a fee assessed by the card network + for cross-border transactions presented and settled in the same currency. + - `visa_international_service_assessment_cross_currency` - International Service + Assessment (ISA) cross-currency is a fee assessed by the card network for + cross-border transactions presented and settled in different currencies. + - `visa_authorization_domestic_point_of_sale` - Activity and charges for Visa + Settlement System processing for POS (Point-Of-Sale) authorization + transactions. Authorization is the process of approving or declining the + transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_international_point_of_sale` - Activity and charges for + Visa Settlement System processing for POS (Point-Of-Sale) International + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_canada_point_of_sale` - Activity and charges for Visa + Settlement System processing for Canada Region POS (Point-of-Sale) + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. + - `visa_authorization_reversal_point_of_sale` - Activity only for Visa + Settlement System authorization processing of POS (Point-Of-Sale) reversal + transactions. Authorization reversal represents a VSS message that undoes the + complete or partial actions of a previous authorization request. + - `visa_authorization_reversal_international_point_of_sale` - Activity only for + Visa Settlement System authorization processing of POS (Point-Of-Sale) + International reversal transactions. Authorization reversal represents a VSS + message that undoes the complete or partial actions of a previous + authorization request. + - `visa_authorization_address_verification_service` - A per Address Verification + Service (AVS) result fee. Applies to all usable AVS result codes. + - `visa_advanced_authorization` - Advanced Authorization is a fraud detection + tool that monitors and risk evaluates 100 percent of US VisaNet authorizations + in real-time. Activity related to Purchase (includes Signature Authenticated + Visa and PIN Authenticated Visa Debit (PAVD) transactions). + - `visa_message_transmission` - Issuer Transactions Visa represents a charge + based on total actual monthly processing (Visa transactions only) through a + VisaNet Access Point (VAP). Charges are assessed to the processor for each + VisaNet Access Point. + - `visa_account_verification_domestic` - Activity, per inquiry, related to the + domestic Issuer for Account Number Verification. + - `visa_account_verification_international` - Activity, per inquiry, related to + the international Issuer for Account Number Verification. + - `visa_account_verification_canada` - Activity, per inquiry, related to the + US-Canada Issuer for Account Number Verification. + - `visa_corporate_acceptance_fee` - The Corporate Acceptance Fee is charged to + issuers and is based on the monthly sales volume on Commercial and Government + Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. + - `visa_consumer_debit_acceptance_fee` - The Consumer Debit Acceptance Fee is + charged to issuers and is based on the monthly sales volume of Consumer Debit + or Prepaid card transactions. The cashback portion of a Debit and Prepaid card + transaction is excluded from the sales volume calculation. + - `visa_business_debit_acceptance_fee` - The Business Acceptance Fee is charged + to issuers and is based on the monthly sales volume on Business Debit, + Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback + portion is included in the sales volume calculation with the exception of a + Debit and Prepaid card transactions. + - `visa_purchasing_acceptance_fee` - The Purchasing Card Acceptance Fee is + charged to issuers and is based on the monthly sales volume on Commercial and + Government Debit, Prepaid, Credit, Charge, or Deferred Debit card + transactions. + - `visa_purchase_domestic` - Activity and fees for the processing of a sales + draft original for a purchase transaction. + - `visa_purchase_international` - Activity and fees for the processing of an + international sales draft original for a purchase transaction. + - `visa_credit_purchase_token` - Apple Pay Credit Product Token Purchase + Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for + Apple Pay transactions. + - `visa_debit_purchase_token` - Apple Pay Debit Product Token Purchase Original + Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay + transactions. + - `visa_clearing_transmission` - A per transaction fee assessed for Base II + financial draft - Issuer. + - `visa_direct_authorization` - Issuer charge for Non-Financial OCT/AFT + Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. + - `visa_direct_transaction_domestic` - Data processing charge for Visa Direct + OCTs for all business application identifiers (BAIs) other than money + transfer-bank initiated (BI). BASE II transactions. + - `visa_service_commercial_credit` - Issuer card service fee for Commercial + Credit cards. + - `visa_advertising_service_commercial_credit` - Issuer Advertising Service Fee + for Commercial Credit cards. + - `visa_community_growth_acceleration_program` - Issuer Community Growth + Acceleration Program Fee. + - `visa_processing_guarantee_commercial_credit` - Issuer Processing Guarantee + for Commercial Credit cards. + - `pulse_switch_fee` - Pulse Switch Fee is a fee charged by the Pulse network + for processing transactions on its network. + """ + + fixed_component: Optional[str] = None + """ + The fixed component of the fee, if applicable, given in major units of the fee + amount. + """ + + variable_rate: Optional[str] = None + """ + The variable rate component of the fee, if applicable, given as a decimal (e.g., + 0.015 for 1.5%). + """ + + +class ElementCardIncrement(BaseModel): + """A Card Increment object. + + This field will be present in the JSON response if and only if `category` is equal to `card_increment`. Card Increments increase the pending amount of an authorized transaction. + """ + + id: str + """The Card Increment identifier.""" + + actioner: Literal["user", "increase", "network"] + """ + Whether this authorization was approved by Increase, the card network through + stand-in processing, or the user through a real-time decision. + + - `user` - This object was actioned by the user through a real-time decision. + - `increase` - This object was actioned by Increase without user intervention. + - `network` - This object was actioned by the network, through stand-in + processing. + """ + + additional_amounts: ElementCardIncrementAdditionalAmounts + """ + Additional amounts associated with the card authorization, such as ATM + surcharges fees. These are usually a subset of the `amount` field and are used + to provide more detailed information about the transaction. + """ + + amount: int + """The amount of this increment in the minor unit of the transaction's currency. + + For dollars, for example, this is cents. + """ + + card_authorization_id: str + """The identifier for the Card Authorization this increments.""" + + currency: Literal["USD"] + """ + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's + currency. + + - `USD` - US Dollar (USD) + """ + + network: Literal["visa", "pulse"] + """The card network used to process this card authorization. + + - `visa` - Visa + - `pulse` - Pulse + """ + + network_identifiers: ElementCardIncrementNetworkIdentifiers + """Network-specific identifiers for a specific request or transaction.""" + + network_risk_score: Optional[int] = None + """The risk score generated by the card network. + + For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where + 99 is the riskiest. + """ + + pending_transaction_id: Optional[str] = None + """The identifier of the Pending Transaction associated with this Card Increment.""" + + presentment_amount: int + """ + The amount of this increment in the minor unit of the transaction's presentment + currency. + """ + + presentment_currency: str + """ + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the + transaction's presentment currency. """ real_time_decision_id: Optional[str] = None @@ -3950,6 +4886,9 @@ class ElementCardIncrement(BaseModel): incremental authorization. """ + scheme_fees: List[ElementCardIncrementSchemeFee] + """The scheme fees associated with this card increment.""" + type: Literal["card_increment"] """A constant representing the object's type. @@ -4462,6 +5401,158 @@ class ElementCardRefundPurchaseDetails(BaseModel): """Fields specific to travel.""" +class ElementCardRefundSchemeFee(BaseModel): + amount: str + """The fee amount given as a string containing a decimal number.""" + + created_at: datetime + """ + The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was + created. + """ + + currency: Literal["USD"] + """ + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee + reimbursement. + + - `USD` - US Dollar (USD) + """ + + fee_type: Literal[ + "visa_international_service_assessment_single_currency", + "visa_international_service_assessment_cross_currency", + "visa_authorization_domestic_point_of_sale", + "visa_authorization_international_point_of_sale", + "visa_authorization_canada_point_of_sale", + "visa_authorization_reversal_point_of_sale", + "visa_authorization_reversal_international_point_of_sale", + "visa_authorization_address_verification_service", + "visa_advanced_authorization", + "visa_message_transmission", + "visa_account_verification_domestic", + "visa_account_verification_international", + "visa_account_verification_canada", + "visa_corporate_acceptance_fee", + "visa_consumer_debit_acceptance_fee", + "visa_business_debit_acceptance_fee", + "visa_purchasing_acceptance_fee", + "visa_purchase_domestic", + "visa_purchase_international", + "visa_credit_purchase_token", + "visa_debit_purchase_token", + "visa_clearing_transmission", + "visa_direct_authorization", + "visa_direct_transaction_domestic", + "visa_service_commercial_credit", + "visa_advertising_service_commercial_credit", + "visa_community_growth_acceleration_program", + "visa_processing_guarantee_commercial_credit", + "pulse_switch_fee", + ] + """The type of fee being assessed. + + - `visa_international_service_assessment_single_currency` - International + Service Assessment (ISA) single-currency is a fee assessed by the card network + for cross-border transactions presented and settled in the same currency. + - `visa_international_service_assessment_cross_currency` - International Service + Assessment (ISA) cross-currency is a fee assessed by the card network for + cross-border transactions presented and settled in different currencies. + - `visa_authorization_domestic_point_of_sale` - Activity and charges for Visa + Settlement System processing for POS (Point-Of-Sale) authorization + transactions. Authorization is the process of approving or declining the + transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_international_point_of_sale` - Activity and charges for + Visa Settlement System processing for POS (Point-Of-Sale) International + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_canada_point_of_sale` - Activity and charges for Visa + Settlement System processing for Canada Region POS (Point-of-Sale) + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. + - `visa_authorization_reversal_point_of_sale` - Activity only for Visa + Settlement System authorization processing of POS (Point-Of-Sale) reversal + transactions. Authorization reversal represents a VSS message that undoes the + complete or partial actions of a previous authorization request. + - `visa_authorization_reversal_international_point_of_sale` - Activity only for + Visa Settlement System authorization processing of POS (Point-Of-Sale) + International reversal transactions. Authorization reversal represents a VSS + message that undoes the complete or partial actions of a previous + authorization request. + - `visa_authorization_address_verification_service` - A per Address Verification + Service (AVS) result fee. Applies to all usable AVS result codes. + - `visa_advanced_authorization` - Advanced Authorization is a fraud detection + tool that monitors and risk evaluates 100 percent of US VisaNet authorizations + in real-time. Activity related to Purchase (includes Signature Authenticated + Visa and PIN Authenticated Visa Debit (PAVD) transactions). + - `visa_message_transmission` - Issuer Transactions Visa represents a charge + based on total actual monthly processing (Visa transactions only) through a + VisaNet Access Point (VAP). Charges are assessed to the processor for each + VisaNet Access Point. + - `visa_account_verification_domestic` - Activity, per inquiry, related to the + domestic Issuer for Account Number Verification. + - `visa_account_verification_international` - Activity, per inquiry, related to + the international Issuer for Account Number Verification. + - `visa_account_verification_canada` - Activity, per inquiry, related to the + US-Canada Issuer for Account Number Verification. + - `visa_corporate_acceptance_fee` - The Corporate Acceptance Fee is charged to + issuers and is based on the monthly sales volume on Commercial and Government + Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. + - `visa_consumer_debit_acceptance_fee` - The Consumer Debit Acceptance Fee is + charged to issuers and is based on the monthly sales volume of Consumer Debit + or Prepaid card transactions. The cashback portion of a Debit and Prepaid card + transaction is excluded from the sales volume calculation. + - `visa_business_debit_acceptance_fee` - The Business Acceptance Fee is charged + to issuers and is based on the monthly sales volume on Business Debit, + Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback + portion is included in the sales volume calculation with the exception of a + Debit and Prepaid card transactions. + - `visa_purchasing_acceptance_fee` - The Purchasing Card Acceptance Fee is + charged to issuers and is based on the monthly sales volume on Commercial and + Government Debit, Prepaid, Credit, Charge, or Deferred Debit card + transactions. + - `visa_purchase_domestic` - Activity and fees for the processing of a sales + draft original for a purchase transaction. + - `visa_purchase_international` - Activity and fees for the processing of an + international sales draft original for a purchase transaction. + - `visa_credit_purchase_token` - Apple Pay Credit Product Token Purchase + Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for + Apple Pay transactions. + - `visa_debit_purchase_token` - Apple Pay Debit Product Token Purchase Original + Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay + transactions. + - `visa_clearing_transmission` - A per transaction fee assessed for Base II + financial draft - Issuer. + - `visa_direct_authorization` - Issuer charge for Non-Financial OCT/AFT + Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. + - `visa_direct_transaction_domestic` - Data processing charge for Visa Direct + OCTs for all business application identifiers (BAIs) other than money + transfer-bank initiated (BI). BASE II transactions. + - `visa_service_commercial_credit` - Issuer card service fee for Commercial + Credit cards. + - `visa_advertising_service_commercial_credit` - Issuer Advertising Service Fee + for Commercial Credit cards. + - `visa_community_growth_acceleration_program` - Issuer Community Growth + Acceleration Program Fee. + - `visa_processing_guarantee_commercial_credit` - Issuer Processing Guarantee + for Commercial Credit cards. + - `pulse_switch_fee` - Pulse Switch Fee is a fee charged by the Pulse network + for processing transactions on its network. + """ + + fixed_component: Optional[str] = None + """ + The fixed component of the fee, if applicable, given in major units of the fee + amount. + """ + + variable_rate: Optional[str] = None + """ + The variable rate component of the fee, if applicable, given as a decimal (e.g., + 0.015 for 1.5%). + """ + + class ElementCardRefund(BaseModel): """A Card Refund object. @@ -4539,6 +5630,9 @@ class ElementCardRefund(BaseModel): fields. """ + scheme_fees: List[ElementCardRefundSchemeFee] + """The scheme fees associated with this card refund.""" + transaction_id: str """The identifier of the Transaction associated with this Transaction.""" @@ -4577,16 +5671,168 @@ class ElementCardReversalNetworkIdentifiers(BaseModel): networks the retrieval reference number includes the trace counter. """ - trace_number: Optional[str] = None - """A counter used to verify an individual authorization. - - Expected to be unique per acquirer within a window of time. + trace_number: Optional[str] = None + """A counter used to verify an individual authorization. + + Expected to be unique per acquirer within a window of time. + """ + + transaction_id: Optional[str] = None + """ + A globally unique transaction identifier provided by the card network, used + across multiple life-cycle requests. + """ + + +class ElementCardReversalSchemeFee(BaseModel): + amount: str + """The fee amount given as a string containing a decimal number.""" + + created_at: datetime + """ + The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was + created. + """ + + currency: Literal["USD"] + """ + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee + reimbursement. + + - `USD` - US Dollar (USD) + """ + + fee_type: Literal[ + "visa_international_service_assessment_single_currency", + "visa_international_service_assessment_cross_currency", + "visa_authorization_domestic_point_of_sale", + "visa_authorization_international_point_of_sale", + "visa_authorization_canada_point_of_sale", + "visa_authorization_reversal_point_of_sale", + "visa_authorization_reversal_international_point_of_sale", + "visa_authorization_address_verification_service", + "visa_advanced_authorization", + "visa_message_transmission", + "visa_account_verification_domestic", + "visa_account_verification_international", + "visa_account_verification_canada", + "visa_corporate_acceptance_fee", + "visa_consumer_debit_acceptance_fee", + "visa_business_debit_acceptance_fee", + "visa_purchasing_acceptance_fee", + "visa_purchase_domestic", + "visa_purchase_international", + "visa_credit_purchase_token", + "visa_debit_purchase_token", + "visa_clearing_transmission", + "visa_direct_authorization", + "visa_direct_transaction_domestic", + "visa_service_commercial_credit", + "visa_advertising_service_commercial_credit", + "visa_community_growth_acceleration_program", + "visa_processing_guarantee_commercial_credit", + "pulse_switch_fee", + ] + """The type of fee being assessed. + + - `visa_international_service_assessment_single_currency` - International + Service Assessment (ISA) single-currency is a fee assessed by the card network + for cross-border transactions presented and settled in the same currency. + - `visa_international_service_assessment_cross_currency` - International Service + Assessment (ISA) cross-currency is a fee assessed by the card network for + cross-border transactions presented and settled in different currencies. + - `visa_authorization_domestic_point_of_sale` - Activity and charges for Visa + Settlement System processing for POS (Point-Of-Sale) authorization + transactions. Authorization is the process of approving or declining the + transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_international_point_of_sale` - Activity and charges for + Visa Settlement System processing for POS (Point-Of-Sale) International + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_canada_point_of_sale` - Activity and charges for Visa + Settlement System processing for Canada Region POS (Point-of-Sale) + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. + - `visa_authorization_reversal_point_of_sale` - Activity only for Visa + Settlement System authorization processing of POS (Point-Of-Sale) reversal + transactions. Authorization reversal represents a VSS message that undoes the + complete or partial actions of a previous authorization request. + - `visa_authorization_reversal_international_point_of_sale` - Activity only for + Visa Settlement System authorization processing of POS (Point-Of-Sale) + International reversal transactions. Authorization reversal represents a VSS + message that undoes the complete or partial actions of a previous + authorization request. + - `visa_authorization_address_verification_service` - A per Address Verification + Service (AVS) result fee. Applies to all usable AVS result codes. + - `visa_advanced_authorization` - Advanced Authorization is a fraud detection + tool that monitors and risk evaluates 100 percent of US VisaNet authorizations + in real-time. Activity related to Purchase (includes Signature Authenticated + Visa and PIN Authenticated Visa Debit (PAVD) transactions). + - `visa_message_transmission` - Issuer Transactions Visa represents a charge + based on total actual monthly processing (Visa transactions only) through a + VisaNet Access Point (VAP). Charges are assessed to the processor for each + VisaNet Access Point. + - `visa_account_verification_domestic` - Activity, per inquiry, related to the + domestic Issuer for Account Number Verification. + - `visa_account_verification_international` - Activity, per inquiry, related to + the international Issuer for Account Number Verification. + - `visa_account_verification_canada` - Activity, per inquiry, related to the + US-Canada Issuer for Account Number Verification. + - `visa_corporate_acceptance_fee` - The Corporate Acceptance Fee is charged to + issuers and is based on the monthly sales volume on Commercial and Government + Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. + - `visa_consumer_debit_acceptance_fee` - The Consumer Debit Acceptance Fee is + charged to issuers and is based on the monthly sales volume of Consumer Debit + or Prepaid card transactions. The cashback portion of a Debit and Prepaid card + transaction is excluded from the sales volume calculation. + - `visa_business_debit_acceptance_fee` - The Business Acceptance Fee is charged + to issuers and is based on the monthly sales volume on Business Debit, + Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback + portion is included in the sales volume calculation with the exception of a + Debit and Prepaid card transactions. + - `visa_purchasing_acceptance_fee` - The Purchasing Card Acceptance Fee is + charged to issuers and is based on the monthly sales volume on Commercial and + Government Debit, Prepaid, Credit, Charge, or Deferred Debit card + transactions. + - `visa_purchase_domestic` - Activity and fees for the processing of a sales + draft original for a purchase transaction. + - `visa_purchase_international` - Activity and fees for the processing of an + international sales draft original for a purchase transaction. + - `visa_credit_purchase_token` - Apple Pay Credit Product Token Purchase + Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for + Apple Pay transactions. + - `visa_debit_purchase_token` - Apple Pay Debit Product Token Purchase Original + Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay + transactions. + - `visa_clearing_transmission` - A per transaction fee assessed for Base II + financial draft - Issuer. + - `visa_direct_authorization` - Issuer charge for Non-Financial OCT/AFT + Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. + - `visa_direct_transaction_domestic` - Data processing charge for Visa Direct + OCTs for all business application identifiers (BAIs) other than money + transfer-bank initiated (BI). BASE II transactions. + - `visa_service_commercial_credit` - Issuer card service fee for Commercial + Credit cards. + - `visa_advertising_service_commercial_credit` - Issuer Advertising Service Fee + for Commercial Credit cards. + - `visa_community_growth_acceleration_program` - Issuer Community Growth + Acceleration Program Fee. + - `visa_processing_guarantee_commercial_credit` - Issuer Processing Guarantee + for Commercial Credit cards. + - `pulse_switch_fee` - Pulse Switch Fee is a fee charged by the Pulse network + for processing transactions on its network. + """ + + fixed_component: Optional[str] = None + """ + The fixed component of the fee, if applicable, given in major units of the fee + amount. """ - transaction_id: Optional[str] = None + variable_rate: Optional[str] = None """ - A globally unique transaction identifier provided by the card network, used - across multiple life-cycle requests. + The variable rate component of the fee, if applicable, given as a decimal (e.g., + 0.015 for 1.5%). """ @@ -4688,6 +5934,9 @@ class ElementCardReversal(BaseModel): - `partial_reversal` - The Card Reversal was a partial reversal, for any reason. """ + scheme_fees: List[ElementCardReversalSchemeFee] + """The scheme fees associated with this card reversal.""" + terminal_id: Optional[str] = None """ The terminal identifier (commonly abbreviated as TID) of the terminal the card @@ -5212,6 +6461,158 @@ class ElementCardSettlementPurchaseDetails(BaseModel): """Fields specific to travel.""" +class ElementCardSettlementSchemeFee(BaseModel): + amount: str + """The fee amount given as a string containing a decimal number.""" + + created_at: datetime + """ + The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was + created. + """ + + currency: Literal["USD"] + """ + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee + reimbursement. + + - `USD` - US Dollar (USD) + """ + + fee_type: Literal[ + "visa_international_service_assessment_single_currency", + "visa_international_service_assessment_cross_currency", + "visa_authorization_domestic_point_of_sale", + "visa_authorization_international_point_of_sale", + "visa_authorization_canada_point_of_sale", + "visa_authorization_reversal_point_of_sale", + "visa_authorization_reversal_international_point_of_sale", + "visa_authorization_address_verification_service", + "visa_advanced_authorization", + "visa_message_transmission", + "visa_account_verification_domestic", + "visa_account_verification_international", + "visa_account_verification_canada", + "visa_corporate_acceptance_fee", + "visa_consumer_debit_acceptance_fee", + "visa_business_debit_acceptance_fee", + "visa_purchasing_acceptance_fee", + "visa_purchase_domestic", + "visa_purchase_international", + "visa_credit_purchase_token", + "visa_debit_purchase_token", + "visa_clearing_transmission", + "visa_direct_authorization", + "visa_direct_transaction_domestic", + "visa_service_commercial_credit", + "visa_advertising_service_commercial_credit", + "visa_community_growth_acceleration_program", + "visa_processing_guarantee_commercial_credit", + "pulse_switch_fee", + ] + """The type of fee being assessed. + + - `visa_international_service_assessment_single_currency` - International + Service Assessment (ISA) single-currency is a fee assessed by the card network + for cross-border transactions presented and settled in the same currency. + - `visa_international_service_assessment_cross_currency` - International Service + Assessment (ISA) cross-currency is a fee assessed by the card network for + cross-border transactions presented and settled in different currencies. + - `visa_authorization_domestic_point_of_sale` - Activity and charges for Visa + Settlement System processing for POS (Point-Of-Sale) authorization + transactions. Authorization is the process of approving or declining the + transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_international_point_of_sale` - Activity and charges for + Visa Settlement System processing for POS (Point-Of-Sale) International + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_canada_point_of_sale` - Activity and charges for Visa + Settlement System processing for Canada Region POS (Point-of-Sale) + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. + - `visa_authorization_reversal_point_of_sale` - Activity only for Visa + Settlement System authorization processing of POS (Point-Of-Sale) reversal + transactions. Authorization reversal represents a VSS message that undoes the + complete or partial actions of a previous authorization request. + - `visa_authorization_reversal_international_point_of_sale` - Activity only for + Visa Settlement System authorization processing of POS (Point-Of-Sale) + International reversal transactions. Authorization reversal represents a VSS + message that undoes the complete or partial actions of a previous + authorization request. + - `visa_authorization_address_verification_service` - A per Address Verification + Service (AVS) result fee. Applies to all usable AVS result codes. + - `visa_advanced_authorization` - Advanced Authorization is a fraud detection + tool that monitors and risk evaluates 100 percent of US VisaNet authorizations + in real-time. Activity related to Purchase (includes Signature Authenticated + Visa and PIN Authenticated Visa Debit (PAVD) transactions). + - `visa_message_transmission` - Issuer Transactions Visa represents a charge + based on total actual monthly processing (Visa transactions only) through a + VisaNet Access Point (VAP). Charges are assessed to the processor for each + VisaNet Access Point. + - `visa_account_verification_domestic` - Activity, per inquiry, related to the + domestic Issuer for Account Number Verification. + - `visa_account_verification_international` - Activity, per inquiry, related to + the international Issuer for Account Number Verification. + - `visa_account_verification_canada` - Activity, per inquiry, related to the + US-Canada Issuer for Account Number Verification. + - `visa_corporate_acceptance_fee` - The Corporate Acceptance Fee is charged to + issuers and is based on the monthly sales volume on Commercial and Government + Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. + - `visa_consumer_debit_acceptance_fee` - The Consumer Debit Acceptance Fee is + charged to issuers and is based on the monthly sales volume of Consumer Debit + or Prepaid card transactions. The cashback portion of a Debit and Prepaid card + transaction is excluded from the sales volume calculation. + - `visa_business_debit_acceptance_fee` - The Business Acceptance Fee is charged + to issuers and is based on the monthly sales volume on Business Debit, + Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback + portion is included in the sales volume calculation with the exception of a + Debit and Prepaid card transactions. + - `visa_purchasing_acceptance_fee` - The Purchasing Card Acceptance Fee is + charged to issuers and is based on the monthly sales volume on Commercial and + Government Debit, Prepaid, Credit, Charge, or Deferred Debit card + transactions. + - `visa_purchase_domestic` - Activity and fees for the processing of a sales + draft original for a purchase transaction. + - `visa_purchase_international` - Activity and fees for the processing of an + international sales draft original for a purchase transaction. + - `visa_credit_purchase_token` - Apple Pay Credit Product Token Purchase + Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for + Apple Pay transactions. + - `visa_debit_purchase_token` - Apple Pay Debit Product Token Purchase Original + Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay + transactions. + - `visa_clearing_transmission` - A per transaction fee assessed for Base II + financial draft - Issuer. + - `visa_direct_authorization` - Issuer charge for Non-Financial OCT/AFT + Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. + - `visa_direct_transaction_domestic` - Data processing charge for Visa Direct + OCTs for all business application identifiers (BAIs) other than money + transfer-bank initiated (BI). BASE II transactions. + - `visa_service_commercial_credit` - Issuer card service fee for Commercial + Credit cards. + - `visa_advertising_service_commercial_credit` - Issuer Advertising Service Fee + for Commercial Credit cards. + - `visa_community_growth_acceleration_program` - Issuer Community Growth + Acceleration Program Fee. + - `visa_processing_guarantee_commercial_credit` - Issuer Processing Guarantee + for Commercial Credit cards. + - `pulse_switch_fee` - Pulse Switch Fee is a fee charged by the Pulse network + for processing transactions on its network. + """ + + fixed_component: Optional[str] = None + """ + The fixed component of the fee, if applicable, given in major units of the fee + amount. + """ + + variable_rate: Optional[str] = None + """ + The variable rate component of the fee, if applicable, given as a decimal (e.g., + 0.015 for 1.5%). + """ + + class ElementCardSettlementSurcharge(BaseModel): """Surcharge amount details, if applicable. @@ -5323,6 +6724,9 @@ class ElementCardSettlement(BaseModel): fields. """ + scheme_fees: List[ElementCardSettlementSchemeFee] + """The scheme fees associated with this card settlement.""" + surcharge: Optional[ElementCardSettlementSurcharge] = None """Surcharge amount details, if applicable. @@ -5753,23 +7157,175 @@ class ElementCardValidationNetworkIdentifiers(BaseModel): sent back to the acquirer in an approved response. """ - retrieval_reference_number: Optional[str] = None - """A life-cycle identifier used across e.g., an authorization and a reversal. - - Expected to be unique per acquirer within a window of time. For some card - networks the retrieval reference number includes the trace counter. + retrieval_reference_number: Optional[str] = None + """A life-cycle identifier used across e.g., an authorization and a reversal. + + Expected to be unique per acquirer within a window of time. For some card + networks the retrieval reference number includes the trace counter. + """ + + trace_number: Optional[str] = None + """A counter used to verify an individual authorization. + + Expected to be unique per acquirer within a window of time. + """ + + transaction_id: Optional[str] = None + """ + A globally unique transaction identifier provided by the card network, used + across multiple life-cycle requests. + """ + + +class ElementCardValidationSchemeFee(BaseModel): + amount: str + """The fee amount given as a string containing a decimal number.""" + + created_at: datetime + """ + The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was + created. + """ + + currency: Literal["USD"] + """ + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee + reimbursement. + + - `USD` - US Dollar (USD) + """ + + fee_type: Literal[ + "visa_international_service_assessment_single_currency", + "visa_international_service_assessment_cross_currency", + "visa_authorization_domestic_point_of_sale", + "visa_authorization_international_point_of_sale", + "visa_authorization_canada_point_of_sale", + "visa_authorization_reversal_point_of_sale", + "visa_authorization_reversal_international_point_of_sale", + "visa_authorization_address_verification_service", + "visa_advanced_authorization", + "visa_message_transmission", + "visa_account_verification_domestic", + "visa_account_verification_international", + "visa_account_verification_canada", + "visa_corporate_acceptance_fee", + "visa_consumer_debit_acceptance_fee", + "visa_business_debit_acceptance_fee", + "visa_purchasing_acceptance_fee", + "visa_purchase_domestic", + "visa_purchase_international", + "visa_credit_purchase_token", + "visa_debit_purchase_token", + "visa_clearing_transmission", + "visa_direct_authorization", + "visa_direct_transaction_domestic", + "visa_service_commercial_credit", + "visa_advertising_service_commercial_credit", + "visa_community_growth_acceleration_program", + "visa_processing_guarantee_commercial_credit", + "pulse_switch_fee", + ] + """The type of fee being assessed. + + - `visa_international_service_assessment_single_currency` - International + Service Assessment (ISA) single-currency is a fee assessed by the card network + for cross-border transactions presented and settled in the same currency. + - `visa_international_service_assessment_cross_currency` - International Service + Assessment (ISA) cross-currency is a fee assessed by the card network for + cross-border transactions presented and settled in different currencies. + - `visa_authorization_domestic_point_of_sale` - Activity and charges for Visa + Settlement System processing for POS (Point-Of-Sale) authorization + transactions. Authorization is the process of approving or declining the + transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_international_point_of_sale` - Activity and charges for + Visa Settlement System processing for POS (Point-Of-Sale) International + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_canada_point_of_sale` - Activity and charges for Visa + Settlement System processing for Canada Region POS (Point-of-Sale) + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. + - `visa_authorization_reversal_point_of_sale` - Activity only for Visa + Settlement System authorization processing of POS (Point-Of-Sale) reversal + transactions. Authorization reversal represents a VSS message that undoes the + complete or partial actions of a previous authorization request. + - `visa_authorization_reversal_international_point_of_sale` - Activity only for + Visa Settlement System authorization processing of POS (Point-Of-Sale) + International reversal transactions. Authorization reversal represents a VSS + message that undoes the complete or partial actions of a previous + authorization request. + - `visa_authorization_address_verification_service` - A per Address Verification + Service (AVS) result fee. Applies to all usable AVS result codes. + - `visa_advanced_authorization` - Advanced Authorization is a fraud detection + tool that monitors and risk evaluates 100 percent of US VisaNet authorizations + in real-time. Activity related to Purchase (includes Signature Authenticated + Visa and PIN Authenticated Visa Debit (PAVD) transactions). + - `visa_message_transmission` - Issuer Transactions Visa represents a charge + based on total actual monthly processing (Visa transactions only) through a + VisaNet Access Point (VAP). Charges are assessed to the processor for each + VisaNet Access Point. + - `visa_account_verification_domestic` - Activity, per inquiry, related to the + domestic Issuer for Account Number Verification. + - `visa_account_verification_international` - Activity, per inquiry, related to + the international Issuer for Account Number Verification. + - `visa_account_verification_canada` - Activity, per inquiry, related to the + US-Canada Issuer for Account Number Verification. + - `visa_corporate_acceptance_fee` - The Corporate Acceptance Fee is charged to + issuers and is based on the monthly sales volume on Commercial and Government + Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. + - `visa_consumer_debit_acceptance_fee` - The Consumer Debit Acceptance Fee is + charged to issuers and is based on the monthly sales volume of Consumer Debit + or Prepaid card transactions. The cashback portion of a Debit and Prepaid card + transaction is excluded from the sales volume calculation. + - `visa_business_debit_acceptance_fee` - The Business Acceptance Fee is charged + to issuers and is based on the monthly sales volume on Business Debit, + Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback + portion is included in the sales volume calculation with the exception of a + Debit and Prepaid card transactions. + - `visa_purchasing_acceptance_fee` - The Purchasing Card Acceptance Fee is + charged to issuers and is based on the monthly sales volume on Commercial and + Government Debit, Prepaid, Credit, Charge, or Deferred Debit card + transactions. + - `visa_purchase_domestic` - Activity and fees for the processing of a sales + draft original for a purchase transaction. + - `visa_purchase_international` - Activity and fees for the processing of an + international sales draft original for a purchase transaction. + - `visa_credit_purchase_token` - Apple Pay Credit Product Token Purchase + Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for + Apple Pay transactions. + - `visa_debit_purchase_token` - Apple Pay Debit Product Token Purchase Original + Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay + transactions. + - `visa_clearing_transmission` - A per transaction fee assessed for Base II + financial draft - Issuer. + - `visa_direct_authorization` - Issuer charge for Non-Financial OCT/AFT + Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. + - `visa_direct_transaction_domestic` - Data processing charge for Visa Direct + OCTs for all business application identifiers (BAIs) other than money + transfer-bank initiated (BI). BASE II transactions. + - `visa_service_commercial_credit` - Issuer card service fee for Commercial + Credit cards. + - `visa_advertising_service_commercial_credit` - Issuer Advertising Service Fee + for Commercial Credit cards. + - `visa_community_growth_acceleration_program` - Issuer Community Growth + Acceleration Program Fee. + - `visa_processing_guarantee_commercial_credit` - Issuer Processing Guarantee + for Commercial Credit cards. + - `pulse_switch_fee` - Pulse Switch Fee is a fee charged by the Pulse network + for processing transactions on its network. + """ + + fixed_component: Optional[str] = None """ - - trace_number: Optional[str] = None - """A counter used to verify an individual authorization. - - Expected to be unique per acquirer within a window of time. + The fixed component of the fee, if applicable, given in major units of the fee + amount. """ - transaction_id: Optional[str] = None + variable_rate: Optional[str] = None """ - A globally unique transaction identifier provided by the card network, used - across multiple life-cycle requests. + The variable rate component of the fee, if applicable, given as a decimal (e.g., + 0.015 for 1.5%). """ @@ -5964,6 +7520,9 @@ class ElementCardValidation(BaseModel): transaction. """ + scheme_fees: List[ElementCardValidationSchemeFee] + """The scheme fees associated with this card validation.""" + terminal_id: Optional[str] = None """ The terminal identifier (commonly abbreviated as TID) of the terminal the card @@ -6159,158 +7718,6 @@ class Element(BaseModel): """ -class SchemeFee(BaseModel): - amount: str - """The fee amount given as a string containing a decimal number.""" - - created_at: datetime - """ - The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was - created. - """ - - currency: Literal["USD"] - """ - The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee - reimbursement. - - - `USD` - US Dollar (USD) - """ - - fee_type: Literal[ - "visa_international_service_assessment_single_currency", - "visa_international_service_assessment_cross_currency", - "visa_authorization_domestic_point_of_sale", - "visa_authorization_international_point_of_sale", - "visa_authorization_canada_point_of_sale", - "visa_authorization_reversal_point_of_sale", - "visa_authorization_reversal_international_point_of_sale", - "visa_authorization_address_verification_service", - "visa_advanced_authorization", - "visa_message_transmission", - "visa_account_verification_domestic", - "visa_account_verification_international", - "visa_account_verification_canada", - "visa_corporate_acceptance_fee", - "visa_consumer_debit_acceptance_fee", - "visa_business_debit_acceptance_fee", - "visa_purchasing_acceptance_fee", - "visa_purchase_domestic", - "visa_purchase_international", - "visa_credit_purchase_token", - "visa_debit_purchase_token", - "visa_clearing_transmission", - "visa_direct_authorization", - "visa_direct_transaction_domestic", - "visa_service_commercial_credit", - "visa_advertising_service_commercial_credit", - "visa_community_growth_acceleration_program", - "visa_processing_guarantee_commercial_credit", - "pulse_switch_fee", - ] - """The type of fee being assessed. - - - `visa_international_service_assessment_single_currency` - International - Service Assessment (ISA) single-currency is a fee assessed by the card network - for cross-border transactions presented and settled in the same currency. - - `visa_international_service_assessment_cross_currency` - International Service - Assessment (ISA) cross-currency is a fee assessed by the card network for - cross-border transactions presented and settled in different currencies. - - `visa_authorization_domestic_point_of_sale` - Activity and charges for Visa - Settlement System processing for POS (Point-Of-Sale) authorization - transactions. Authorization is the process of approving or declining the - transaction amount specified. The fee is assessed to the Issuer. - - `visa_authorization_international_point_of_sale` - Activity and charges for - Visa Settlement System processing for POS (Point-Of-Sale) International - authorization transactions. Authorization is the process of approving or - declining the transaction amount specified. The fee is assessed to the Issuer. - - `visa_authorization_canada_point_of_sale` - Activity and charges for Visa - Settlement System processing for Canada Region POS (Point-of-Sale) - authorization transactions. Authorization is the process of approving or - declining the transaction amount specified. - - `visa_authorization_reversal_point_of_sale` - Activity only for Visa - Settlement System authorization processing of POS (Point-Of-Sale) reversal - transactions. Authorization reversal represents a VSS message that undoes the - complete or partial actions of a previous authorization request. - - `visa_authorization_reversal_international_point_of_sale` - Activity only for - Visa Settlement System authorization processing of POS (Point-Of-Sale) - International reversal transactions. Authorization reversal represents a VSS - message that undoes the complete or partial actions of a previous - authorization request. - - `visa_authorization_address_verification_service` - A per Address Verification - Service (AVS) result fee. Applies to all usable AVS result codes. - - `visa_advanced_authorization` - Advanced Authorization is a fraud detection - tool that monitors and risk evaluates 100 percent of US VisaNet authorizations - in real-time. Activity related to Purchase (includes Signature Authenticated - Visa and PIN Authenticated Visa Debit (PAVD) transactions). - - `visa_message_transmission` - Issuer Transactions Visa represents a charge - based on total actual monthly processing (Visa transactions only) through a - VisaNet Access Point (VAP). Charges are assessed to the processor for each - VisaNet Access Point. - - `visa_account_verification_domestic` - Activity, per inquiry, related to the - domestic Issuer for Account Number Verification. - - `visa_account_verification_international` - Activity, per inquiry, related to - the international Issuer for Account Number Verification. - - `visa_account_verification_canada` - Activity, per inquiry, related to the - US-Canada Issuer for Account Number Verification. - - `visa_corporate_acceptance_fee` - The Corporate Acceptance Fee is charged to - issuers and is based on the monthly sales volume on Commercial and Government - Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - - `visa_consumer_debit_acceptance_fee` - The Consumer Debit Acceptance Fee is - charged to issuers and is based on the monthly sales volume of Consumer Debit - or Prepaid card transactions. The cashback portion of a Debit and Prepaid card - transaction is excluded from the sales volume calculation. - - `visa_business_debit_acceptance_fee` - The Business Acceptance Fee is charged - to issuers and is based on the monthly sales volume on Business Debit, - Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback - portion is included in the sales volume calculation with the exception of a - Debit and Prepaid card transactions. - - `visa_purchasing_acceptance_fee` - The Purchasing Card Acceptance Fee is - charged to issuers and is based on the monthly sales volume on Commercial and - Government Debit, Prepaid, Credit, Charge, or Deferred Debit card - transactions. - - `visa_purchase_domestic` - Activity and fees for the processing of a sales - draft original for a purchase transaction. - - `visa_purchase_international` - Activity and fees for the processing of an - international sales draft original for a purchase transaction. - - `visa_credit_purchase_token` - Apple Pay Credit Product Token Purchase - Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for - Apple Pay transactions. - - `visa_debit_purchase_token` - Apple Pay Debit Product Token Purchase Original - Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay - transactions. - - `visa_clearing_transmission` - A per transaction fee assessed for Base II - financial draft - Issuer. - - `visa_direct_authorization` - Issuer charge for Non-Financial OCT/AFT - Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. - - `visa_direct_transaction_domestic` - Data processing charge for Visa Direct - OCTs for all business application identifiers (BAIs) other than money - transfer-bank initiated (BI). BASE II transactions. - - `visa_service_commercial_credit` - Issuer card service fee for Commercial - Credit cards. - - `visa_advertising_service_commercial_credit` - Issuer Advertising Service Fee - for Commercial Credit cards. - - `visa_community_growth_acceleration_program` - Issuer Community Growth - Acceleration Program Fee. - - `visa_processing_guarantee_commercial_credit` - Issuer Processing Guarantee - for Commercial Credit cards. - - `pulse_switch_fee` - Pulse Switch Fee is a fee charged by the Pulse network - for processing transactions on its network. - """ - - fixed_component: Optional[str] = None - """ - The fixed component of the fee, if applicable, given in major units of the fee - amount. - """ - - variable_rate: Optional[str] = None - """ - The variable rate component of the fee, if applicable, given as a decimal (e.g., - 0.015 for 1.5%). - """ - - class State(BaseModel): """The summarized state of this card payment.""" @@ -6386,9 +7793,6 @@ class CardPayment(BaseModel): physical_card_id: Optional[str] = None """The Physical Card identifier for this payment.""" - scheme_fees: List[SchemeFee] - """The scheme fees associated with this card payment.""" - state: State """The summarized state of this card payment.""" @@ -6397,3 +7801,15 @@ class CardPayment(BaseModel): For this resource it will always be `card_payment`. """ + + if TYPE_CHECKING: + # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a + # value to this field, so for compatibility we avoid doing it at runtime. + __pydantic_extra__: Dict[str, object] = FieldInfo(init=False) # pyright: ignore[reportIncompatibleVariableOverride] + + # Stub to indicate that arbitrary properties are accepted. + # To access properties that are not valid identifiers you can use `getattr`, e.g. + # `getattr(obj, '$type')` + def __getattr__(self, attr: str) -> object: ... + else: + __pydantic_extra__: Dict[str, object] diff --git a/src/increase/types/declined_transaction.py b/src/increase/types/declined_transaction.py index a6d0ad0d..c0be01ec 100644 --- a/src/increase/types/declined_transaction.py +++ b/src/increase/types/declined_transaction.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import TYPE_CHECKING, Dict, Optional +from typing import TYPE_CHECKING, Dict, List, Optional from datetime import datetime from typing_extensions import Literal @@ -28,6 +28,7 @@ "SourceCardDeclineNetworkDetailsPulse", "SourceCardDeclineNetworkDetailsVisa", "SourceCardDeclineNetworkIdentifiers", + "SourceCardDeclineSchemeFee", "SourceCardDeclineVerification", "SourceCardDeclineVerificationCardVerificationCode", "SourceCardDeclineVerificationCardholderAddress", @@ -565,6 +566,158 @@ class SourceCardDeclineNetworkIdentifiers(BaseModel): """ +class SourceCardDeclineSchemeFee(BaseModel): + amount: str + """The fee amount given as a string containing a decimal number.""" + + created_at: datetime + """ + The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was + created. + """ + + currency: Literal["USD"] + """ + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee + reimbursement. + + - `USD` - US Dollar (USD) + """ + + fee_type: Literal[ + "visa_international_service_assessment_single_currency", + "visa_international_service_assessment_cross_currency", + "visa_authorization_domestic_point_of_sale", + "visa_authorization_international_point_of_sale", + "visa_authorization_canada_point_of_sale", + "visa_authorization_reversal_point_of_sale", + "visa_authorization_reversal_international_point_of_sale", + "visa_authorization_address_verification_service", + "visa_advanced_authorization", + "visa_message_transmission", + "visa_account_verification_domestic", + "visa_account_verification_international", + "visa_account_verification_canada", + "visa_corporate_acceptance_fee", + "visa_consumer_debit_acceptance_fee", + "visa_business_debit_acceptance_fee", + "visa_purchasing_acceptance_fee", + "visa_purchase_domestic", + "visa_purchase_international", + "visa_credit_purchase_token", + "visa_debit_purchase_token", + "visa_clearing_transmission", + "visa_direct_authorization", + "visa_direct_transaction_domestic", + "visa_service_commercial_credit", + "visa_advertising_service_commercial_credit", + "visa_community_growth_acceleration_program", + "visa_processing_guarantee_commercial_credit", + "pulse_switch_fee", + ] + """The type of fee being assessed. + + - `visa_international_service_assessment_single_currency` - International + Service Assessment (ISA) single-currency is a fee assessed by the card network + for cross-border transactions presented and settled in the same currency. + - `visa_international_service_assessment_cross_currency` - International Service + Assessment (ISA) cross-currency is a fee assessed by the card network for + cross-border transactions presented and settled in different currencies. + - `visa_authorization_domestic_point_of_sale` - Activity and charges for Visa + Settlement System processing for POS (Point-Of-Sale) authorization + transactions. Authorization is the process of approving or declining the + transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_international_point_of_sale` - Activity and charges for + Visa Settlement System processing for POS (Point-Of-Sale) International + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_canada_point_of_sale` - Activity and charges for Visa + Settlement System processing for Canada Region POS (Point-of-Sale) + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. + - `visa_authorization_reversal_point_of_sale` - Activity only for Visa + Settlement System authorization processing of POS (Point-Of-Sale) reversal + transactions. Authorization reversal represents a VSS message that undoes the + complete or partial actions of a previous authorization request. + - `visa_authorization_reversal_international_point_of_sale` - Activity only for + Visa Settlement System authorization processing of POS (Point-Of-Sale) + International reversal transactions. Authorization reversal represents a VSS + message that undoes the complete or partial actions of a previous + authorization request. + - `visa_authorization_address_verification_service` - A per Address Verification + Service (AVS) result fee. Applies to all usable AVS result codes. + - `visa_advanced_authorization` - Advanced Authorization is a fraud detection + tool that monitors and risk evaluates 100 percent of US VisaNet authorizations + in real-time. Activity related to Purchase (includes Signature Authenticated + Visa and PIN Authenticated Visa Debit (PAVD) transactions). + - `visa_message_transmission` - Issuer Transactions Visa represents a charge + based on total actual monthly processing (Visa transactions only) through a + VisaNet Access Point (VAP). Charges are assessed to the processor for each + VisaNet Access Point. + - `visa_account_verification_domestic` - Activity, per inquiry, related to the + domestic Issuer for Account Number Verification. + - `visa_account_verification_international` - Activity, per inquiry, related to + the international Issuer for Account Number Verification. + - `visa_account_verification_canada` - Activity, per inquiry, related to the + US-Canada Issuer for Account Number Verification. + - `visa_corporate_acceptance_fee` - The Corporate Acceptance Fee is charged to + issuers and is based on the monthly sales volume on Commercial and Government + Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. + - `visa_consumer_debit_acceptance_fee` - The Consumer Debit Acceptance Fee is + charged to issuers and is based on the monthly sales volume of Consumer Debit + or Prepaid card transactions. The cashback portion of a Debit and Prepaid card + transaction is excluded from the sales volume calculation. + - `visa_business_debit_acceptance_fee` - The Business Acceptance Fee is charged + to issuers and is based on the monthly sales volume on Business Debit, + Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback + portion is included in the sales volume calculation with the exception of a + Debit and Prepaid card transactions. + - `visa_purchasing_acceptance_fee` - The Purchasing Card Acceptance Fee is + charged to issuers and is based on the monthly sales volume on Commercial and + Government Debit, Prepaid, Credit, Charge, or Deferred Debit card + transactions. + - `visa_purchase_domestic` - Activity and fees for the processing of a sales + draft original for a purchase transaction. + - `visa_purchase_international` - Activity and fees for the processing of an + international sales draft original for a purchase transaction. + - `visa_credit_purchase_token` - Apple Pay Credit Product Token Purchase + Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for + Apple Pay transactions. + - `visa_debit_purchase_token` - Apple Pay Debit Product Token Purchase Original + Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay + transactions. + - `visa_clearing_transmission` - A per transaction fee assessed for Base II + financial draft - Issuer. + - `visa_direct_authorization` - Issuer charge for Non-Financial OCT/AFT + Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. + - `visa_direct_transaction_domestic` - Data processing charge for Visa Direct + OCTs for all business application identifiers (BAIs) other than money + transfer-bank initiated (BI). BASE II transactions. + - `visa_service_commercial_credit` - Issuer card service fee for Commercial + Credit cards. + - `visa_advertising_service_commercial_credit` - Issuer Advertising Service Fee + for Commercial Credit cards. + - `visa_community_growth_acceleration_program` - Issuer Community Growth + Acceleration Program Fee. + - `visa_processing_guarantee_commercial_credit` - Issuer Processing Guarantee + for Commercial Credit cards. + - `pulse_switch_fee` - Pulse Switch Fee is a fee charged by the Pulse network + for processing transactions on its network. + """ + + fixed_component: Optional[str] = None + """ + The fixed component of the fee, if applicable, given in major units of the fee + amount. + """ + + variable_rate: Optional[str] = None + """ + The variable rate component of the fee, if applicable, given as a decimal (e.g., + 0.015 for 1.5%). + """ + + class SourceCardDeclineVerificationCardVerificationCode(BaseModel): """ Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. @@ -916,6 +1069,9 @@ class SourceCardDecline(BaseModel): reach out to support@increase.com for more information. """ + scheme_fees: List[SourceCardDeclineSchemeFee] + """The scheme fees associated with this card decline.""" + terminal_id: Optional[str] = None """ The terminal identifier (commonly abbreviated as TID) of the terminal the card diff --git a/src/increase/types/pending_transaction.py b/src/increase/types/pending_transaction.py index 9eba210f..7c68bde2 100644 --- a/src/increase/types/pending_transaction.py +++ b/src/increase/types/pending_transaction.py @@ -1,6 +1,6 @@ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. -from typing import TYPE_CHECKING, Dict, Optional +from typing import TYPE_CHECKING, Dict, List, Optional from datetime import datetime from typing_extensions import Literal @@ -31,6 +31,7 @@ "SourceCardAuthorizationNetworkDetailsPulse", "SourceCardAuthorizationNetworkDetailsVisa", "SourceCardAuthorizationNetworkIdentifiers", + "SourceCardAuthorizationSchemeFee", "SourceCardAuthorizationVerification", "SourceCardAuthorizationVerificationCardVerificationCode", "SourceCardAuthorizationVerificationCardholderAddress", @@ -575,6 +576,158 @@ class SourceCardAuthorizationNetworkIdentifiers(BaseModel): """ +class SourceCardAuthorizationSchemeFee(BaseModel): + amount: str + """The fee amount given as a string containing a decimal number.""" + + created_at: datetime + """ + The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was + created. + """ + + currency: Literal["USD"] + """ + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee + reimbursement. + + - `USD` - US Dollar (USD) + """ + + fee_type: Literal[ + "visa_international_service_assessment_single_currency", + "visa_international_service_assessment_cross_currency", + "visa_authorization_domestic_point_of_sale", + "visa_authorization_international_point_of_sale", + "visa_authorization_canada_point_of_sale", + "visa_authorization_reversal_point_of_sale", + "visa_authorization_reversal_international_point_of_sale", + "visa_authorization_address_verification_service", + "visa_advanced_authorization", + "visa_message_transmission", + "visa_account_verification_domestic", + "visa_account_verification_international", + "visa_account_verification_canada", + "visa_corporate_acceptance_fee", + "visa_consumer_debit_acceptance_fee", + "visa_business_debit_acceptance_fee", + "visa_purchasing_acceptance_fee", + "visa_purchase_domestic", + "visa_purchase_international", + "visa_credit_purchase_token", + "visa_debit_purchase_token", + "visa_clearing_transmission", + "visa_direct_authorization", + "visa_direct_transaction_domestic", + "visa_service_commercial_credit", + "visa_advertising_service_commercial_credit", + "visa_community_growth_acceleration_program", + "visa_processing_guarantee_commercial_credit", + "pulse_switch_fee", + ] + """The type of fee being assessed. + + - `visa_international_service_assessment_single_currency` - International + Service Assessment (ISA) single-currency is a fee assessed by the card network + for cross-border transactions presented and settled in the same currency. + - `visa_international_service_assessment_cross_currency` - International Service + Assessment (ISA) cross-currency is a fee assessed by the card network for + cross-border transactions presented and settled in different currencies. + - `visa_authorization_domestic_point_of_sale` - Activity and charges for Visa + Settlement System processing for POS (Point-Of-Sale) authorization + transactions. Authorization is the process of approving or declining the + transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_international_point_of_sale` - Activity and charges for + Visa Settlement System processing for POS (Point-Of-Sale) International + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_canada_point_of_sale` - Activity and charges for Visa + Settlement System processing for Canada Region POS (Point-of-Sale) + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. + - `visa_authorization_reversal_point_of_sale` - Activity only for Visa + Settlement System authorization processing of POS (Point-Of-Sale) reversal + transactions. Authorization reversal represents a VSS message that undoes the + complete or partial actions of a previous authorization request. + - `visa_authorization_reversal_international_point_of_sale` - Activity only for + Visa Settlement System authorization processing of POS (Point-Of-Sale) + International reversal transactions. Authorization reversal represents a VSS + message that undoes the complete or partial actions of a previous + authorization request. + - `visa_authorization_address_verification_service` - A per Address Verification + Service (AVS) result fee. Applies to all usable AVS result codes. + - `visa_advanced_authorization` - Advanced Authorization is a fraud detection + tool that monitors and risk evaluates 100 percent of US VisaNet authorizations + in real-time. Activity related to Purchase (includes Signature Authenticated + Visa and PIN Authenticated Visa Debit (PAVD) transactions). + - `visa_message_transmission` - Issuer Transactions Visa represents a charge + based on total actual monthly processing (Visa transactions only) through a + VisaNet Access Point (VAP). Charges are assessed to the processor for each + VisaNet Access Point. + - `visa_account_verification_domestic` - Activity, per inquiry, related to the + domestic Issuer for Account Number Verification. + - `visa_account_verification_international` - Activity, per inquiry, related to + the international Issuer for Account Number Verification. + - `visa_account_verification_canada` - Activity, per inquiry, related to the + US-Canada Issuer for Account Number Verification. + - `visa_corporate_acceptance_fee` - The Corporate Acceptance Fee is charged to + issuers and is based on the monthly sales volume on Commercial and Government + Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. + - `visa_consumer_debit_acceptance_fee` - The Consumer Debit Acceptance Fee is + charged to issuers and is based on the monthly sales volume of Consumer Debit + or Prepaid card transactions. The cashback portion of a Debit and Prepaid card + transaction is excluded from the sales volume calculation. + - `visa_business_debit_acceptance_fee` - The Business Acceptance Fee is charged + to issuers and is based on the monthly sales volume on Business Debit, + Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback + portion is included in the sales volume calculation with the exception of a + Debit and Prepaid card transactions. + - `visa_purchasing_acceptance_fee` - The Purchasing Card Acceptance Fee is + charged to issuers and is based on the monthly sales volume on Commercial and + Government Debit, Prepaid, Credit, Charge, or Deferred Debit card + transactions. + - `visa_purchase_domestic` - Activity and fees for the processing of a sales + draft original for a purchase transaction. + - `visa_purchase_international` - Activity and fees for the processing of an + international sales draft original for a purchase transaction. + - `visa_credit_purchase_token` - Apple Pay Credit Product Token Purchase + Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for + Apple Pay transactions. + - `visa_debit_purchase_token` - Apple Pay Debit Product Token Purchase Original + Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay + transactions. + - `visa_clearing_transmission` - A per transaction fee assessed for Base II + financial draft - Issuer. + - `visa_direct_authorization` - Issuer charge for Non-Financial OCT/AFT + Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. + - `visa_direct_transaction_domestic` - Data processing charge for Visa Direct + OCTs for all business application identifiers (BAIs) other than money + transfer-bank initiated (BI). BASE II transactions. + - `visa_service_commercial_credit` - Issuer card service fee for Commercial + Credit cards. + - `visa_advertising_service_commercial_credit` - Issuer Advertising Service Fee + for Commercial Credit cards. + - `visa_community_growth_acceleration_program` - Issuer Community Growth + Acceleration Program Fee. + - `visa_processing_guarantee_commercial_credit` - Issuer Processing Guarantee + for Commercial Credit cards. + - `pulse_switch_fee` - Pulse Switch Fee is a fee charged by the Pulse network + for processing transactions on its network. + """ + + fixed_component: Optional[str] = None + """ + The fixed component of the fee, if applicable, given in major units of the fee + amount. + """ + + variable_rate: Optional[str] = None + """ + The variable rate component of the fee, if applicable, given as a decimal (e.g., + 0.015 for 1.5%). + """ + + class SourceCardAuthorizationVerificationCardVerificationCode(BaseModel): """ Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. @@ -838,6 +991,9 @@ class SourceCardAuthorization(BaseModel): transaction. """ + scheme_fees: List[SourceCardAuthorizationSchemeFee] + """The scheme fees associated with this card authorization.""" + terminal_id: Optional[str] = None """ The terminal identifier (commonly abbreviated as TID) of the terminal the card diff --git a/src/increase/types/transaction.py b/src/increase/types/transaction.py index ccdd38e3..b371d94e 100644 --- a/src/increase/types/transaction.py +++ b/src/increase/types/transaction.py @@ -38,6 +38,7 @@ "SourceCardFinancialNetworkDetailsPulse", "SourceCardFinancialNetworkDetailsVisa", "SourceCardFinancialNetworkIdentifiers", + "SourceCardFinancialSchemeFee", "SourceCardFinancialVerification", "SourceCardFinancialVerificationCardVerificationCode", "SourceCardFinancialVerificationCardholderAddress", @@ -54,6 +55,7 @@ "SourceCardRefundPurchaseDetailsTravelAncillary", "SourceCardRefundPurchaseDetailsTravelAncillaryService", "SourceCardRefundPurchaseDetailsTravelTripLeg", + "SourceCardRefundSchemeFee", "SourceCardRevenuePayment", "SourceCardSettlement", "SourceCardSettlementCashback", @@ -66,6 +68,7 @@ "SourceCardSettlementPurchaseDetailsTravelAncillary", "SourceCardSettlementPurchaseDetailsTravelAncillaryService", "SourceCardSettlementPurchaseDetailsTravelTripLeg", + "SourceCardSettlementSchemeFee", "SourceCardSettlementSurcharge", "SourceCashbackPayment", "SourceCheckDepositAcceptance", @@ -1109,6 +1112,158 @@ class SourceCardFinancialNetworkIdentifiers(BaseModel): """ +class SourceCardFinancialSchemeFee(BaseModel): + amount: str + """The fee amount given as a string containing a decimal number.""" + + created_at: datetime + """ + The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was + created. + """ + + currency: Literal["USD"] + """ + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee + reimbursement. + + - `USD` - US Dollar (USD) + """ + + fee_type: Literal[ + "visa_international_service_assessment_single_currency", + "visa_international_service_assessment_cross_currency", + "visa_authorization_domestic_point_of_sale", + "visa_authorization_international_point_of_sale", + "visa_authorization_canada_point_of_sale", + "visa_authorization_reversal_point_of_sale", + "visa_authorization_reversal_international_point_of_sale", + "visa_authorization_address_verification_service", + "visa_advanced_authorization", + "visa_message_transmission", + "visa_account_verification_domestic", + "visa_account_verification_international", + "visa_account_verification_canada", + "visa_corporate_acceptance_fee", + "visa_consumer_debit_acceptance_fee", + "visa_business_debit_acceptance_fee", + "visa_purchasing_acceptance_fee", + "visa_purchase_domestic", + "visa_purchase_international", + "visa_credit_purchase_token", + "visa_debit_purchase_token", + "visa_clearing_transmission", + "visa_direct_authorization", + "visa_direct_transaction_domestic", + "visa_service_commercial_credit", + "visa_advertising_service_commercial_credit", + "visa_community_growth_acceleration_program", + "visa_processing_guarantee_commercial_credit", + "pulse_switch_fee", + ] + """The type of fee being assessed. + + - `visa_international_service_assessment_single_currency` - International + Service Assessment (ISA) single-currency is a fee assessed by the card network + for cross-border transactions presented and settled in the same currency. + - `visa_international_service_assessment_cross_currency` - International Service + Assessment (ISA) cross-currency is a fee assessed by the card network for + cross-border transactions presented and settled in different currencies. + - `visa_authorization_domestic_point_of_sale` - Activity and charges for Visa + Settlement System processing for POS (Point-Of-Sale) authorization + transactions. Authorization is the process of approving or declining the + transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_international_point_of_sale` - Activity and charges for + Visa Settlement System processing for POS (Point-Of-Sale) International + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_canada_point_of_sale` - Activity and charges for Visa + Settlement System processing for Canada Region POS (Point-of-Sale) + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. + - `visa_authorization_reversal_point_of_sale` - Activity only for Visa + Settlement System authorization processing of POS (Point-Of-Sale) reversal + transactions. Authorization reversal represents a VSS message that undoes the + complete or partial actions of a previous authorization request. + - `visa_authorization_reversal_international_point_of_sale` - Activity only for + Visa Settlement System authorization processing of POS (Point-Of-Sale) + International reversal transactions. Authorization reversal represents a VSS + message that undoes the complete or partial actions of a previous + authorization request. + - `visa_authorization_address_verification_service` - A per Address Verification + Service (AVS) result fee. Applies to all usable AVS result codes. + - `visa_advanced_authorization` - Advanced Authorization is a fraud detection + tool that monitors and risk evaluates 100 percent of US VisaNet authorizations + in real-time. Activity related to Purchase (includes Signature Authenticated + Visa and PIN Authenticated Visa Debit (PAVD) transactions). + - `visa_message_transmission` - Issuer Transactions Visa represents a charge + based on total actual monthly processing (Visa transactions only) through a + VisaNet Access Point (VAP). Charges are assessed to the processor for each + VisaNet Access Point. + - `visa_account_verification_domestic` - Activity, per inquiry, related to the + domestic Issuer for Account Number Verification. + - `visa_account_verification_international` - Activity, per inquiry, related to + the international Issuer for Account Number Verification. + - `visa_account_verification_canada` - Activity, per inquiry, related to the + US-Canada Issuer for Account Number Verification. + - `visa_corporate_acceptance_fee` - The Corporate Acceptance Fee is charged to + issuers and is based on the monthly sales volume on Commercial and Government + Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. + - `visa_consumer_debit_acceptance_fee` - The Consumer Debit Acceptance Fee is + charged to issuers and is based on the monthly sales volume of Consumer Debit + or Prepaid card transactions. The cashback portion of a Debit and Prepaid card + transaction is excluded from the sales volume calculation. + - `visa_business_debit_acceptance_fee` - The Business Acceptance Fee is charged + to issuers and is based on the monthly sales volume on Business Debit, + Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback + portion is included in the sales volume calculation with the exception of a + Debit and Prepaid card transactions. + - `visa_purchasing_acceptance_fee` - The Purchasing Card Acceptance Fee is + charged to issuers and is based on the monthly sales volume on Commercial and + Government Debit, Prepaid, Credit, Charge, or Deferred Debit card + transactions. + - `visa_purchase_domestic` - Activity and fees for the processing of a sales + draft original for a purchase transaction. + - `visa_purchase_international` - Activity and fees for the processing of an + international sales draft original for a purchase transaction. + - `visa_credit_purchase_token` - Apple Pay Credit Product Token Purchase + Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for + Apple Pay transactions. + - `visa_debit_purchase_token` - Apple Pay Debit Product Token Purchase Original + Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay + transactions. + - `visa_clearing_transmission` - A per transaction fee assessed for Base II + financial draft - Issuer. + - `visa_direct_authorization` - Issuer charge for Non-Financial OCT/AFT + Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. + - `visa_direct_transaction_domestic` - Data processing charge for Visa Direct + OCTs for all business application identifiers (BAIs) other than money + transfer-bank initiated (BI). BASE II transactions. + - `visa_service_commercial_credit` - Issuer card service fee for Commercial + Credit cards. + - `visa_advertising_service_commercial_credit` - Issuer Advertising Service Fee + for Commercial Credit cards. + - `visa_community_growth_acceleration_program` - Issuer Community Growth + Acceleration Program Fee. + - `visa_processing_guarantee_commercial_credit` - Issuer Processing Guarantee + for Commercial Credit cards. + - `pulse_switch_fee` - Pulse Switch Fee is a fee charged by the Pulse network + for processing transactions on its network. + """ + + fixed_component: Optional[str] = None + """ + The fixed component of the fee, if applicable, given in major units of the fee + amount. + """ + + variable_rate: Optional[str] = None + """ + The variable rate component of the fee, if applicable, given as a decimal (e.g., + 0.015 for 1.5%). + """ + + class SourceCardFinancialVerificationCardVerificationCode(BaseModel): """ Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. @@ -1363,6 +1518,9 @@ class SourceCardFinancial(BaseModel): transaction. """ + scheme_fees: List[SourceCardFinancialSchemeFee] + """The scheme fees associated with this card financial.""" + terminal_id: Optional[str] = None """ The terminal identifier (commonly abbreviated as TID) of the terminal the card @@ -1906,6 +2064,158 @@ class SourceCardRefundPurchaseDetails(BaseModel): """Fields specific to travel.""" +class SourceCardRefundSchemeFee(BaseModel): + amount: str + """The fee amount given as a string containing a decimal number.""" + + created_at: datetime + """ + The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was + created. + """ + + currency: Literal["USD"] + """ + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee + reimbursement. + + - `USD` - US Dollar (USD) + """ + + fee_type: Literal[ + "visa_international_service_assessment_single_currency", + "visa_international_service_assessment_cross_currency", + "visa_authorization_domestic_point_of_sale", + "visa_authorization_international_point_of_sale", + "visa_authorization_canada_point_of_sale", + "visa_authorization_reversal_point_of_sale", + "visa_authorization_reversal_international_point_of_sale", + "visa_authorization_address_verification_service", + "visa_advanced_authorization", + "visa_message_transmission", + "visa_account_verification_domestic", + "visa_account_verification_international", + "visa_account_verification_canada", + "visa_corporate_acceptance_fee", + "visa_consumer_debit_acceptance_fee", + "visa_business_debit_acceptance_fee", + "visa_purchasing_acceptance_fee", + "visa_purchase_domestic", + "visa_purchase_international", + "visa_credit_purchase_token", + "visa_debit_purchase_token", + "visa_clearing_transmission", + "visa_direct_authorization", + "visa_direct_transaction_domestic", + "visa_service_commercial_credit", + "visa_advertising_service_commercial_credit", + "visa_community_growth_acceleration_program", + "visa_processing_guarantee_commercial_credit", + "pulse_switch_fee", + ] + """The type of fee being assessed. + + - `visa_international_service_assessment_single_currency` - International + Service Assessment (ISA) single-currency is a fee assessed by the card network + for cross-border transactions presented and settled in the same currency. + - `visa_international_service_assessment_cross_currency` - International Service + Assessment (ISA) cross-currency is a fee assessed by the card network for + cross-border transactions presented and settled in different currencies. + - `visa_authorization_domestic_point_of_sale` - Activity and charges for Visa + Settlement System processing for POS (Point-Of-Sale) authorization + transactions. Authorization is the process of approving or declining the + transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_international_point_of_sale` - Activity and charges for + Visa Settlement System processing for POS (Point-Of-Sale) International + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_canada_point_of_sale` - Activity and charges for Visa + Settlement System processing for Canada Region POS (Point-of-Sale) + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. + - `visa_authorization_reversal_point_of_sale` - Activity only for Visa + Settlement System authorization processing of POS (Point-Of-Sale) reversal + transactions. Authorization reversal represents a VSS message that undoes the + complete or partial actions of a previous authorization request. + - `visa_authorization_reversal_international_point_of_sale` - Activity only for + Visa Settlement System authorization processing of POS (Point-Of-Sale) + International reversal transactions. Authorization reversal represents a VSS + message that undoes the complete or partial actions of a previous + authorization request. + - `visa_authorization_address_verification_service` - A per Address Verification + Service (AVS) result fee. Applies to all usable AVS result codes. + - `visa_advanced_authorization` - Advanced Authorization is a fraud detection + tool that monitors and risk evaluates 100 percent of US VisaNet authorizations + in real-time. Activity related to Purchase (includes Signature Authenticated + Visa and PIN Authenticated Visa Debit (PAVD) transactions). + - `visa_message_transmission` - Issuer Transactions Visa represents a charge + based on total actual monthly processing (Visa transactions only) through a + VisaNet Access Point (VAP). Charges are assessed to the processor for each + VisaNet Access Point. + - `visa_account_verification_domestic` - Activity, per inquiry, related to the + domestic Issuer for Account Number Verification. + - `visa_account_verification_international` - Activity, per inquiry, related to + the international Issuer for Account Number Verification. + - `visa_account_verification_canada` - Activity, per inquiry, related to the + US-Canada Issuer for Account Number Verification. + - `visa_corporate_acceptance_fee` - The Corporate Acceptance Fee is charged to + issuers and is based on the monthly sales volume on Commercial and Government + Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. + - `visa_consumer_debit_acceptance_fee` - The Consumer Debit Acceptance Fee is + charged to issuers and is based on the monthly sales volume of Consumer Debit + or Prepaid card transactions. The cashback portion of a Debit and Prepaid card + transaction is excluded from the sales volume calculation. + - `visa_business_debit_acceptance_fee` - The Business Acceptance Fee is charged + to issuers and is based on the monthly sales volume on Business Debit, + Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback + portion is included in the sales volume calculation with the exception of a + Debit and Prepaid card transactions. + - `visa_purchasing_acceptance_fee` - The Purchasing Card Acceptance Fee is + charged to issuers and is based on the monthly sales volume on Commercial and + Government Debit, Prepaid, Credit, Charge, or Deferred Debit card + transactions. + - `visa_purchase_domestic` - Activity and fees for the processing of a sales + draft original for a purchase transaction. + - `visa_purchase_international` - Activity and fees for the processing of an + international sales draft original for a purchase transaction. + - `visa_credit_purchase_token` - Apple Pay Credit Product Token Purchase + Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for + Apple Pay transactions. + - `visa_debit_purchase_token` - Apple Pay Debit Product Token Purchase Original + Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay + transactions. + - `visa_clearing_transmission` - A per transaction fee assessed for Base II + financial draft - Issuer. + - `visa_direct_authorization` - Issuer charge for Non-Financial OCT/AFT + Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. + - `visa_direct_transaction_domestic` - Data processing charge for Visa Direct + OCTs for all business application identifiers (BAIs) other than money + transfer-bank initiated (BI). BASE II transactions. + - `visa_service_commercial_credit` - Issuer card service fee for Commercial + Credit cards. + - `visa_advertising_service_commercial_credit` - Issuer Advertising Service Fee + for Commercial Credit cards. + - `visa_community_growth_acceleration_program` - Issuer Community Growth + Acceleration Program Fee. + - `visa_processing_guarantee_commercial_credit` - Issuer Processing Guarantee + for Commercial Credit cards. + - `pulse_switch_fee` - Pulse Switch Fee is a fee charged by the Pulse network + for processing transactions on its network. + """ + + fixed_component: Optional[str] = None + """ + The fixed component of the fee, if applicable, given in major units of the fee + amount. + """ + + variable_rate: Optional[str] = None + """ + The variable rate component of the fee, if applicable, given as a decimal (e.g., + 0.015 for 1.5%). + """ + + class SourceCardRefund(BaseModel): """A Card Refund object. @@ -1983,6 +2293,9 @@ class SourceCardRefund(BaseModel): fields. """ + scheme_fees: List[SourceCardRefundSchemeFee] + """The scheme fees associated with this card refund.""" + transaction_id: str """The identifier of the Transaction associated with this Transaction.""" @@ -2534,6 +2847,158 @@ class SourceCardSettlementPurchaseDetails(BaseModel): """Fields specific to travel.""" +class SourceCardSettlementSchemeFee(BaseModel): + amount: str + """The fee amount given as a string containing a decimal number.""" + + created_at: datetime + """ + The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was + created. + """ + + currency: Literal["USD"] + """ + The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee + reimbursement. + + - `USD` - US Dollar (USD) + """ + + fee_type: Literal[ + "visa_international_service_assessment_single_currency", + "visa_international_service_assessment_cross_currency", + "visa_authorization_domestic_point_of_sale", + "visa_authorization_international_point_of_sale", + "visa_authorization_canada_point_of_sale", + "visa_authorization_reversal_point_of_sale", + "visa_authorization_reversal_international_point_of_sale", + "visa_authorization_address_verification_service", + "visa_advanced_authorization", + "visa_message_transmission", + "visa_account_verification_domestic", + "visa_account_verification_international", + "visa_account_verification_canada", + "visa_corporate_acceptance_fee", + "visa_consumer_debit_acceptance_fee", + "visa_business_debit_acceptance_fee", + "visa_purchasing_acceptance_fee", + "visa_purchase_domestic", + "visa_purchase_international", + "visa_credit_purchase_token", + "visa_debit_purchase_token", + "visa_clearing_transmission", + "visa_direct_authorization", + "visa_direct_transaction_domestic", + "visa_service_commercial_credit", + "visa_advertising_service_commercial_credit", + "visa_community_growth_acceleration_program", + "visa_processing_guarantee_commercial_credit", + "pulse_switch_fee", + ] + """The type of fee being assessed. + + - `visa_international_service_assessment_single_currency` - International + Service Assessment (ISA) single-currency is a fee assessed by the card network + for cross-border transactions presented and settled in the same currency. + - `visa_international_service_assessment_cross_currency` - International Service + Assessment (ISA) cross-currency is a fee assessed by the card network for + cross-border transactions presented and settled in different currencies. + - `visa_authorization_domestic_point_of_sale` - Activity and charges for Visa + Settlement System processing for POS (Point-Of-Sale) authorization + transactions. Authorization is the process of approving or declining the + transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_international_point_of_sale` - Activity and charges for + Visa Settlement System processing for POS (Point-Of-Sale) International + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. The fee is assessed to the Issuer. + - `visa_authorization_canada_point_of_sale` - Activity and charges for Visa + Settlement System processing for Canada Region POS (Point-of-Sale) + authorization transactions. Authorization is the process of approving or + declining the transaction amount specified. + - `visa_authorization_reversal_point_of_sale` - Activity only for Visa + Settlement System authorization processing of POS (Point-Of-Sale) reversal + transactions. Authorization reversal represents a VSS message that undoes the + complete or partial actions of a previous authorization request. + - `visa_authorization_reversal_international_point_of_sale` - Activity only for + Visa Settlement System authorization processing of POS (Point-Of-Sale) + International reversal transactions. Authorization reversal represents a VSS + message that undoes the complete or partial actions of a previous + authorization request. + - `visa_authorization_address_verification_service` - A per Address Verification + Service (AVS) result fee. Applies to all usable AVS result codes. + - `visa_advanced_authorization` - Advanced Authorization is a fraud detection + tool that monitors and risk evaluates 100 percent of US VisaNet authorizations + in real-time. Activity related to Purchase (includes Signature Authenticated + Visa and PIN Authenticated Visa Debit (PAVD) transactions). + - `visa_message_transmission` - Issuer Transactions Visa represents a charge + based on total actual monthly processing (Visa transactions only) through a + VisaNet Access Point (VAP). Charges are assessed to the processor for each + VisaNet Access Point. + - `visa_account_verification_domestic` - Activity, per inquiry, related to the + domestic Issuer for Account Number Verification. + - `visa_account_verification_international` - Activity, per inquiry, related to + the international Issuer for Account Number Verification. + - `visa_account_verification_canada` - Activity, per inquiry, related to the + US-Canada Issuer for Account Number Verification. + - `visa_corporate_acceptance_fee` - The Corporate Acceptance Fee is charged to + issuers and is based on the monthly sales volume on Commercial and Government + Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. + - `visa_consumer_debit_acceptance_fee` - The Consumer Debit Acceptance Fee is + charged to issuers and is based on the monthly sales volume of Consumer Debit + or Prepaid card transactions. The cashback portion of a Debit and Prepaid card + transaction is excluded from the sales volume calculation. + - `visa_business_debit_acceptance_fee` - The Business Acceptance Fee is charged + to issuers and is based on the monthly sales volume on Business Debit, + Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback + portion is included in the sales volume calculation with the exception of a + Debit and Prepaid card transactions. + - `visa_purchasing_acceptance_fee` - The Purchasing Card Acceptance Fee is + charged to issuers and is based on the monthly sales volume on Commercial and + Government Debit, Prepaid, Credit, Charge, or Deferred Debit card + transactions. + - `visa_purchase_domestic` - Activity and fees for the processing of a sales + draft original for a purchase transaction. + - `visa_purchase_international` - Activity and fees for the processing of an + international sales draft original for a purchase transaction. + - `visa_credit_purchase_token` - Apple Pay Credit Product Token Purchase + Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for + Apple Pay transactions. + - `visa_debit_purchase_token` - Apple Pay Debit Product Token Purchase Original + Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay + transactions. + - `visa_clearing_transmission` - A per transaction fee assessed for Base II + financial draft - Issuer. + - `visa_direct_authorization` - Issuer charge for Non-Financial OCT/AFT + Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. + - `visa_direct_transaction_domestic` - Data processing charge for Visa Direct + OCTs for all business application identifiers (BAIs) other than money + transfer-bank initiated (BI). BASE II transactions. + - `visa_service_commercial_credit` - Issuer card service fee for Commercial + Credit cards. + - `visa_advertising_service_commercial_credit` - Issuer Advertising Service Fee + for Commercial Credit cards. + - `visa_community_growth_acceleration_program` - Issuer Community Growth + Acceleration Program Fee. + - `visa_processing_guarantee_commercial_credit` - Issuer Processing Guarantee + for Commercial Credit cards. + - `pulse_switch_fee` - Pulse Switch Fee is a fee charged by the Pulse network + for processing transactions on its network. + """ + + fixed_component: Optional[str] = None + """ + The fixed component of the fee, if applicable, given in major units of the fee + amount. + """ + + variable_rate: Optional[str] = None + """ + The variable rate component of the fee, if applicable, given as a decimal (e.g., + 0.015 for 1.5%). + """ + + class SourceCardSettlementSurcharge(BaseModel): """Surcharge amount details, if applicable. @@ -2645,6 +3110,9 @@ class SourceCardSettlement(BaseModel): fields. """ + scheme_fees: List[SourceCardSettlementSchemeFee] + """The scheme fees associated with this card settlement.""" + surcharge: Optional[SourceCardSettlementSurcharge] = None """Surcharge amount details, if applicable.