pinelabs-python 0.1.0__py3-none-any.whl

pinelabs/payouts/client.py

@@ -0,0 +1,810 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.create_bulk_payout_response import CreateBulkPayoutResponse
+from ..types.create_payout_response import CreatePayoutResponse
+from ..types.get_account_balance_response import GetAccountBalanceResponse
+from ..types.get_payouts_response import GetPayoutsResponse
+from ..types.payout_amount import PayoutAmount
+from ..types.payout_detail import PayoutDetail
+from .raw_client import AsyncRawPayoutsClient, RawPayoutsClient
+from .types.create_payout_request_mode import CreatePayoutRequestMode
+from .types.list_payouts_request_mode import ListPayoutsRequestMode
+from .types.list_payouts_request_status import ListPayoutsRequestStatus
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class PayoutsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawPayoutsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawPayoutsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawPayoutsClient
+        """
+        return self._raw_client
+
+    def create_payout(
+        self,
+        *,
+        client_reference_id: str,
+        payee_name: str,
+        amount: PayoutAmount,
+        mode: CreatePayoutRequestMode,
+        remarks: str,
+        email: typing.Optional[str] = OMIT,
+        phone: typing.Optional[str] = OMIT,
+        account_number: typing.Optional[str] = OMIT,
+        branch_code: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreatePayoutResponse:
+        """
+        Creates a single payout to a beneficiary's bank account or UPI VPA.
+        Supports IMPS, NEFT, RTGS, and UPI payment modes.
+
+        For IMPS/NEFT/RTGS, provide accountNumber and branchCode.
+        For UPI, provide vpa instead.
+
+        Parameters
+        ----------
+        client_reference_id : str
+            Unique identifier to track the payout. Must not contain spaces. **Acts as the idempotency key** — duplicate requests with the same `clientReferenceId` will not create a new payout.
+
+        payee_name : str
+            Name of the beneficiary's bank account holder. Alphabets and spaces only.
+
+        amount : PayoutAmount
+
+        mode : CreatePayoutRequestMode
+            Mode of payment for the payout.
+
+        remarks : str
+            Description or reference text for the transaction. Supported characters A-Z, a-z, 0-9, hyphen, space.
+
+        email : typing.Optional[str]
+            Email address of the beneficiary.
+
+        phone : typing.Optional[str]
+            Mobile number of the beneficiary (10 numeric digits).
+
+        account_number : typing.Optional[str]
+            Beneficiary's bank account number. Mandatory for IMPS, NEFT, and RTGS.
+
+        branch_code : typing.Optional[str]
+            Beneficiary's bank IFSC code. Mandatory for IMPS, NEFT, and RTGS.
+            First 4 characters alphabets, 5th character must be 0, remaining alphanumeric.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreatePayoutResponse
+            Payout created and scheduled successfully.
+
+        Examples
+        --------
+        from pinelabs import PayoutAmount, PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.payouts.create_payout(
+            client_reference_id="430582f3-6e83-4cec-a3ab-72847fb9680f",
+            payee_name="Kevin Bob",
+            email="kevin.bob@example.com",
+            phone="9876543210",
+            account_number="500012121313141415",
+            branch_code="SBIN0011123",
+            amount=PayoutAmount(
+                value=4900,
+                currency="INR",
+            ),
+            mode="IMPS",
+            remarks="Refund payment",
+        )
+        """
+        _response = self._raw_client.create_payout(
+            client_reference_id=client_reference_id,
+            payee_name=payee_name,
+            amount=amount,
+            mode=mode,
+            remarks=remarks,
+            email=email,
+            phone=phone,
+            account_number=account_number,
+            branch_code=branch_code,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def list_payouts(
+        self,
+        *,
+        payment_reference_id: typing.Optional[str] = None,
+        client_reference_id: typing.Optional[str] = None,
+        request_reference_id: typing.Optional[str] = None,
+        bank_transaction_reference_id: typing.Optional[str] = None,
+        mode: typing.Optional[ListPayoutsRequestMode] = None,
+        date_from: typing.Optional[dt.datetime] = None,
+        date_to: typing.Optional[dt.datetime] = None,
+        status: typing.Optional[ListPayoutsRequestStatus] = None,
+        page: typing.Optional[str] = None,
+        count: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetPayoutsResponse:
+        """
+        Retrieves payout details. Use paymentReferenceId or clientReferenceId
+        to fetch a specific payout, or requestReferenceId to fetch all payouts
+        associated with a single request. Supports filtering by mode, status,
+        and date range.
+
+        Parameters
+        ----------
+        payment_reference_id : typing.Optional[str]
+            Unique identifier of the payment in Pine Labs database.
+
+        client_reference_id : typing.Optional[str]
+            Unique client reference provided when creating the payout.
+
+        request_reference_id : typing.Optional[str]
+            Unique identifier of the request in Pine Labs database.
+
+        bank_transaction_reference_id : typing.Optional[str]
+            Unique Transaction Reference (UTR) from the bank.
+
+        mode : typing.Optional[ListPayoutsRequestMode]
+            Filter by payment mode.
+
+        date_from : typing.Optional[dt.datetime]
+            Fetch payouts initiated after this date (ISO 8601 UTC).
+
+        date_to : typing.Optional[dt.datetime]
+            Fetch payouts initiated before this date (ISO 8601 UTC).
+
+        status : typing.Optional[ListPayoutsRequestStatus]
+            Filter by payout status.
+
+        page : typing.Optional[str]
+            Page number (default 1).
+
+        count : typing.Optional[str]
+            Number of records per page.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetPayoutsResponse
+            Payout records retrieved successfully.
+
+        Examples
+        --------
+        import datetime
+
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.payouts.list_payouts(
+            payment_reference_id="txn-b03ee63e412a4ecf88b6bdb08a6632c3",
+            client_reference_id="0171c4c0-f50a-4151-b39b-63c87a3c0cd6",
+            request_reference_id="664816162868",
+            bank_transaction_reference_id="664816162868",
+            date_from=datetime.datetime.fromisoformat(
+                "2025-07-15 10:26:06+00:00",
+            ),
+            date_to=datetime.datetime.fromisoformat(
+                "2025-08-16 10:26:06+00:00",
+            ),
+            page="1",
+            count="10",
+        )
+        """
+        _response = self._raw_client.list_payouts(
+            payment_reference_id=payment_reference_id,
+            client_reference_id=client_reference_id,
+            request_reference_id=request_reference_id,
+            bank_transaction_reference_id=bank_transaction_reference_id,
+            mode=mode,
+            date_from=date_from,
+            date_to=date_to,
+            status=status,
+            page=page,
+            count=count,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_payout_balance(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetAccountBalanceResponse:
+        """
+        Retrieves the funding account balance linked to your Pine Labs Online
+        account. This API is only available when you have a funding account
+        linked to your Pine Labs Online account.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetAccountBalanceResponse
+            Account balance retrieved successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.payouts.get_payout_balance()
+        """
+        _response = self._raw_client.get_payout_balance(request_options=request_options)
+        return _response.data
+
+    def create_bulk_payout(
+        self, *, file: bytes, request_options: typing.Optional[RequestOptions] = None
+    ) -> CreateBulkPayoutResponse:
+        """
+        Creates multiple payouts in bulk by uploading a file containing
+        beneficiary account details. The file is processed asynchronously.
+        Use the Get Payouts API with the returned requestReferenceId to
+        track individual payout statuses.
+
+        Parameters
+        ----------
+        file : bytes
+            File containing beneficiary account details for bulk payout processing.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateBulkPayoutResponse
+            Bulk payout file accepted and processing initiated.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.payouts.create_bulk_payout(
+            file="file",
+        )
+        """
+        _response = self._raw_client.create_bulk_payout(file=file, request_options=request_options)
+        return _response.data
+
+    def update_scheduled_payout(
+        self,
+        payment_reference_id: str,
+        *,
+        schedule_at: typing.Optional[dt.datetime] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PayoutDetail:
+        """
+        Updates the scheduled date of a payout. Only payouts with status
+        SCHEDULED can be updated. Provide the new schedule date in
+        ISO 8601 UTC format.
+
+        Parameters
+        ----------
+        payment_reference_id : str
+            Unique identifier of the payment in Pine Labs database.
+
+        schedule_at : typing.Optional[dt.datetime]
+            New scheduled time for executing the payout (ISO 8601 UTC).
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PayoutDetail
+            Payout schedule updated successfully.
+
+        Examples
+        --------
+        import datetime
+
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.payouts.update_scheduled_payout(
+            payment_reference_id="txn-f9e00a80a357418d908a67bd30cdbc37",
+            schedule_at=datetime.datetime.fromisoformat(
+                "2025-07-05 16:05:00+00:00",
+            ),
+        )
+        """
+        _response = self._raw_client.update_scheduled_payout(
+            payment_reference_id, schedule_at=schedule_at, request_options=request_options
+        )
+        return _response.data
+
+    def cancel_scheduled_payout(
+        self, payment_reference_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PayoutDetail:
+        """
+        Cancels a scheduled payout. Only payouts with status SCHEDULED
+        can be cancelled. Once cancelled, the payout cannot be reinstated.
+
+        Parameters
+        ----------
+        payment_reference_id : str
+            Unique identifier of the payment in Pine Labs database.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PayoutDetail
+            Payout cancelled successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.payouts.cancel_scheduled_payout(
+            payment_reference_id="txn-f9e00a80a357418d908a67bd30cdbc37",
+        )
+        """
+        _response = self._raw_client.cancel_scheduled_payout(payment_reference_id, request_options=request_options)
+        return _response.data
+
+
+class AsyncPayoutsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawPayoutsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawPayoutsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawPayoutsClient
+        """
+        return self._raw_client
+
+    async def create_payout(
+        self,
+        *,
+        client_reference_id: str,
+        payee_name: str,
+        amount: PayoutAmount,
+        mode: CreatePayoutRequestMode,
+        remarks: str,
+        email: typing.Optional[str] = OMIT,
+        phone: typing.Optional[str] = OMIT,
+        account_number: typing.Optional[str] = OMIT,
+        branch_code: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> CreatePayoutResponse:
+        """
+        Creates a single payout to a beneficiary's bank account or UPI VPA.
+        Supports IMPS, NEFT, RTGS, and UPI payment modes.
+
+        For IMPS/NEFT/RTGS, provide accountNumber and branchCode.
+        For UPI, provide vpa instead.
+
+        Parameters
+        ----------
+        client_reference_id : str
+            Unique identifier to track the payout. Must not contain spaces. **Acts as the idempotency key** — duplicate requests with the same `clientReferenceId` will not create a new payout.
+
+        payee_name : str
+            Name of the beneficiary's bank account holder. Alphabets and spaces only.
+
+        amount : PayoutAmount
+
+        mode : CreatePayoutRequestMode
+            Mode of payment for the payout.
+
+        remarks : str
+            Description or reference text for the transaction. Supported characters A-Z, a-z, 0-9, hyphen, space.
+
+        email : typing.Optional[str]
+            Email address of the beneficiary.
+
+        phone : typing.Optional[str]
+            Mobile number of the beneficiary (10 numeric digits).
+
+        account_number : typing.Optional[str]
+            Beneficiary's bank account number. Mandatory for IMPS, NEFT, and RTGS.
+
+        branch_code : typing.Optional[str]
+            Beneficiary's bank IFSC code. Mandatory for IMPS, NEFT, and RTGS.
+            First 4 characters alphabets, 5th character must be 0, remaining alphanumeric.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreatePayoutResponse
+            Payout created and scheduled successfully.
+
+        Examples
+        --------
+        import asyncio
+
+        from pinelabs import AsyncPinelabsApi, PayoutAmount
+
+        client = AsyncPinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.payouts.create_payout(
+                client_reference_id="430582f3-6e83-4cec-a3ab-72847fb9680f",
+                payee_name="Kevin Bob",
+                email="kevin.bob@example.com",
+                phone="9876543210",
+                account_number="500012121313141415",
+                branch_code="SBIN0011123",
+                amount=PayoutAmount(
+                    value=4900,
+                    currency="INR",
+                ),
+                mode="IMPS",
+                remarks="Refund payment",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_payout(
+            client_reference_id=client_reference_id,
+            payee_name=payee_name,
+            amount=amount,
+            mode=mode,
+            remarks=remarks,
+            email=email,
+            phone=phone,
+            account_number=account_number,
+            branch_code=branch_code,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def list_payouts(
+        self,
+        *,
+        payment_reference_id: typing.Optional[str] = None,
+        client_reference_id: typing.Optional[str] = None,
+        request_reference_id: typing.Optional[str] = None,
+        bank_transaction_reference_id: typing.Optional[str] = None,
+        mode: typing.Optional[ListPayoutsRequestMode] = None,
+        date_from: typing.Optional[dt.datetime] = None,
+        date_to: typing.Optional[dt.datetime] = None,
+        status: typing.Optional[ListPayoutsRequestStatus] = None,
+        page: typing.Optional[str] = None,
+        count: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> GetPayoutsResponse:
+        """
+        Retrieves payout details. Use paymentReferenceId or clientReferenceId
+        to fetch a specific payout, or requestReferenceId to fetch all payouts
+        associated with a single request. Supports filtering by mode, status,
+        and date range.
+
+        Parameters
+        ----------
+        payment_reference_id : typing.Optional[str]
+            Unique identifier of the payment in Pine Labs database.
+
+        client_reference_id : typing.Optional[str]
+            Unique client reference provided when creating the payout.
+
+        request_reference_id : typing.Optional[str]
+            Unique identifier of the request in Pine Labs database.
+
+        bank_transaction_reference_id : typing.Optional[str]
+            Unique Transaction Reference (UTR) from the bank.
+
+        mode : typing.Optional[ListPayoutsRequestMode]
+            Filter by payment mode.
+
+        date_from : typing.Optional[dt.datetime]
+            Fetch payouts initiated after this date (ISO 8601 UTC).
+
+        date_to : typing.Optional[dt.datetime]
+            Fetch payouts initiated before this date (ISO 8601 UTC).
+
+        status : typing.Optional[ListPayoutsRequestStatus]
+            Filter by payout status.
+
+        page : typing.Optional[str]
+            Page number (default 1).
+
+        count : typing.Optional[str]
+            Number of records per page.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetPayoutsResponse
+            Payout records retrieved successfully.
+
+        Examples
+        --------
+        import asyncio
+        import datetime
+
+        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.payouts.list_payouts(
+                payment_reference_id="txn-b03ee63e412a4ecf88b6bdb08a6632c3",
+                client_reference_id="0171c4c0-f50a-4151-b39b-63c87a3c0cd6",
+                request_reference_id="664816162868",
+                bank_transaction_reference_id="664816162868",
+                date_from=datetime.datetime.fromisoformat(
+                    "2025-07-15 10:26:06+00:00",
+                ),
+                date_to=datetime.datetime.fromisoformat(
+                    "2025-08-16 10:26:06+00:00",
+                ),
+                page="1",
+                count="10",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.list_payouts(
+            payment_reference_id=payment_reference_id,
+            client_reference_id=client_reference_id,
+            request_reference_id=request_reference_id,
+            bank_transaction_reference_id=bank_transaction_reference_id,
+            mode=mode,
+            date_from=date_from,
+            date_to=date_to,
+            status=status,
+            page=page,
+            count=count,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get_payout_balance(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> GetAccountBalanceResponse:
+        """
+        Retrieves the funding account balance linked to your Pine Labs Online
+        account. This API is only available when you have a funding account
+        linked to your Pine Labs Online account.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        GetAccountBalanceResponse
+            Account balance retrieved 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.payouts.get_payout_balance()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_payout_balance(request_options=request_options)
+        return _response.data
+
+    async def create_bulk_payout(
+        self, *, file: bytes, request_options: typing.Optional[RequestOptions] = None
+    ) -> CreateBulkPayoutResponse:
+        """
+        Creates multiple payouts in bulk by uploading a file containing
+        beneficiary account details. The file is processed asynchronously.
+        Use the Get Payouts API with the returned requestReferenceId to
+        track individual payout statuses.
+
+        Parameters
+        ----------
+        file : bytes
+            File containing beneficiary account details for bulk payout processing.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateBulkPayoutResponse
+            Bulk payout file accepted and processing initiated.
+
+        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.payouts.create_bulk_payout(
+                file="file",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_bulk_payout(file=file, request_options=request_options)
+        return _response.data
+
+    async def update_scheduled_payout(
+        self,
+        payment_reference_id: str,
+        *,
+        schedule_at: typing.Optional[dt.datetime] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> PayoutDetail:
+        """
+        Updates the scheduled date of a payout. Only payouts with status
+        SCHEDULED can be updated. Provide the new schedule date in
+        ISO 8601 UTC format.
+
+        Parameters
+        ----------
+        payment_reference_id : str
+            Unique identifier of the payment in Pine Labs database.
+
+        schedule_at : typing.Optional[dt.datetime]
+            New scheduled time for executing the payout (ISO 8601 UTC).
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PayoutDetail
+            Payout schedule updated successfully.
+
+        Examples
+        --------
+        import asyncio
+        import datetime
+
+        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.payouts.update_scheduled_payout(
+                payment_reference_id="txn-f9e00a80a357418d908a67bd30cdbc37",
+                schedule_at=datetime.datetime.fromisoformat(
+                    "2025-07-05 16:05:00+00:00",
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.update_scheduled_payout(
+            payment_reference_id, schedule_at=schedule_at, request_options=request_options
+        )
+        return _response.data
+
+    async def cancel_scheduled_payout(
+        self, payment_reference_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> PayoutDetail:
+        """
+        Cancels a scheduled payout. Only payouts with status SCHEDULED
+        can be cancelled. Once cancelled, the payout cannot be reinstated.
+
+        Parameters
+        ----------
+        payment_reference_id : str
+            Unique identifier of the payment in Pine Labs database.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        PayoutDetail
+            Payout cancelled 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.payouts.cancel_scheduled_payout(
+                payment_reference_id="txn-f9e00a80a357418d908a67bd30cdbc37",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.cancel_scheduled_payout(
+            payment_reference_id, request_options=request_options
+        )
+        return _response.data