diff --git a/src/increase/types/card_payment.py b/src/increase/types/card_payment.py index 7a7f0e5f6..4db76293a 100644 --- a/src/increase/types/card_payment.py +++ b/src/increase/types/card_payment.py @@ -10,14 +10,18 @@ "CardPayment", "Element", "ElementCardAuthorization", - "ElementCardAuthorizationCardholderAddress", "ElementCardAuthorizationNetworkDetails", "ElementCardAuthorizationNetworkDetailsVisa", + "ElementCardAuthorizationVerification", + "ElementCardAuthorizationVerificationCardVerificationCode", + "ElementCardAuthorizationVerificationCardholderAddress", "ElementCardAuthorizationExpiration", "ElementCardDecline", - "ElementCardDeclineCardholderAddress", "ElementCardDeclineNetworkDetails", "ElementCardDeclineNetworkDetailsVisa", + "ElementCardDeclineVerification", + "ElementCardDeclineVerificationCardVerificationCode", + "ElementCardDeclineVerificationCardholderAddress", "ElementCardIncrement", "ElementCardRefund", "ElementCardRefundPurchaseDetails", @@ -37,51 +41,15 @@ "ElementCardSettlementPurchaseDetailsTravelAncillaryService", "ElementCardSettlementPurchaseDetailsTravelTripLeg", "ElementCardValidation", - "ElementCardValidationCardholderAddress", "ElementCardValidationNetworkDetails", "ElementCardValidationNetworkDetailsVisa", + "ElementCardValidationVerification", + "ElementCardValidationVerificationCardVerificationCode", + "ElementCardValidationVerificationCardholderAddress", "State", ] -class ElementCardAuthorizationCardholderAddress(BaseModel): - actual_line1: Optional[str] - """Line 1 of the address on file for the cardholder.""" - - actual_postal_code: Optional[str] - """The postal code of the address on file for the cardholder.""" - - provided_line1: Optional[str] - """ - The cardholder address line 1 provided for verification in the authorization - request. - """ - - provided_postal_code: Optional[str] - """The postal code provided for verification in the authorization request.""" - - verification_result: Literal[ - "not_checked", - "postal_code_match_address_not_checked", - "postal_code_match_address_no_match", - "postal_code_no_match_address_match", - "match", - "no_match", - ] - """The address verification result returned to the card network. - - - `not_checked` - No adress was provided in the authorization request. - - `postal_code_match_address_not_checked` - Postal code matches, but the street - address was not verified - - `postal_code_match_address_no_match` - Postal code matches, but the street - address does not match - - `postal_code_no_match_address_match` - Postal code does not match, but the - street address matches - - `match` - Postal code and street address match - - `no_match` - Postal code and street address do not match - """ - - class ElementCardAuthorizationNetworkDetailsVisa(BaseModel): electronic_commerce_indicator: Optional[ Literal[ @@ -176,6 +144,69 @@ class ElementCardAuthorizationNetworkDetails(BaseModel): """Fields specific to the `visa` network.""" +class ElementCardAuthorizationVerificationCardVerificationCode(BaseModel): + 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 ElementCardAuthorizationVerificationCardholderAddress(BaseModel): + actual_line1: Optional[str] + """Line 1 of the address on file for the cardholder.""" + + actual_postal_code: Optional[str] + """The postal code of the address on file for the cardholder.""" + + provided_line1: Optional[str] + """ + The cardholder address line 1 provided for verification in the authorization + request. + """ + + provided_postal_code: Optional[str] + """The postal code provided for verification in the authorization request.""" + + result: Literal[ + "not_checked", + "postal_code_match_address_not_checked", + "postal_code_match_address_no_match", + "postal_code_no_match_address_match", + "match", + "no_match", + ] + """The address verification result returned to the card network. + + - `not_checked` - No adress was provided in the authorization request. + - `postal_code_match_address_not_checked` - Postal code matches, but the street + address was not verified. + - `postal_code_match_address_no_match` - Postal code matches, but the street + address does not match. + - `postal_code_no_match_address_match` - Postal code does not match, but the + street address matches. + - `match` - Postal code and street address match. + - `no_match` - Postal code and street address do not match. + """ + + +class ElementCardAuthorizationVerification(BaseModel): + card_verification_code: ElementCardAuthorizationVerificationCardVerificationCode + """ + Fields related to verification of the Card Verification Code, a 3-digit code on + the back of the card. + """ + + cardholder_address: ElementCardAuthorizationVerificationCardholderAddress + """ + Cardholder address provided in the authorization request and the address on file + we verified it against. + """ + + class ElementCardAuthorization(BaseModel): id: str """The Card Authorization identifier.""" @@ -189,12 +220,6 @@ class ElementCardAuthorization(BaseModel): card_payment_id: Optional[str] """The ID of the Card Payment this transaction belongs to.""" - cardholder_address: ElementCardAuthorizationCardholderAddress - """ - Cardholder address provided in the authorization request and the address on file - we verified it against. - """ - currency: Literal["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] """ The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the @@ -276,6 +301,9 @@ class ElementCardAuthorization(BaseModel): For this resource it will always be `card_authorization`. """ + verification: ElementCardAuthorizationVerification + """Fields related to verification of cardholder-provided values.""" + class ElementCardAuthorizationExpiration(BaseModel): id: str @@ -316,44 +344,6 @@ class ElementCardAuthorizationExpiration(BaseModel): """ -class ElementCardDeclineCardholderAddress(BaseModel): - actual_line1: Optional[str] - """Line 1 of the address on file for the cardholder.""" - - actual_postal_code: Optional[str] - """The postal code of the address on file for the cardholder.""" - - provided_line1: Optional[str] - """ - The cardholder address line 1 provided for verification in the authorization - request. - """ - - provided_postal_code: Optional[str] - """The postal code provided for verification in the authorization request.""" - - verification_result: Literal[ - "not_checked", - "postal_code_match_address_not_checked", - "postal_code_match_address_no_match", - "postal_code_no_match_address_match", - "match", - "no_match", - ] - """The address verification result returned to the card network. - - - `not_checked` - No adress was provided in the authorization request. - - `postal_code_match_address_not_checked` - Postal code matches, but the street - address was not verified - - `postal_code_match_address_no_match` - Postal code matches, but the street - address does not match - - `postal_code_no_match_address_match` - Postal code does not match, but the - street address matches - - `match` - Postal code and street address match - - `no_match` - Postal code and street address do not match - """ - - class ElementCardDeclineNetworkDetailsVisa(BaseModel): electronic_commerce_indicator: Optional[ Literal[ @@ -448,6 +438,69 @@ class ElementCardDeclineNetworkDetails(BaseModel): """Fields specific to the `visa` network.""" +class ElementCardDeclineVerificationCardVerificationCode(BaseModel): + 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): + actual_line1: Optional[str] + """Line 1 of the address on file for the cardholder.""" + + actual_postal_code: Optional[str] + """The postal code of the address on file for the cardholder.""" + + provided_line1: Optional[str] + """ + The cardholder address line 1 provided for verification in the authorization + request. + """ + + provided_postal_code: Optional[str] + """The postal code provided for verification in the authorization request.""" + + result: Literal[ + "not_checked", + "postal_code_match_address_not_checked", + "postal_code_match_address_no_match", + "postal_code_no_match_address_match", + "match", + "no_match", + ] + """The address verification result returned to the card network. + + - `not_checked` - No adress was provided in the authorization request. + - `postal_code_match_address_not_checked` - Postal code matches, but the street + address was not verified. + - `postal_code_match_address_no_match` - Postal code matches, but the street + address does not match. + - `postal_code_no_match_address_match` - Postal code does not match, but the + street address matches. + - `match` - Postal code and street address match. + - `no_match` - Postal code and street address do not match. + """ + + +class ElementCardDeclineVerification(BaseModel): + card_verification_code: ElementCardDeclineVerificationCardVerificationCode + """ + Fields related to verification of the Card Verification Code, a 3-digit code on + the back of the card. + """ + + cardholder_address: ElementCardDeclineVerificationCardholderAddress + """ + Cardholder address provided in the authorization request and the address on file + we verified it against. + """ + + class ElementCardDecline(BaseModel): id: str """The Card Decline identifier.""" @@ -461,12 +514,6 @@ class ElementCardDecline(BaseModel): card_payment_id: Optional[str] """The ID of the Card Payment this transaction belongs to.""" - cardholder_address: ElementCardDeclineCardholderAddress - """ - Cardholder address provided in the authorization request and the address on file - we verified it against. - """ - currency: Literal["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] """ The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination @@ -565,6 +612,9 @@ class ElementCardDecline(BaseModel): reach out to support@increase.com for more information. """ + verification: ElementCardDeclineVerification + """Fields related to verification of cardholder-provided values.""" + class ElementCardIncrement(BaseModel): id: str @@ -1620,44 +1670,6 @@ class ElementCardSettlement(BaseModel): """ -class ElementCardValidationCardholderAddress(BaseModel): - actual_line1: Optional[str] - """Line 1 of the address on file for the cardholder.""" - - actual_postal_code: Optional[str] - """The postal code of the address on file for the cardholder.""" - - provided_line1: Optional[str] - """ - The cardholder address line 1 provided for verification in the authorization - request. - """ - - provided_postal_code: Optional[str] - """The postal code provided for verification in the authorization request.""" - - verification_result: Literal[ - "not_checked", - "postal_code_match_address_not_checked", - "postal_code_match_address_no_match", - "postal_code_no_match_address_match", - "match", - "no_match", - ] - """The address verification result returned to the card network. - - - `not_checked` - No adress was provided in the authorization request. - - `postal_code_match_address_not_checked` - Postal code matches, but the street - address was not verified - - `postal_code_match_address_no_match` - Postal code matches, but the street - address does not match - - `postal_code_no_match_address_match` - Postal code does not match, but the - street address matches - - `match` - Postal code and street address match - - `no_match` - Postal code and street address do not match - """ - - class ElementCardValidationNetworkDetailsVisa(BaseModel): electronic_commerce_indicator: Optional[ Literal[ @@ -1752,19 +1764,76 @@ class ElementCardValidationNetworkDetails(BaseModel): """Fields specific to the `visa` network.""" -class ElementCardValidation(BaseModel): - id: str - """The Card Validation identifier.""" +class ElementCardValidationVerificationCardVerificationCode(BaseModel): + result: Literal["not_checked", "match", "no_match"] + """The result of verifying the Card Verification Code. - card_payment_id: Optional[str] - """The ID of the Card Payment this transaction belongs to.""" + - `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 ElementCardValidationVerificationCardholderAddress(BaseModel): + actual_line1: Optional[str] + """Line 1 of the address on file for the cardholder.""" + + actual_postal_code: Optional[str] + """The postal code of the address on file for the cardholder.""" + + provided_line1: Optional[str] + """ + The cardholder address line 1 provided for verification in the authorization + request. + """ + + provided_postal_code: Optional[str] + """The postal code provided for verification in the authorization request.""" + + result: Literal[ + "not_checked", + "postal_code_match_address_not_checked", + "postal_code_match_address_no_match", + "postal_code_no_match_address_match", + "match", + "no_match", + ] + """The address verification result returned to the card network. + + - `not_checked` - No adress was provided in the authorization request. + - `postal_code_match_address_not_checked` - Postal code matches, but the street + address was not verified. + - `postal_code_match_address_no_match` - Postal code matches, but the street + address does not match. + - `postal_code_no_match_address_match` - Postal code does not match, but the + street address matches. + - `match` - Postal code and street address match. + - `no_match` - Postal code and street address do not match. + """ + + +class ElementCardValidationVerification(BaseModel): + card_verification_code: ElementCardValidationVerificationCardVerificationCode + """ + Fields related to verification of the Card Verification Code, a 3-digit code on + the back of the card. + """ - cardholder_address: ElementCardValidationCardholderAddress + cardholder_address: ElementCardValidationVerificationCardholderAddress """ Cardholder address provided in the authorization request and the address on file we verified it against. """ + +class ElementCardValidation(BaseModel): + id: str + """The Card Validation identifier.""" + + card_payment_id: Optional[str] + """The ID of the Card Payment this transaction belongs to.""" + currency: Literal["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] """ The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the @@ -1826,6 +1895,9 @@ class ElementCardValidation(BaseModel): For this resource it will always be `card_validation`. """ + verification: ElementCardValidationVerification + """Fields related to verification of cardholder-provided values.""" + class Element(BaseModel): card_authorization: Optional[ElementCardAuthorization] diff --git a/src/increase/types/declined_transaction.py b/src/increase/types/declined_transaction.py index e8f01671c..29057d4ad 100644 --- a/src/increase/types/declined_transaction.py +++ b/src/increase/types/declined_transaction.py @@ -11,9 +11,11 @@ "Source", "SourceACHDecline", "SourceCardDecline", - "SourceCardDeclineCardholderAddress", "SourceCardDeclineNetworkDetails", "SourceCardDeclineNetworkDetailsVisa", + "SourceCardDeclineVerification", + "SourceCardDeclineVerificationCardVerificationCode", + "SourceCardDeclineVerificationCardholderAddress", "SourceCheckDecline", "SourceInboundRealTimePaymentsTransferDecline", "SourceInternationalACHDecline", @@ -100,44 +102,6 @@ class SourceACHDecline(BaseModel): """ -class SourceCardDeclineCardholderAddress(BaseModel): - actual_line1: Optional[str] - """Line 1 of the address on file for the cardholder.""" - - actual_postal_code: Optional[str] - """The postal code of the address on file for the cardholder.""" - - provided_line1: Optional[str] - """ - The cardholder address line 1 provided for verification in the authorization - request. - """ - - provided_postal_code: Optional[str] - """The postal code provided for verification in the authorization request.""" - - verification_result: Literal[ - "not_checked", - "postal_code_match_address_not_checked", - "postal_code_match_address_no_match", - "postal_code_no_match_address_match", - "match", - "no_match", - ] - """The address verification result returned to the card network. - - - `not_checked` - No adress was provided in the authorization request. - - `postal_code_match_address_not_checked` - Postal code matches, but the street - address was not verified - - `postal_code_match_address_no_match` - Postal code matches, but the street - address does not match - - `postal_code_no_match_address_match` - Postal code does not match, but the - street address matches - - `match` - Postal code and street address match - - `no_match` - Postal code and street address do not match - """ - - class SourceCardDeclineNetworkDetailsVisa(BaseModel): electronic_commerce_indicator: Optional[ Literal[ @@ -232,6 +196,69 @@ class SourceCardDeclineNetworkDetails(BaseModel): """Fields specific to the `visa` network.""" +class SourceCardDeclineVerificationCardVerificationCode(BaseModel): + 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 SourceCardDeclineVerificationCardholderAddress(BaseModel): + actual_line1: Optional[str] + """Line 1 of the address on file for the cardholder.""" + + actual_postal_code: Optional[str] + """The postal code of the address on file for the cardholder.""" + + provided_line1: Optional[str] + """ + The cardholder address line 1 provided for verification in the authorization + request. + """ + + provided_postal_code: Optional[str] + """The postal code provided for verification in the authorization request.""" + + result: Literal[ + "not_checked", + "postal_code_match_address_not_checked", + "postal_code_match_address_no_match", + "postal_code_no_match_address_match", + "match", + "no_match", + ] + """The address verification result returned to the card network. + + - `not_checked` - No adress was provided in the authorization request. + - `postal_code_match_address_not_checked` - Postal code matches, but the street + address was not verified. + - `postal_code_match_address_no_match` - Postal code matches, but the street + address does not match. + - `postal_code_no_match_address_match` - Postal code does not match, but the + street address matches. + - `match` - Postal code and street address match. + - `no_match` - Postal code and street address do not match. + """ + + +class SourceCardDeclineVerification(BaseModel): + card_verification_code: SourceCardDeclineVerificationCardVerificationCode + """ + Fields related to verification of the Card Verification Code, a 3-digit code on + the back of the card. + """ + + cardholder_address: SourceCardDeclineVerificationCardholderAddress + """ + Cardholder address provided in the authorization request and the address on file + we verified it against. + """ + + class SourceCardDecline(BaseModel): id: str """The Card Decline identifier.""" @@ -245,12 +272,6 @@ class SourceCardDecline(BaseModel): card_payment_id: Optional[str] """The ID of the Card Payment this transaction belongs to.""" - cardholder_address: SourceCardDeclineCardholderAddress - """ - Cardholder address provided in the authorization request and the address on file - we verified it against. - """ - currency: Literal["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] """ The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination @@ -349,6 +370,9 @@ class SourceCardDecline(BaseModel): reach out to support@increase.com for more information. """ + verification: SourceCardDeclineVerification + """Fields related to verification of cardholder-provided values.""" + class SourceCheckDecline(BaseModel): amount: int diff --git a/src/increase/types/pending_transaction.py b/src/increase/types/pending_transaction.py index 555a35d2f..cea6cc24d 100644 --- a/src/increase/types/pending_transaction.py +++ b/src/increase/types/pending_transaction.py @@ -12,9 +12,11 @@ "SourceAccountTransferInstruction", "SourceACHTransferInstruction", "SourceCardAuthorization", - "SourceCardAuthorizationCardholderAddress", "SourceCardAuthorizationNetworkDetails", "SourceCardAuthorizationNetworkDetailsVisa", + "SourceCardAuthorizationVerification", + "SourceCardAuthorizationVerificationCardVerificationCode", + "SourceCardAuthorizationVerificationCardholderAddress", "SourceCheckDepositInstruction", "SourceCheckTransferInstruction", "SourceInboundFundsHold", @@ -58,44 +60,6 @@ class SourceACHTransferInstruction(BaseModel): """The identifier of the ACH Transfer that led to this Pending Transaction.""" -class SourceCardAuthorizationCardholderAddress(BaseModel): - actual_line1: Optional[str] - """Line 1 of the address on file for the cardholder.""" - - actual_postal_code: Optional[str] - """The postal code of the address on file for the cardholder.""" - - provided_line1: Optional[str] - """ - The cardholder address line 1 provided for verification in the authorization - request. - """ - - provided_postal_code: Optional[str] - """The postal code provided for verification in the authorization request.""" - - verification_result: Literal[ - "not_checked", - "postal_code_match_address_not_checked", - "postal_code_match_address_no_match", - "postal_code_no_match_address_match", - "match", - "no_match", - ] - """The address verification result returned to the card network. - - - `not_checked` - No adress was provided in the authorization request. - - `postal_code_match_address_not_checked` - Postal code matches, but the street - address was not verified - - `postal_code_match_address_no_match` - Postal code matches, but the street - address does not match - - `postal_code_no_match_address_match` - Postal code does not match, but the - street address matches - - `match` - Postal code and street address match - - `no_match` - Postal code and street address do not match - """ - - class SourceCardAuthorizationNetworkDetailsVisa(BaseModel): electronic_commerce_indicator: Optional[ Literal[ @@ -190,6 +154,69 @@ class SourceCardAuthorizationNetworkDetails(BaseModel): """Fields specific to the `visa` network.""" +class SourceCardAuthorizationVerificationCardVerificationCode(BaseModel): + 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 SourceCardAuthorizationVerificationCardholderAddress(BaseModel): + actual_line1: Optional[str] + """Line 1 of the address on file for the cardholder.""" + + actual_postal_code: Optional[str] + """The postal code of the address on file for the cardholder.""" + + provided_line1: Optional[str] + """ + The cardholder address line 1 provided for verification in the authorization + request. + """ + + provided_postal_code: Optional[str] + """The postal code provided for verification in the authorization request.""" + + result: Literal[ + "not_checked", + "postal_code_match_address_not_checked", + "postal_code_match_address_no_match", + "postal_code_no_match_address_match", + "match", + "no_match", + ] + """The address verification result returned to the card network. + + - `not_checked` - No adress was provided in the authorization request. + - `postal_code_match_address_not_checked` - Postal code matches, but the street + address was not verified. + - `postal_code_match_address_no_match` - Postal code matches, but the street + address does not match. + - `postal_code_no_match_address_match` - Postal code does not match, but the + street address matches. + - `match` - Postal code and street address match. + - `no_match` - Postal code and street address do not match. + """ + + +class SourceCardAuthorizationVerification(BaseModel): + card_verification_code: SourceCardAuthorizationVerificationCardVerificationCode + """ + Fields related to verification of the Card Verification Code, a 3-digit code on + the back of the card. + """ + + cardholder_address: SourceCardAuthorizationVerificationCardholderAddress + """ + Cardholder address provided in the authorization request and the address on file + we verified it against. + """ + + class SourceCardAuthorization(BaseModel): id: str """The Card Authorization identifier.""" @@ -203,12 +230,6 @@ class SourceCardAuthorization(BaseModel): card_payment_id: Optional[str] """The ID of the Card Payment this transaction belongs to.""" - cardholder_address: SourceCardAuthorizationCardholderAddress - """ - Cardholder address provided in the authorization request and the address on file - we verified it against. - """ - currency: Literal["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] """ The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the @@ -290,6 +311,9 @@ class SourceCardAuthorization(BaseModel): For this resource it will always be `card_authorization`. """ + verification: SourceCardAuthorizationVerification + """Fields related to verification of cardholder-provided values.""" + class SourceCheckDepositInstruction(BaseModel): amount: int diff --git a/src/increase/types/real_time_decision.py b/src/increase/types/real_time_decision.py index 8f24a6347..5e2c751fc 100644 --- a/src/increase/types/real_time_decision.py +++ b/src/increase/types/real_time_decision.py @@ -9,54 +9,18 @@ __all__ = [ "RealTimeDecision", "CardAuthorization", - "CardAuthorizationCardholderAddress", "CardAuthorizationNetworkDetails", "CardAuthorizationNetworkDetailsVisa", "CardAuthorizationRequestDetails", "CardAuthorizationRequestDetailsIncrementalAuthorization", + "CardAuthorizationVerification", + "CardAuthorizationVerificationCardVerificationCode", + "CardAuthorizationVerificationCardholderAddress", "DigitalWalletAuthentication", "DigitalWalletToken", ] -class CardAuthorizationCardholderAddress(BaseModel): - actual_line1: Optional[str] - """Line 1 of the address on file for the cardholder.""" - - actual_postal_code: Optional[str] - """The postal code of the address on file for the cardholder.""" - - provided_line1: Optional[str] - """ - The cardholder address line 1 provided for verification in the authorization - request. - """ - - provided_postal_code: Optional[str] - """The postal code provided for verification in the authorization request.""" - - verification_result: Literal[ - "not_checked", - "postal_code_match_address_not_checked", - "postal_code_match_address_no_match", - "postal_code_no_match_address_match", - "match", - "no_match", - ] - """The address verification result returned to the card network. - - - `not_checked` - No adress was provided in the authorization request. - - `postal_code_match_address_not_checked` - Postal code matches, but the street - address was not verified - - `postal_code_match_address_no_match` - Postal code matches, but the street - address does not match - - `postal_code_no_match_address_match` - Postal code does not match, but the - street address matches - - `match` - Postal code and street address match - - `no_match` - Postal code and street address do not match - """ - - class CardAuthorizationNetworkDetailsVisa(BaseModel): electronic_commerce_indicator: Optional[ Literal[ @@ -180,19 +144,76 @@ class CardAuthorizationRequestDetails(BaseModel): """Fields specific to the category `initial_authorization`.""" -class CardAuthorization(BaseModel): - account_id: str - """The identifier of the Account the authorization will debit.""" +class CardAuthorizationVerificationCardVerificationCode(BaseModel): + result: Literal["not_checked", "match", "no_match"] + """The result of verifying the Card Verification Code. - card_id: str - """The identifier of the Card that is being authorized.""" + - `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 CardAuthorizationVerificationCardholderAddress(BaseModel): + actual_line1: Optional[str] + """Line 1 of the address on file for the cardholder.""" - cardholder_address: CardAuthorizationCardholderAddress + actual_postal_code: Optional[str] + """The postal code of the address on file for the cardholder.""" + + provided_line1: Optional[str] + """ + The cardholder address line 1 provided for verification in the authorization + request. + """ + + provided_postal_code: Optional[str] + """The postal code provided for verification in the authorization request.""" + + result: Literal[ + "not_checked", + "postal_code_match_address_not_checked", + "postal_code_match_address_no_match", + "postal_code_no_match_address_match", + "match", + "no_match", + ] + """The address verification result returned to the card network. + + - `not_checked` - No adress was provided in the authorization request. + - `postal_code_match_address_not_checked` - Postal code matches, but the street + address was not verified. + - `postal_code_match_address_no_match` - Postal code matches, but the street + address does not match. + - `postal_code_no_match_address_match` - Postal code does not match, but the + street address matches. + - `match` - Postal code and street address match. + - `no_match` - Postal code and street address do not match. + """ + + +class CardAuthorizationVerification(BaseModel): + card_verification_code: CardAuthorizationVerificationCardVerificationCode + """ + Fields related to verification of the Card Verification Code, a 3-digit code on + the back of the card. + """ + + cardholder_address: CardAuthorizationVerificationCardholderAddress """ Cardholder address provided in the authorization request and the address on file we verified it against. """ + +class CardAuthorization(BaseModel): + account_id: str + """The identifier of the Account the authorization will debit.""" + + card_id: str + """The identifier of the Card that is being authorized.""" + decision: Optional[Literal["approve", "decline"]] """Whether or not the authorization was approved. @@ -264,6 +285,9 @@ class CardAuthorization(BaseModel): transaction will be settled in. """ + verification: CardAuthorizationVerification + """Fields related to verification of cardholder-provided values.""" + class DigitalWalletAuthentication(BaseModel): card_id: str diff --git a/src/increase/types/simulations/ach_transfer_simulation.py b/src/increase/types/simulations/ach_transfer_simulation.py index 67ad460cf..bae644da1 100644 --- a/src/increase/types/simulations/ach_transfer_simulation.py +++ b/src/increase/types/simulations/ach_transfer_simulation.py @@ -12,9 +12,11 @@ "DeclinedTransactionSource", "DeclinedTransactionSourceACHDecline", "DeclinedTransactionSourceCardDecline", - "DeclinedTransactionSourceCardDeclineCardholderAddress", "DeclinedTransactionSourceCardDeclineNetworkDetails", "DeclinedTransactionSourceCardDeclineNetworkDetailsVisa", + "DeclinedTransactionSourceCardDeclineVerification", + "DeclinedTransactionSourceCardDeclineVerificationCardVerificationCode", + "DeclinedTransactionSourceCardDeclineVerificationCardholderAddress", "DeclinedTransactionSourceCheckDecline", "DeclinedTransactionSourceInboundRealTimePaymentsTransferDecline", "DeclinedTransactionSourceInternationalACHDecline", @@ -153,44 +155,6 @@ class DeclinedTransactionSourceACHDecline(BaseModel): """ -class DeclinedTransactionSourceCardDeclineCardholderAddress(BaseModel): - actual_line1: Optional[str] - """Line 1 of the address on file for the cardholder.""" - - actual_postal_code: Optional[str] - """The postal code of the address on file for the cardholder.""" - - provided_line1: Optional[str] - """ - The cardholder address line 1 provided for verification in the authorization - request. - """ - - provided_postal_code: Optional[str] - """The postal code provided for verification in the authorization request.""" - - verification_result: Literal[ - "not_checked", - "postal_code_match_address_not_checked", - "postal_code_match_address_no_match", - "postal_code_no_match_address_match", - "match", - "no_match", - ] - """The address verification result returned to the card network. - - - `not_checked` - No adress was provided in the authorization request. - - `postal_code_match_address_not_checked` - Postal code matches, but the street - address was not verified - - `postal_code_match_address_no_match` - Postal code matches, but the street - address does not match - - `postal_code_no_match_address_match` - Postal code does not match, but the - street address matches - - `match` - Postal code and street address match - - `no_match` - Postal code and street address do not match - """ - - class DeclinedTransactionSourceCardDeclineNetworkDetailsVisa(BaseModel): electronic_commerce_indicator: Optional[ Literal[ @@ -285,6 +249,69 @@ class DeclinedTransactionSourceCardDeclineNetworkDetails(BaseModel): """Fields specific to the `visa` network.""" +class DeclinedTransactionSourceCardDeclineVerificationCardVerificationCode(BaseModel): + 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 DeclinedTransactionSourceCardDeclineVerificationCardholderAddress(BaseModel): + actual_line1: Optional[str] + """Line 1 of the address on file for the cardholder.""" + + actual_postal_code: Optional[str] + """The postal code of the address on file for the cardholder.""" + + provided_line1: Optional[str] + """ + The cardholder address line 1 provided for verification in the authorization + request. + """ + + provided_postal_code: Optional[str] + """The postal code provided for verification in the authorization request.""" + + result: Literal[ + "not_checked", + "postal_code_match_address_not_checked", + "postal_code_match_address_no_match", + "postal_code_no_match_address_match", + "match", + "no_match", + ] + """The address verification result returned to the card network. + + - `not_checked` - No adress was provided in the authorization request. + - `postal_code_match_address_not_checked` - Postal code matches, but the street + address was not verified. + - `postal_code_match_address_no_match` - Postal code matches, but the street + address does not match. + - `postal_code_no_match_address_match` - Postal code does not match, but the + street address matches. + - `match` - Postal code and street address match. + - `no_match` - Postal code and street address do not match. + """ + + +class DeclinedTransactionSourceCardDeclineVerification(BaseModel): + card_verification_code: DeclinedTransactionSourceCardDeclineVerificationCardVerificationCode + """ + Fields related to verification of the Card Verification Code, a 3-digit code on + the back of the card. + """ + + cardholder_address: DeclinedTransactionSourceCardDeclineVerificationCardholderAddress + """ + Cardholder address provided in the authorization request and the address on file + we verified it against. + """ + + class DeclinedTransactionSourceCardDecline(BaseModel): id: str """The Card Decline identifier.""" @@ -298,12 +325,6 @@ class DeclinedTransactionSourceCardDecline(BaseModel): card_payment_id: Optional[str] """The ID of the Card Payment this transaction belongs to.""" - cardholder_address: DeclinedTransactionSourceCardDeclineCardholderAddress - """ - Cardholder address provided in the authorization request and the address on file - we verified it against. - """ - currency: Literal["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] """ The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination @@ -402,6 +423,9 @@ class DeclinedTransactionSourceCardDecline(BaseModel): reach out to support@increase.com for more information. """ + verification: DeclinedTransactionSourceCardDeclineVerification + """Fields related to verification of cardholder-provided values.""" + class DeclinedTransactionSourceCheckDecline(BaseModel): amount: int diff --git a/src/increase/types/simulations/card_authorization_simulation.py b/src/increase/types/simulations/card_authorization_simulation.py index 1e443257a..a16e8454a 100644 --- a/src/increase/types/simulations/card_authorization_simulation.py +++ b/src/increase/types/simulations/card_authorization_simulation.py @@ -12,9 +12,11 @@ "DeclinedTransactionSource", "DeclinedTransactionSourceACHDecline", "DeclinedTransactionSourceCardDecline", - "DeclinedTransactionSourceCardDeclineCardholderAddress", "DeclinedTransactionSourceCardDeclineNetworkDetails", "DeclinedTransactionSourceCardDeclineNetworkDetailsVisa", + "DeclinedTransactionSourceCardDeclineVerification", + "DeclinedTransactionSourceCardDeclineVerificationCardVerificationCode", + "DeclinedTransactionSourceCardDeclineVerificationCardholderAddress", "DeclinedTransactionSourceCheckDecline", "DeclinedTransactionSourceInboundRealTimePaymentsTransferDecline", "DeclinedTransactionSourceInternationalACHDecline", @@ -24,9 +26,11 @@ "PendingTransactionSourceAccountTransferInstruction", "PendingTransactionSourceACHTransferInstruction", "PendingTransactionSourceCardAuthorization", - "PendingTransactionSourceCardAuthorizationCardholderAddress", "PendingTransactionSourceCardAuthorizationNetworkDetails", "PendingTransactionSourceCardAuthorizationNetworkDetailsVisa", + "PendingTransactionSourceCardAuthorizationVerification", + "PendingTransactionSourceCardAuthorizationVerificationCardVerificationCode", + "PendingTransactionSourceCardAuthorizationVerificationCardholderAddress", "PendingTransactionSourceCheckDepositInstruction", "PendingTransactionSourceCheckTransferInstruction", "PendingTransactionSourceInboundFundsHold", @@ -114,44 +118,6 @@ class DeclinedTransactionSourceACHDecline(BaseModel): """ -class DeclinedTransactionSourceCardDeclineCardholderAddress(BaseModel): - actual_line1: Optional[str] - """Line 1 of the address on file for the cardholder.""" - - actual_postal_code: Optional[str] - """The postal code of the address on file for the cardholder.""" - - provided_line1: Optional[str] - """ - The cardholder address line 1 provided for verification in the authorization - request. - """ - - provided_postal_code: Optional[str] - """The postal code provided for verification in the authorization request.""" - - verification_result: Literal[ - "not_checked", - "postal_code_match_address_not_checked", - "postal_code_match_address_no_match", - "postal_code_no_match_address_match", - "match", - "no_match", - ] - """The address verification result returned to the card network. - - - `not_checked` - No adress was provided in the authorization request. - - `postal_code_match_address_not_checked` - Postal code matches, but the street - address was not verified - - `postal_code_match_address_no_match` - Postal code matches, but the street - address does not match - - `postal_code_no_match_address_match` - Postal code does not match, but the - street address matches - - `match` - Postal code and street address match - - `no_match` - Postal code and street address do not match - """ - - class DeclinedTransactionSourceCardDeclineNetworkDetailsVisa(BaseModel): electronic_commerce_indicator: Optional[ Literal[ @@ -246,6 +212,69 @@ class DeclinedTransactionSourceCardDeclineNetworkDetails(BaseModel): """Fields specific to the `visa` network.""" +class DeclinedTransactionSourceCardDeclineVerificationCardVerificationCode(BaseModel): + 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 DeclinedTransactionSourceCardDeclineVerificationCardholderAddress(BaseModel): + actual_line1: Optional[str] + """Line 1 of the address on file for the cardholder.""" + + actual_postal_code: Optional[str] + """The postal code of the address on file for the cardholder.""" + + provided_line1: Optional[str] + """ + The cardholder address line 1 provided for verification in the authorization + request. + """ + + provided_postal_code: Optional[str] + """The postal code provided for verification in the authorization request.""" + + result: Literal[ + "not_checked", + "postal_code_match_address_not_checked", + "postal_code_match_address_no_match", + "postal_code_no_match_address_match", + "match", + "no_match", + ] + """The address verification result returned to the card network. + + - `not_checked` - No adress was provided in the authorization request. + - `postal_code_match_address_not_checked` - Postal code matches, but the street + address was not verified. + - `postal_code_match_address_no_match` - Postal code matches, but the street + address does not match. + - `postal_code_no_match_address_match` - Postal code does not match, but the + street address matches. + - `match` - Postal code and street address match. + - `no_match` - Postal code and street address do not match. + """ + + +class DeclinedTransactionSourceCardDeclineVerification(BaseModel): + card_verification_code: DeclinedTransactionSourceCardDeclineVerificationCardVerificationCode + """ + Fields related to verification of the Card Verification Code, a 3-digit code on + the back of the card. + """ + + cardholder_address: DeclinedTransactionSourceCardDeclineVerificationCardholderAddress + """ + Cardholder address provided in the authorization request and the address on file + we verified it against. + """ + + class DeclinedTransactionSourceCardDecline(BaseModel): id: str """The Card Decline identifier.""" @@ -259,12 +288,6 @@ class DeclinedTransactionSourceCardDecline(BaseModel): card_payment_id: Optional[str] """The ID of the Card Payment this transaction belongs to.""" - cardholder_address: DeclinedTransactionSourceCardDeclineCardholderAddress - """ - Cardholder address provided in the authorization request and the address on file - we verified it against. - """ - currency: Literal["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] """ The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination @@ -363,6 +386,9 @@ class DeclinedTransactionSourceCardDecline(BaseModel): reach out to support@increase.com for more information. """ + verification: DeclinedTransactionSourceCardDeclineVerification + """Fields related to verification of cardholder-provided values.""" + class DeclinedTransactionSourceCheckDecline(BaseModel): amount: int @@ -972,44 +998,6 @@ class PendingTransactionSourceACHTransferInstruction(BaseModel): """The identifier of the ACH Transfer that led to this Pending Transaction.""" -class PendingTransactionSourceCardAuthorizationCardholderAddress(BaseModel): - actual_line1: Optional[str] - """Line 1 of the address on file for the cardholder.""" - - actual_postal_code: Optional[str] - """The postal code of the address on file for the cardholder.""" - - provided_line1: Optional[str] - """ - The cardholder address line 1 provided for verification in the authorization - request. - """ - - provided_postal_code: Optional[str] - """The postal code provided for verification in the authorization request.""" - - verification_result: Literal[ - "not_checked", - "postal_code_match_address_not_checked", - "postal_code_match_address_no_match", - "postal_code_no_match_address_match", - "match", - "no_match", - ] - """The address verification result returned to the card network. - - - `not_checked` - No adress was provided in the authorization request. - - `postal_code_match_address_not_checked` - Postal code matches, but the street - address was not verified - - `postal_code_match_address_no_match` - Postal code matches, but the street - address does not match - - `postal_code_no_match_address_match` - Postal code does not match, but the - street address matches - - `match` - Postal code and street address match - - `no_match` - Postal code and street address do not match - """ - - class PendingTransactionSourceCardAuthorizationNetworkDetailsVisa(BaseModel): electronic_commerce_indicator: Optional[ Literal[ @@ -1104,6 +1092,69 @@ class PendingTransactionSourceCardAuthorizationNetworkDetails(BaseModel): """Fields specific to the `visa` network.""" +class PendingTransactionSourceCardAuthorizationVerificationCardVerificationCode(BaseModel): + 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 PendingTransactionSourceCardAuthorizationVerificationCardholderAddress(BaseModel): + actual_line1: Optional[str] + """Line 1 of the address on file for the cardholder.""" + + actual_postal_code: Optional[str] + """The postal code of the address on file for the cardholder.""" + + provided_line1: Optional[str] + """ + The cardholder address line 1 provided for verification in the authorization + request. + """ + + provided_postal_code: Optional[str] + """The postal code provided for verification in the authorization request.""" + + result: Literal[ + "not_checked", + "postal_code_match_address_not_checked", + "postal_code_match_address_no_match", + "postal_code_no_match_address_match", + "match", + "no_match", + ] + """The address verification result returned to the card network. + + - `not_checked` - No adress was provided in the authorization request. + - `postal_code_match_address_not_checked` - Postal code matches, but the street + address was not verified. + - `postal_code_match_address_no_match` - Postal code matches, but the street + address does not match. + - `postal_code_no_match_address_match` - Postal code does not match, but the + street address matches. + - `match` - Postal code and street address match. + - `no_match` - Postal code and street address do not match. + """ + + +class PendingTransactionSourceCardAuthorizationVerification(BaseModel): + card_verification_code: PendingTransactionSourceCardAuthorizationVerificationCardVerificationCode + """ + Fields related to verification of the Card Verification Code, a 3-digit code on + the back of the card. + """ + + cardholder_address: PendingTransactionSourceCardAuthorizationVerificationCardholderAddress + """ + Cardholder address provided in the authorization request and the address on file + we verified it against. + """ + + class PendingTransactionSourceCardAuthorization(BaseModel): id: str """The Card Authorization identifier.""" @@ -1117,12 +1168,6 @@ class PendingTransactionSourceCardAuthorization(BaseModel): card_payment_id: Optional[str] """The ID of the Card Payment this transaction belongs to.""" - cardholder_address: PendingTransactionSourceCardAuthorizationCardholderAddress - """ - Cardholder address provided in the authorization request and the address on file - we verified it against. - """ - currency: Literal["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] """ The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the @@ -1204,6 +1249,9 @@ class PendingTransactionSourceCardAuthorization(BaseModel): For this resource it will always be `card_authorization`. """ + verification: PendingTransactionSourceCardAuthorizationVerification + """Fields related to verification of cardholder-provided values.""" + class PendingTransactionSourceCheckDepositInstruction(BaseModel): amount: int diff --git a/src/increase/types/simulations/inbound_real_time_payments_transfer_simulation_result.py b/src/increase/types/simulations/inbound_real_time_payments_transfer_simulation_result.py index 7fb2b9b74..de4d834ac 100644 --- a/src/increase/types/simulations/inbound_real_time_payments_transfer_simulation_result.py +++ b/src/increase/types/simulations/inbound_real_time_payments_transfer_simulation_result.py @@ -12,9 +12,11 @@ "DeclinedTransactionSource", "DeclinedTransactionSourceACHDecline", "DeclinedTransactionSourceCardDecline", - "DeclinedTransactionSourceCardDeclineCardholderAddress", "DeclinedTransactionSourceCardDeclineNetworkDetails", "DeclinedTransactionSourceCardDeclineNetworkDetailsVisa", + "DeclinedTransactionSourceCardDeclineVerification", + "DeclinedTransactionSourceCardDeclineVerificationCardVerificationCode", + "DeclinedTransactionSourceCardDeclineVerificationCardholderAddress", "DeclinedTransactionSourceCheckDecline", "DeclinedTransactionSourceInboundRealTimePaymentsTransferDecline", "DeclinedTransactionSourceInternationalACHDecline", @@ -145,44 +147,6 @@ class DeclinedTransactionSourceACHDecline(BaseModel): """ -class DeclinedTransactionSourceCardDeclineCardholderAddress(BaseModel): - actual_line1: Optional[str] - """Line 1 of the address on file for the cardholder.""" - - actual_postal_code: Optional[str] - """The postal code of the address on file for the cardholder.""" - - provided_line1: Optional[str] - """ - The cardholder address line 1 provided for verification in the authorization - request. - """ - - provided_postal_code: Optional[str] - """The postal code provided for verification in the authorization request.""" - - verification_result: Literal[ - "not_checked", - "postal_code_match_address_not_checked", - "postal_code_match_address_no_match", - "postal_code_no_match_address_match", - "match", - "no_match", - ] - """The address verification result returned to the card network. - - - `not_checked` - No adress was provided in the authorization request. - - `postal_code_match_address_not_checked` - Postal code matches, but the street - address was not verified - - `postal_code_match_address_no_match` - Postal code matches, but the street - address does not match - - `postal_code_no_match_address_match` - Postal code does not match, but the - street address matches - - `match` - Postal code and street address match - - `no_match` - Postal code and street address do not match - """ - - class DeclinedTransactionSourceCardDeclineNetworkDetailsVisa(BaseModel): electronic_commerce_indicator: Optional[ Literal[ @@ -277,6 +241,69 @@ class DeclinedTransactionSourceCardDeclineNetworkDetails(BaseModel): """Fields specific to the `visa` network.""" +class DeclinedTransactionSourceCardDeclineVerificationCardVerificationCode(BaseModel): + 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 DeclinedTransactionSourceCardDeclineVerificationCardholderAddress(BaseModel): + actual_line1: Optional[str] + """Line 1 of the address on file for the cardholder.""" + + actual_postal_code: Optional[str] + """The postal code of the address on file for the cardholder.""" + + provided_line1: Optional[str] + """ + The cardholder address line 1 provided for verification in the authorization + request. + """ + + provided_postal_code: Optional[str] + """The postal code provided for verification in the authorization request.""" + + result: Literal[ + "not_checked", + "postal_code_match_address_not_checked", + "postal_code_match_address_no_match", + "postal_code_no_match_address_match", + "match", + "no_match", + ] + """The address verification result returned to the card network. + + - `not_checked` - No adress was provided in the authorization request. + - `postal_code_match_address_not_checked` - Postal code matches, but the street + address was not verified. + - `postal_code_match_address_no_match` - Postal code matches, but the street + address does not match. + - `postal_code_no_match_address_match` - Postal code does not match, but the + street address matches. + - `match` - Postal code and street address match. + - `no_match` - Postal code and street address do not match. + """ + + +class DeclinedTransactionSourceCardDeclineVerification(BaseModel): + card_verification_code: DeclinedTransactionSourceCardDeclineVerificationCardVerificationCode + """ + Fields related to verification of the Card Verification Code, a 3-digit code on + the back of the card. + """ + + cardholder_address: DeclinedTransactionSourceCardDeclineVerificationCardholderAddress + """ + Cardholder address provided in the authorization request and the address on file + we verified it against. + """ + + class DeclinedTransactionSourceCardDecline(BaseModel): id: str """The Card Decline identifier.""" @@ -290,12 +317,6 @@ class DeclinedTransactionSourceCardDecline(BaseModel): card_payment_id: Optional[str] """The ID of the Card Payment this transaction belongs to.""" - cardholder_address: DeclinedTransactionSourceCardDeclineCardholderAddress - """ - Cardholder address provided in the authorization request and the address on file - we verified it against. - """ - currency: Literal["CAD", "CHF", "EUR", "GBP", "JPY", "USD"] """ The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination @@ -394,6 +415,9 @@ class DeclinedTransactionSourceCardDecline(BaseModel): reach out to support@increase.com for more information. """ + verification: DeclinedTransactionSourceCardDeclineVerification + """Fields related to verification of cardholder-provided values.""" + class DeclinedTransactionSourceCheckDecline(BaseModel): amount: int