Skip to content

VirtualCard

Dataclass representing a virtual card returned by card gateways.

paygraph.gateways.base.VirtualCard dataclass

A virtual card returned by a card gateway.

Attributes:

Name Type Description
pan str

Primary Account Number (full card number). Treat as sensitive.
cvv str

Card Verification Value.
expiry str

Expiration date in MM/YY format.
spend_limit_cents int

Maximum spend limit in cents.
gateway_ref str

Unique reference ID from the gateway.
gateway_type str

Gateway identifier (e.g. "mock", "stripe_test").
Source code in src/paygraph/gateways/base.py 
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
@dataclass
class VirtualCard:
    """A virtual card returned by a card gateway.

    Attributes:
        pan: Primary Account Number (full card number). **Treat as sensitive.**
        cvv: Card Verification Value.
        expiry: Expiration date in ``MM/YY`` format.
        spend_limit_cents: Maximum spend limit in cents.
        gateway_ref: Unique reference ID from the gateway.
        gateway_type: Gateway identifier (e.g. ``"mock"``, ``"stripe_test"``).
    """

    pan: str
    cvv: str
    expiry: str
    spend_limit_cents: int
    gateway_ref: str
    gateway_type: str

    def redacted(self) -> "VirtualCard":
        """Return a copy with the PAN masked, showing only the last 4 digits.

        Returns:
            A new ``VirtualCard`` with ``pan`` set to ``****XXXX``.
        """
        return VirtualCard(
            pan=f"****{self.pan[-4:]}",
            cvv=self.cvv,
            expiry=self.expiry,
            spend_limit_cents=self.spend_limit_cents,
            gateway_ref=self.gateway_ref,
            gateway_type=self.gateway_type,
        )

redacted()

Return a copy with the PAN masked, showing only the last 4 digits.

Returns:

Type Description
VirtualCard

A new VirtualCard with pan set to ****XXXX.
Source code in src/paygraph/gateways/base.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
def redacted(self) -> "VirtualCard":
    """Return a copy with the PAN masked, showing only the last 4 digits.

    Returns:
        A new ``VirtualCard`` with ``pan`` set to ``****XXXX``.
    """
    return VirtualCard(
        pan=f"****{self.pan[-4:]}",
        cvv=self.cvv,
        expiry=self.expiry,
        spend_limit_cents=self.spend_limit_cents,
        gateway_ref=self.gateway_ref,
        gateway_type=self.gateway_type,
    )