pydantic_extra_types.payment
Represents and validates payment cards (such as a debit or credit card), including validation for payment card number and issuer.
PaymentCardBrand ¶
Bases: str
, Enum
Enumeration of payment card brands.
PaymentCardBrand
can be one of the following based on the BIN:
- PaymentCardBrand.amex
- PaymentCardBrand.mastercard
- PaymentCardBrand.visa
- PaymentCardBrand.other
PaymentCardNumber ¶
PaymentCardNumber(card_number)
Bases: str
Attributes:
Name | Type | Description |
---|---|---|
strip_whitespace |
bool
|
Whether to strip whitespace from the input value. |
min_length |
int
|
The minimum length of the card number. |
max_length |
int
|
The maximum length of the card number. |
bin |
str
|
The first 6 digits of the card number. |
last4 |
str
|
The last 4 digits of the card number. |
brand |
PaymentCardBrand
|
The brand of the card. |
Source code in pydantic_extra_types/payment.py
55 56 57 58 59 60 61 62 |
|
validate
classmethod
¶
validate(__input_value, _)
Validate the PaymentCardNumber
instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
__input_value |
str
|
The input value to validate. |
required |
_ |
core_schema.ValidationInfo
|
The validation info. |
required |
Returns:
Type | Description |
---|---|
PaymentCardNumber
|
The validated |
Source code in pydantic_extra_types/payment.py
73 74 75 76 77 78 79 80 81 82 83 84 |
|
validate_digits
classmethod
¶
validate_digits(card_number)
Validate that the card number is all digits.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
card_number |
str
|
The card number to validate. |
required |
Raises:
Type | Description |
---|---|
PydanticCustomError
|
If the card number is not all digits. |
Source code in pydantic_extra_types/payment.py
92 93 94 95 96 97 98 99 100 101 102 103 |
|
validate_luhn_check_digit
classmethod
¶
validate_luhn_check_digit(card_number)
Validate the payment card number. Based on the Luhn algorithm.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
card_number |
str
|
The card number to validate. |
required |
Returns:
Type | Description |
---|---|
str
|
The validated card number. |
Raises:
Type | Description |
---|---|
PydanticCustomError
|
If the card number is not valid. |
Source code in pydantic_extra_types/payment.py
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
|
validate_brand
staticmethod
¶
validate_brand(card_number)
Validate length based on BIN for major brands.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
card_number |
str
|
The card number to validate. |
required |
Returns:
Type | Description |
---|---|
PaymentCardBrand
|
The validated card brand. |
Raises:
Type | Description |
---|---|
PydanticCustomError
|
If the card number is not valid. |
Source code in pydantic_extra_types/payment.py
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
|