pinelabs-python 0.1.0__py3-none-any.whl

pinelabs/card_payments/client.py

@@ -0,0 +1,547 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.bnpl_resend_otp_response import BnplResendOtpResponse
+from ..types.bnpl_submit_otp_response import BnplSubmitOtpResponse
+from ..types.card_detail_lookup_item import CardDetailLookupItem
+from ..types.get_card_details_response import GetCardDetailsResponse
+from ..types.order_response import OrderResponse
+from ..types.otp_generate_response import OtpGenerateResponse
+from ..types.payment_request_item import PaymentRequestItem
+from .raw_client import AsyncRawCardPaymentsClient, RawCardPaymentsClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class CardPaymentsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawCardPaymentsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawCardPaymentsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawCardPaymentsClient
+        """
+        return self._raw_client
+
+    def create_payment(
+        self,
+        order_id: str,
+        *,
+        payments: typing.Sequence[PaymentRequestItem],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> OrderResponse:
+        """
+        Create a payment against an existing order. This unified endpoint supports
+        multiple payment methods differentiated by the `payment_method` field:
+
+        - **CARD** — Pay with card number or card token (see Card Payments documentation)
+        - **UPI** — Pay via UPI Collect or UPI Intent/QR (see UPI Payments documentation)
+        - **NETBANKING** — Pay via net banking redirect (see Net Banking documentation)
+        - **WALLET** — Pay via digital wallet (see Wallet documentation)
+        - **EMI** — Pay via Credit/Debit EMI or Cardless EMI (see Affordability Suite documentation)
+        - **BNPL** — Pay via Buy Now Pay Later (see BNPL documentation)
+
+        The response returns the full order object with the payment linked.
+        For redirect-based flows (NetBanking, Wallet, UPI Intent), use the
+        `challenge_url` in the response to redirect the customer.
+
+        Parameters
+        ----------
+        order_id : str
+            Unique identifier of the order in the Pine Labs Online database.
+
+        payments : typing.Sequence[PaymentRequestItem]
+            Array of payment items. Typically contains a single item.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrderResponse
+            Payment created successfully. Returns the full order with payment details.
+
+        Examples
+        --------
+        from pinelabs import Amount, PaymentRequestItem, PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.card_payments.create_payment(
+            order_id="v1-4405071524-aa-qlAtAf",
+            payments=[
+                PaymentRequestItem(
+                    merchant_payment_reference="pay-ref-001",
+                    payment_amount=Amount(
+                        value=1000,
+                        currency="INR",
+                    ),
+                    payment_method="CARD",
+                )
+            ],
+        )
+        """
+        _response = self._raw_client.create_payment(order_id, payments=payments, request_options=request_options)
+        return _response.data
+
+    def generate_otp(
+        self, *, payment_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> OtpGenerateResponse:
+        """
+        Generate a One-Time Password (OTP) for card payment authentication.
+        This API is called after a card payment is created and the card requires
+        OTP-based verification (native OTP flow).
+
+        Parameters
+        ----------
+        payment_id : str
+            Unique identifier of the payment requiring OTP verification.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OtpGenerateResponse
+            OTP generated successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.card_payments.generate_otp(
+            payment_id="v1-5757575757-aa-hU1rUd-cc-l",
+        )
+        """
+        _response = self._raw_client.generate_otp(payment_id=payment_id, request_options=request_options)
+        return _response.data
+
+    def get_card_details(
+        self,
+        *,
+        card_details: typing.Sequence[CardDetailLookupItem],
+        amount: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetCardDetailsResponse:
+        """
+        Use this API to get the card details.
+
+        Parameters
+        ----------
+        card_details : typing.Sequence[CardDetailLookupItem]
+            An array that contains the card details.
+
+        amount : typing.Optional[str]
+            Transaction amount in smallest currency unit.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetCardDetailsResponse
+            Card details retrieved successfully.
+
+        Examples
+        --------
+        from pinelabs import CardDetailLookupItem, PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.card_payments.get_card_details(
+            amount="100",
+            card_details=[
+                CardDetailLookupItem(
+                    payment_identifier="4012001037141112",
+                    payment_reference_type="CARD",
+                )
+            ],
+        )
+        """
+        _response = self._raw_client.get_card_details(
+            card_details=card_details, amount=amount, request_options=request_options
+        )
+        return _response.data
+
+    def submit_otp(
+        self, *, payment_id: str, otp: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> BnplSubmitOtpResponse:
+        """
+        Submit the OTP received on the customer's registered mobile number
+        to validate and process the payment. This endpoint is shared between
+        Card Payments (native OTP flow) and BNPL payment verification.
+
+        Parameters
+        ----------
+        payment_id : str
+            Unique payment identifier from create payment response.
+
+        otp : str
+            OTP received by the customer.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        BnplSubmitOtpResponse
+            OTP verified and payment processed successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.card_payments.submit_otp(
+            payment_id="v1-250708064524-aa-Zd1J9Y-bn-a",
+            otp="123456",
+        )
+        """
+        _response = self._raw_client.submit_otp(payment_id=payment_id, otp=otp, request_options=request_options)
+        return _response.data
+
+    def resend_otp(
+        self, *, payment_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> BnplResendOtpResponse:
+        """
+        Resend the OTP to the customer's registered mobile number
+        for payment verification. This endpoint is shared between
+        Card Payments (native OTP flow) and BNPL payment verification.
+
+        Parameters
+        ----------
+        payment_id : str
+            Unique payment identifier from create payment response.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        BnplResendOtpResponse
+            OTP resent successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.card_payments.resend_otp(
+            payment_id="v1-250708064524-aa-Zd1J9Y-bn-a",
+        )
+        """
+        _response = self._raw_client.resend_otp(payment_id=payment_id, request_options=request_options)
+        return _response.data
+
+
+class AsyncCardPaymentsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawCardPaymentsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawCardPaymentsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawCardPaymentsClient
+        """
+        return self._raw_client
+
+    async def create_payment(
+        self,
+        order_id: str,
+        *,
+        payments: typing.Sequence[PaymentRequestItem],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> OrderResponse:
+        """
+        Create a payment against an existing order. This unified endpoint supports
+        multiple payment methods differentiated by the `payment_method` field:
+
+        - **CARD** — Pay with card number or card token (see Card Payments documentation)
+        - **UPI** — Pay via UPI Collect or UPI Intent/QR (see UPI Payments documentation)
+        - **NETBANKING** — Pay via net banking redirect (see Net Banking documentation)
+        - **WALLET** — Pay via digital wallet (see Wallet documentation)
+        - **EMI** — Pay via Credit/Debit EMI or Cardless EMI (see Affordability Suite documentation)
+        - **BNPL** — Pay via Buy Now Pay Later (see BNPL documentation)
+
+        The response returns the full order object with the payment linked.
+        For redirect-based flows (NetBanking, Wallet, UPI Intent), use the
+        `challenge_url` in the response to redirect the customer.
+
+        Parameters
+        ----------
+        order_id : str
+            Unique identifier of the order in the Pine Labs Online database.
+
+        payments : typing.Sequence[PaymentRequestItem]
+            Array of payment items. Typically contains a single item.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrderResponse
+            Payment created successfully. Returns the full order with payment details.
+
+        Examples
+        --------
+        import asyncio
+
+        from pinelabs import Amount, AsyncPinelabsApi, PaymentRequestItem
+
+        client = AsyncPinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.card_payments.create_payment(
+                order_id="v1-4405071524-aa-qlAtAf",
+                payments=[
+                    PaymentRequestItem(
+                        merchant_payment_reference="pay-ref-001",
+                        payment_amount=Amount(
+                            value=1000,
+                            currency="INR",
+                        ),
+                        payment_method="CARD",
+                    )
+                ],
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_payment(order_id, payments=payments, request_options=request_options)
+        return _response.data
+
+    async def generate_otp(
+        self, *, payment_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> OtpGenerateResponse:
+        """
+        Generate a One-Time Password (OTP) for card payment authentication.
+        This API is called after a card payment is created and the card requires
+        OTP-based verification (native OTP flow).
+
+        Parameters
+        ----------
+        payment_id : str
+            Unique identifier of the payment requiring OTP verification.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OtpGenerateResponse
+            OTP generated successfully.
+
+        Examples
+        --------
+        import asyncio
+
+        from pinelabs import AsyncPinelabsApi
+
+        client = AsyncPinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.card_payments.generate_otp(
+                payment_id="v1-5757575757-aa-hU1rUd-cc-l",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.generate_otp(payment_id=payment_id, request_options=request_options)
+        return _response.data
+
+    async def get_card_details(
+        self,
+        *,
+        card_details: typing.Sequence[CardDetailLookupItem],
+        amount: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetCardDetailsResponse:
+        """
+        Use this API to get the card details.
+
+        Parameters
+        ----------
+        card_details : typing.Sequence[CardDetailLookupItem]
+            An array that contains the card details.
+
+        amount : typing.Optional[str]
+            Transaction amount in smallest currency unit.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetCardDetailsResponse
+            Card details retrieved successfully.
+
+        Examples
+        --------
+        import asyncio
+
+        from pinelabs import AsyncPinelabsApi, CardDetailLookupItem
+
+        client = AsyncPinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.card_payments.get_card_details(
+                amount="100",
+                card_details=[
+                    CardDetailLookupItem(
+                        payment_identifier="4012001037141112",
+                        payment_reference_type="CARD",
+                    )
+                ],
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_card_details(
+            card_details=card_details, amount=amount, request_options=request_options
+        )
+        return _response.data
+
+    async def submit_otp(
+        self, *, payment_id: str, otp: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> BnplSubmitOtpResponse:
+        """
+        Submit the OTP received on the customer's registered mobile number
+        to validate and process the payment. This endpoint is shared between
+        Card Payments (native OTP flow) and BNPL payment verification.
+
+        Parameters
+        ----------
+        payment_id : str
+            Unique payment identifier from create payment response.
+
+        otp : str
+            OTP received by the customer.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        BnplSubmitOtpResponse
+            OTP verified and payment processed successfully.
+
+        Examples
+        --------
+        import asyncio
+
+        from pinelabs import AsyncPinelabsApi
+
+        client = AsyncPinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.card_payments.submit_otp(
+                payment_id="v1-250708064524-aa-Zd1J9Y-bn-a",
+                otp="123456",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.submit_otp(payment_id=payment_id, otp=otp, request_options=request_options)
+        return _response.data
+
+    async def resend_otp(
+        self, *, payment_id: str, request_options: typing.Optional[RequestOptions] = None
+    ) -> BnplResendOtpResponse:
+        """
+        Resend the OTP to the customer's registered mobile number
+        for payment verification. This endpoint is shared between
+        Card Payments (native OTP flow) and BNPL payment verification.
+
+        Parameters
+        ----------
+        payment_id : str
+            Unique payment identifier from create payment response.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        BnplResendOtpResponse
+            OTP resent successfully.
+
+        Examples
+        --------
+        import asyncio
+
+        from pinelabs import AsyncPinelabsApi
+
+        client = AsyncPinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.card_payments.resend_otp(
+                payment_id="v1-250708064524-aa-Zd1J9Y-bn-a",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.resend_otp(payment_id=payment_id, request_options=request_options)
+        return _response.data