diff --git a/src/increase/types/card_payment.py b/src/increase/types/card_payment.py index e92430aac..7a7f0e5f6 100644 --- a/src/increase/types/card_payment.py +++ b/src/increase/types/card_payment.py @@ -10,10 +10,12 @@ "CardPayment", "Element", "ElementCardAuthorization", + "ElementCardAuthorizationCardholderAddress", "ElementCardAuthorizationNetworkDetails", "ElementCardAuthorizationNetworkDetailsVisa", "ElementCardAuthorizationExpiration", "ElementCardDecline", + "ElementCardDeclineCardholderAddress", "ElementCardDeclineNetworkDetails", "ElementCardDeclineNetworkDetailsVisa", "ElementCardIncrement", @@ -35,12 +37,51 @@ "ElementCardSettlementPurchaseDetailsTravelAncillaryService", "ElementCardSettlementPurchaseDetailsTravelTripLeg", "ElementCardValidation", + "ElementCardValidationCardholderAddress", "ElementCardValidationNetworkDetails", "ElementCardValidationNetworkDetailsVisa", "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[ @@ -148,6 +189,12 @@ 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 @@ -269,6 +316,44 @@ 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[ @@ -376,6 +461,12 @@ 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 @@ -1529,6 +1620,44 @@ 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[ @@ -1630,6 +1759,12 @@ class ElementCardValidation(BaseModel): card_payment_id: Optional[str] """The ID of the Card Payment this transaction belongs to.""" + cardholder_address: ElementCardValidationCardholderAddress + """ + 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 diff --git a/src/increase/types/declined_transaction.py b/src/increase/types/declined_transaction.py index 28f84f017..e8f01671c 100644 --- a/src/increase/types/declined_transaction.py +++ b/src/increase/types/declined_transaction.py @@ -11,6 +11,7 @@ "Source", "SourceACHDecline", "SourceCardDecline", + "SourceCardDeclineCardholderAddress", "SourceCardDeclineNetworkDetails", "SourceCardDeclineNetworkDetailsVisa", "SourceCheckDecline", @@ -99,6 +100,44 @@ 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[ @@ -206,6 +245,12 @@ 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 diff --git a/src/increase/types/pending_transaction.py b/src/increase/types/pending_transaction.py index 056f0a844..555a35d2f 100644 --- a/src/increase/types/pending_transaction.py +++ b/src/increase/types/pending_transaction.py @@ -12,6 +12,7 @@ "SourceAccountTransferInstruction", "SourceACHTransferInstruction", "SourceCardAuthorization", + "SourceCardAuthorizationCardholderAddress", "SourceCardAuthorizationNetworkDetails", "SourceCardAuthorizationNetworkDetailsVisa", "SourceCheckDepositInstruction", @@ -57,6 +58,44 @@ 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[ @@ -164,6 +203,12 @@ 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 diff --git a/src/increase/types/real_time_decision.py b/src/increase/types/real_time_decision.py index 23a52e117..8f24a6347 100644 --- a/src/increase/types/real_time_decision.py +++ b/src/increase/types/real_time_decision.py @@ -9,6 +9,7 @@ __all__ = [ "RealTimeDecision", "CardAuthorization", + "CardAuthorizationCardholderAddress", "CardAuthorizationNetworkDetails", "CardAuthorizationNetworkDetailsVisa", "CardAuthorizationRequestDetails", @@ -18,6 +19,44 @@ ] +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[ @@ -148,6 +187,12 @@ class CardAuthorization(BaseModel): card_id: str """The identifier of the Card that is being authorized.""" + cardholder_address: CardAuthorizationCardholderAddress + """ + Cardholder address provided in the authorization request and the address on file + we verified it against. + """ + decision: Optional[Literal["approve", "decline"]] """Whether or not the authorization was approved. diff --git a/src/increase/types/simulations/ach_transfer_simulation.py b/src/increase/types/simulations/ach_transfer_simulation.py index a2e72ba1b..67ad460cf 100644 --- a/src/increase/types/simulations/ach_transfer_simulation.py +++ b/src/increase/types/simulations/ach_transfer_simulation.py @@ -12,6 +12,7 @@ "DeclinedTransactionSource", "DeclinedTransactionSourceACHDecline", "DeclinedTransactionSourceCardDecline", + "DeclinedTransactionSourceCardDeclineCardholderAddress", "DeclinedTransactionSourceCardDeclineNetworkDetails", "DeclinedTransactionSourceCardDeclineNetworkDetailsVisa", "DeclinedTransactionSourceCheckDecline", @@ -152,6 +153,44 @@ 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[ @@ -259,6 +298,12 @@ 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 diff --git a/src/increase/types/simulations/card_authorization_simulation.py b/src/increase/types/simulations/card_authorization_simulation.py index 96a249e11..1e443257a 100644 --- a/src/increase/types/simulations/card_authorization_simulation.py +++ b/src/increase/types/simulations/card_authorization_simulation.py @@ -12,6 +12,7 @@ "DeclinedTransactionSource", "DeclinedTransactionSourceACHDecline", "DeclinedTransactionSourceCardDecline", + "DeclinedTransactionSourceCardDeclineCardholderAddress", "DeclinedTransactionSourceCardDeclineNetworkDetails", "DeclinedTransactionSourceCardDeclineNetworkDetailsVisa", "DeclinedTransactionSourceCheckDecline", @@ -23,6 +24,7 @@ "PendingTransactionSourceAccountTransferInstruction", "PendingTransactionSourceACHTransferInstruction", "PendingTransactionSourceCardAuthorization", + "PendingTransactionSourceCardAuthorizationCardholderAddress", "PendingTransactionSourceCardAuthorizationNetworkDetails", "PendingTransactionSourceCardAuthorizationNetworkDetailsVisa", "PendingTransactionSourceCheckDepositInstruction", @@ -112,6 +114,44 @@ 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[ @@ -219,6 +259,12 @@ 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 @@ -926,6 +972,44 @@ 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[ @@ -1033,6 +1117,12 @@ 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 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 89715de8c..7fb2b9b74 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,6 +12,7 @@ "DeclinedTransactionSource", "DeclinedTransactionSourceACHDecline", "DeclinedTransactionSourceCardDecline", + "DeclinedTransactionSourceCardDeclineCardholderAddress", "DeclinedTransactionSourceCardDeclineNetworkDetails", "DeclinedTransactionSourceCardDeclineNetworkDetailsVisa", "DeclinedTransactionSourceCheckDecline", @@ -144,6 +145,44 @@ 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[ @@ -251,6 +290,12 @@ 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