mercadopago.resources.disbursement_refund API documentation
Description: Module: disbursement_refund

# Module `mercadopago.resources.disbursement_refund`

Module: disbursement_refund

Expand source code

    """
        Module: disbursement_refund
    """
    from mercadopago.core import MPBase

    class DisbursementRefund(MPBase):

        """
        Access to Advanced Payments Refunds
        """

        def list_all(self, advanced_payment_id, request_options=None):
            """[Args:
                advanced_payment_id (str): The Advanced Payment ID
                request_options (mercadopago.config.request_options, optional): An instance of
                RequestOptions can be pass changing or adding custom options to ur REST call.
                Defaults to None.

            Returns:
                dict: Disbursement Refund find response
            """
            uri = f"/v1/advanced_payments/{str(advanced_payment_id)}/refunds"
            return self._get(uri=uri, request_options=request_options)

        def create_all(self, advanced_payment_id, disbursement_refund_object, request_options=None):
            """[Args:
                advanced_payment_id (str): The Advanced Payment ID
                disbursement_refund_object (dict): Disbursement Refund to be created
                request_options (mercadopago.config.request_options, optional): An instance of
                RequestOptions can be pass changing or adding custom options to ur REST call.
                Defaults to None.

            Raises:
            ValueError: Param disbursement_refund_object must be a Dictionary

            Returns:
                dict: Disbursement Refund creation all response
            """
            if not isinstance(disbursement_refund_object, dict):
                raise ValueError(
                    "Param disbursement_refund_object must be a Dictionary")

            return self._post(
                uri="/v1/advanced_payments/" + str(advanced_payment_id) + "/refunds",
                data=disbursement_refund_object,
                request_options=request_options,
            )

        def create(self, advanced_payment_id, disbursement_id, amount, request_options=None):
            """[Args:
                advanced_payment_id (str): The Advanced Payment ID
                disbursement_id (str): Disbursement ID
                amount: Amount to be refunded
                request_options (mercadopago.config.request_options, optional): An instance of
                RequestOptions can be pass changing or adding custom options to ur REST call.
                Defaults to None.

            Raises:
            ValueError: Param amount must be a Float

            Returns:
                dict: Disbursement Refund creation response
            """
            if not isinstance(amount, float):
                raise ValueError("Param amount must be a Float")

            disbursement_refund_object = {"amount": amount}

            uri = (
                f"/v1/advanced_payments/{str(advanced_payment_id)}"
                f"/disbursements/{str(disbursement_id)}/refunds"
            )

            return self._post(
                uri=uri,
                data=disbursement_refund_object,
                request_options=request_options,
            )

        def save(self, advanced_payment_id, disbursement_id, disbursement_refund_object,
                 request_options=None):
            """[Args:
                advanced_payment_id (str): The Advanced Payment ID
                disbursement_id (str): Disbursement ID
                disbursement_refund_object (dict): Disbursement Refund to be saved
                request_options (mercadopago.config.request_options, optional): An instance of
                RequestOptions can be pass changing or adding custom options to ur REST call.
                Defaults to None.

            Raises:
            ValueError: Param disbursement_refund_object must be a Dictionary

            Returns:
                dict: Disbursement Refund save response
            """
            if not isinstance(disbursement_refund_object, dict):
                raise ValueError(
                    "Param disbursement_refund_object must be a Dictionary")

            uri = (
                f"/v1/advanced_payments/{str(advanced_payment_id)}"
                f"/disbursements/{str(disbursement_id)}/refunds"
            )

            return self._post(
                uri=uri,
                data=disbursement_refund_object,
                request_options=request_options,
            )

## Classes

