===========================================
Transfer Recipients Module
===========================================

This wrapper class facilitates synchronous integration with Paystack Transfer Recipient APIs. The Transfer Recipients API allows you to create and manage beneficiaries that you send money to.

----------------

.. py:class:: TransferRecipientsClientAPI(secret_key: str = None)

    Paystack Transfer Recipients API Reference: `Transfer Recipients`_

    .. py:method:: bulk_create_transfer_recipient(batch: List[Dict[str, Any]])→ PayStackResponse

        Create multiple transfer recipients in batches.

        :param batch: A list of transfer recipient dict keys [ { ``type``, ``name``, ``account_number``, ``bank_code``, ``currency`` etc. }]
        :type batch: List[Dict[str, Any]]

        :return: The response from the API
        :rtype: PayStackResponse object

    .. py:method:: create_transfer_recipients(recipient_type: str, recipient_name: str, account_number: str, bank_code: str, description: str | None = None, currency: str | None = None, authorization_code: str | None = None, metadata: Dict[str, Any] | None = None)→ PayStackResponse

        Create a transfer recipient

        :param recipient_type: The type of transfer recipient:[ ``nuban`` | ``ghipss`` | ``mobile_money`` | ``basa`` ]
        :type recipient_type: str
        :param recipient_name: The name of the transfer recipient according to their registration
        :type recipient_name: str
        :param account_number: transfer recipient’s account number. Required for all recipient types except authorization
        :type account_number: str
        :param bank_code: transfer recipient’s bank code. Required for all recipient types except authorization
        :type bank_code: str
        :param description:
        :type description: str, optional
        :param currency:
        :type currency: str, optional
        :param authorization_code: transfer recipient’s authorization code from previous transaction
        :type authorization_code: str, optional
        :param metadata:
        :type metadata: dict, optional

        :return: The response from the API
        :rtype: PayStackResponse object

    .. py:method:: delete_transfer_recipient(id_or_code: str)→ PayStackResponse

        Delete a transfer recipient

        :param id_or_code: The id or code of the transfer recipient
        :type id_or_code: str

        :return: The response from the API
        :rtype: PayStackResponse object

    .. py:method:: fetch_transfer_recipient(id_or_code: str)→ PayStackResponse

        Fetch details of a transfer recipient

        :param id_or_code: The id or code of the transfer recipient
        :type id_or_code: str

        :return: The response from the API
        :rtype: PayStackResponse object

    .. py:method:: list_transfer_recipients(per_page: int | None = None, page: int | None = None, from_date: date | None = None, to_date: date | None = None)→ PayStackResponse

        List of all transfer recipients

        :param per_page: The number of records to return per page.
        :type per_page: int, optional
        :param page: The page to return.
        :type page: int, optional
        :param from_date: The customer's from date.
        :type from_date: date, optional
        :param to_date: The customer's to date.
        :type to_date: date, optional

        :return: The response from the API
        :rtype: PayStackResponse object

    .. py:method:: update_transfer_recipient(id_or_code: str, recipient_name: str, recipient_email: str | None = None)→ PayStackResponse

        Update a transfer recipient

        :param id_or_code:
        :type id_or_code: str
        :param recipient_name:
        :type recipient_name: str
        :param recipient_email:
        :type recipient_email: str

        :return: The response from the API
        :rtype: PayStackResponse object


.. _Transfer Recipients: https://paystack.com/docs/api/transfer-recipient/