`class DisbursementRefund (request_options, http_client)`

  Access to Advanced Payments Refunds

  Expand source code

      class DisbursementRefund(MPBase):

          """
          Access to Advanced Payments Refunds
          """

          def list_all(self, advanced_payment_id, request_options=None):
              """[Args:
                  advanced_payment_id (str): The Advanced Payment ID
                  request_options (mercadopago.config.request_options, optional): An instance of
                  RequestOptions can be pass changing or adding custom options to ur REST call.
                  Defaults to None.

              Returns:
                  dict: Disbursement Refund find response
              """
              uri = f"/v1/advanced_payments/{str(advanced_payment_id)}/refunds"
              return self._get(uri=uri, request_options=request_options)

          def create_all(self, advanced_payment_id, disbursement_refund_object, request_options=None):
              """[Args:
                  advanced_payment_id (str): The Advanced Payment ID
                  disbursement_refund_object (dict): Disbursement Refund to be created
                  request_options (mercadopago.config.request_options, optional): An instance of
                  RequestOptions can be pass changing or adding custom options to ur REST call.
                  Defaults to None.

              Raises:
              ValueError: Param disbursement_refund_object must be a Dictionary

              Returns:
                  dict: Disbursement Refund creation all response
              """
              if not isinstance(disbursement_refund_object, dict):
                  raise ValueError(
                      "Param disbursement_refund_object must be a Dictionary")

              return self._post(
                  uri="/v1/advanced_payments/" + str(advanced_payment_id) + "/refunds",
                  data=disbursement_refund_object,
                  request_options=request_options,
              )

          def create(self, advanced_payment_id, disbursement_id, amount, request_options=None):
              """[Args:
                  advanced_payment_id (str): The Advanced Payment ID
                  disbursement_id (str): Disbursement ID
                  amount: Amount to be refunded
                  request_options (mercadopago.config.request_options, optional): An instance of
                  RequestOptions can be pass changing or adding custom options to ur REST call.
                  Defaults to None.

              Raises:
              ValueError: Param amount must be a Float

              Returns:
                  dict: Disbursement Refund creation response
              """
              if not isinstance(amount, float):
                  raise ValueError("Param amount must be a Float")

              disbursement_refund_object = {"amount": amount}

              uri = (
                  f"/v1/advanced_payments/{str(advanced_payment_id)}"
                  f"/disbursements/{str(disbursement_id)}/refunds"
              )

              return self._post(
                  uri=uri,
                  data=disbursement_refund_object,
                  request_options=request_options,
              )

          def save(self, advanced_payment_id, disbursement_id, disbursement_refund_object,
                   request_options=None):
              """[Args:
                  advanced_payment_id (str): The Advanced Payment ID
                  disbursement_id (str): Disbursement ID
                  disbursement_refund_object (dict): Disbursement Refund to be saved
                  request_options (mercadopago.config.request_options, optional): An instance of
                  RequestOptions can be pass changing or adding custom options to ur REST call.
                  Defaults to None.

              Raises:
              ValueError: Param disbursement_refund_object must be a Dictionary

              Returns:
                  dict: Disbursement Refund save response
              """
              if not isinstance(disbursement_refund_object, dict):
                  raise ValueError(
                      "Param disbursement_refund_object must be a Dictionary")

              uri = (
                  f"/v1/advanced_payments/{str(advanced_payment_id)}"
                  f"/disbursements/{str(disbursement_id)}/refunds"
              )

              return self._post(
                  uri=uri,
                  data=disbursement_refund_object,
                  request_options=request_options,
              )

  ### Ancestors

  - MPBase

  ### Methods

  `def create(self, advanced_payment_id, disbursement_id, amount, request_options=None)`

    [Args: advanced_payment_id (str): The Advanced Payment ID disbursement_id (str): Disbursement ID amount: Amount to be refunded request_options (mercadopago.config.request_options, optional): An instance of RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.

    Raises: ValueError: Param amount must be a Float

    ## Returns

    `dict`
      Disbursement Refund creation response
    Expand source code

        def create(self, advanced_payment_id, disbursement_id, amount, request_options=None):
            """[Args:
                advanced_payment_id (str): The Advanced Payment ID
                disbursement_id (str): Disbursement ID
                amount: Amount to be refunded
                request_options (mercadopago.config.request_options, optional): An instance of
                RequestOptions can be pass changing or adding custom options to ur REST call.
                Defaults to None.

            Raises:
            ValueError: Param amount must be a Float

            Returns:
                dict: Disbursement Refund creation response
            """
            if not isinstance(amount, float):
                raise ValueError("Param amount must be a Float")

            disbursement_refund_object = {"amount": amount}

            uri = (
                f"/v1/advanced_payments/{str(advanced_payment_id)}"
                f"/disbursements/{str(disbursement_id)}/refunds"
            )

            return self._post(
                uri=uri,
                data=disbursement_refund_object,
                request_options=request_options,
            )

  `def create_all(self, advanced_payment_id, disbursement_refund_object, request_options=None)`

    [Args: advanced_payment_id (str): The Advanced Payment ID disbursement_refund_object (dict): Disbursement Refund to be created request_options (mercadopago.config.request_options, optional): An instance of RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.

    Raises: ValueError: Param disbursement_refund_object must be a Dictionary

    ## Returns

    `dict`
      Disbursement Refund creation all response
    Expand source code

        def create_all(self, advanced_payment_id, disbursement_refund_object, request_options=None):
            """[Args:
                advanced_payment_id (str): The Advanced Payment ID
                disbursement_refund_object (dict): Disbursement Refund to be created
                request_options (mercadopago.config.request_options, optional): An instance of
                RequestOptions can be pass changing or adding custom options to ur REST call.
                Defaults to None.

            Raises:
            ValueError: Param disbursement_refund_object must be a Dictionary

            Returns:
                dict: Disbursement Refund creation all response
            """
            if not isinstance(disbursement_refund_object, dict):
                raise ValueError(
                    "Param disbursement_refund_object must be a Dictionary")

            return self._post(
                uri="/v1/advanced_payments/" + str(advanced_payment_id) + "/refunds",
                data=disbursement_refund_object,
                request_options=request_options,
            )

  `def list_all(self, advanced_payment_id, request_options=None)`

    [Args: advanced_payment_id (str): The Advanced Payment ID request_options (mercadopago.config.request_options, optional): An instance of RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.

    ## Returns

    `dict`
      Disbursement Refund find response
    Expand source code

        def list_all(self, advanced_payment_id, request_options=None):
            """[Args:
                advanced_payment_id (str): The Advanced Payment ID
                request_options (mercadopago.config.request_options, optional): An instance of
                RequestOptions can be pass changing or adding custom options to ur REST call.
                Defaults to None.

            Returns:
                dict: Disbursement Refund find response
            """
            uri = f"/v1/advanced_payments/{str(advanced_payment_id)}/refunds"
            return self._get(uri=uri, request_options=request_options)

  `def save(self, advanced_payment_id, disbursement_id, disbursement_refund_object, request_options=None)`

    [Args: advanced_payment_id (str): The Advanced Payment ID disbursement_id (str): Disbursement ID disbursement_refund_object (dict): Disbursement Refund to be saved request_options (mercadopago.config.request_options, optional): An instance of RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.

    Raises: ValueError: Param disbursement_refund_object must be a Dictionary

    ## Returns

    `dict`
      Disbursement Refund save response
    Expand source code

        def save(self, advanced_payment_id, disbursement_id, disbursement_refund_object,
                 request_options=None):
            """[Args:
                advanced_payment_id (str): The Advanced Payment ID
                disbursement_id (str): Disbursement ID
                disbursement_refund_object (dict): Disbursement Refund to be saved
                request_options (mercadopago.config.request_options, optional): An instance of
                RequestOptions can be pass changing or adding custom options to ur REST call.
                Defaults to None.

            Raises:
            ValueError: Param disbursement_refund_object must be a Dictionary

            Returns:
                dict: Disbursement Refund save response
            """
            if not isinstance(disbursement_refund_object, dict):
                raise ValueError(
                    "Param disbursement_refund_object must be a Dictionary")

            uri = (
                f"/v1/advanced_payments/{str(advanced_payment_id)}"
                f"/disbursements/{str(disbursement_id)}/refunds"
            )

            return self._post(
                uri=uri,
                data=disbursement_refund_object,
                request_options=request_options,
            )

  ### Inherited members

  - `MPBase`:
    - `config`
    - `request_options`