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

# Module `mercadopago.resources.advanced_payment`

Module: advanced_payment

Expand source code

    """
        Module: advanced_payment
    """
    from datetime import datetime

    from mercadopago.core import MPBase

    class AdvancedPayment(MPBase):
        """
        Access to Advanced Payments
        """

        def search(self, filters=None, request_options=None):
            """[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments_id_search/get/)  # pylint: disable=line-too-long

            Args:
                filters (dict): The search filters parameters
                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: Advanced Payment search response
            """
            return self._get(uri="/v1/advanced_payments/search", filters=filters,
                             request_options=request_options)

        def get(self, advanced_payment_id, request_options=None):
            """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/get/)  # pylint: disable=line-too-long

            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: Advanced Payment find response
            """
            return self._get(uri="/v1/advanced_payments/" + str(advanced_payment_id),
                             request_options=request_options)

        def create(self, advanced_payment_object, request_options=None):
            """[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments/post/)  # pylint: disable=line-too-long

            Args:
                advanced_payment_object (dict): Advanced Payment 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 advanced_payment_object must be a Dictionary

            Returns:
                dict: Advanced Payment creation response
            """
            if not isinstance(advanced_payment_object, dict):
                raise ValueError(
                    "Param advanced_payment_object must be a Dictionary")

            return self._post(uri="/v1/advanced_payments", data=advanced_payment_object,
                              request_options=request_options)

        def capture(self, advanced_payment_id, request_options=None):
            """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long

            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: Advanced Payment capture response
            """
            capture_object = {"capture": True}
            return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),
                             data=capture_object, request_options=request_options)

        def update(self, advanced_payment_id, advanced_payment_object, request_options=None):
            """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long

            Args:
                advanced_payment_id (str): The Advanced Payment ID
                advanced_payment_object (dict): Advanced Payment to be updated
                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 advanced_payment_object must be a Dictionary

            Returns:
                dict: Advanced Payment modification response
            """
            if not isinstance(advanced_payment_object, dict):
                raise ValueError(
                    "Param advanced_payment_object must be a Dictionary")

            return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),
                             data=advanced_payment_object, request_options=request_options)

        def cancel(self, advanced_payment_id, request_options=None):
            """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long

            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: Advanced Payment cancelation response
            """
            cancel_object = {"status": "cancelled"}
            return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),
                             data=cancel_object, request_options=request_options)

        def update_release_date(self, advanced_payment_id, release_date, request_options=None):
            """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id_disbursements_disbursement_id_disburses/post/)  # pylint: disable=line-too-long

            Args:
                advanced_payment_id (str): The Advanced Payment ID
                release_date (datetime): Advanced Payment to be canceled
                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 release_date must be a DateTime

            Returns:
                dict: Advanced Payment release date modification response
            """
            if not isinstance(release_date, datetime):
                raise ValueError("Param release_date must be a DateTime")

            disbursement_object = {
                "money_release_date": release_date.strftime("%Y-%m-%d %H:%M:%S.%f")}

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

## Classes

`class AdvancedPayment (request_options, http_client)`

  Access to Advanced Payments

  Expand source code

      class AdvancedPayment(MPBase):
          """
          Access to Advanced Payments
          """

          def search(self, filters=None, request_options=None):
              """[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments_id_search/get/)  # pylint: disable=line-too-long

              Args:
                  filters (dict): The search filters parameters
                  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: Advanced Payment search response
              """
              return self._get(uri="/v1/advanced_payments/search", filters=filters,
                               request_options=request_options)

          def get(self, advanced_payment_id, request_options=None):
              """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/get/)  # pylint: disable=line-too-long

              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: Advanced Payment find response
              """
              return self._get(uri="/v1/advanced_payments/" + str(advanced_payment_id),
                               request_options=request_options)

          def create(self, advanced_payment_object, request_options=None):
              """[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments/post/)  # pylint: disable=line-too-long

              Args:
                  advanced_payment_object (dict): Advanced Payment 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 advanced_payment_object must be a Dictionary

              Returns:
                  dict: Advanced Payment creation response
              """
              if not isinstance(advanced_payment_object, dict):
                  raise ValueError(
                      "Param advanced_payment_object must be a Dictionary")

              return self._post(uri="/v1/advanced_payments", data=advanced_payment_object,
                                request_options=request_options)

          def capture(self, advanced_payment_id, request_options=None):
              """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long

              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: Advanced Payment capture response
              """
              capture_object = {"capture": True}
              return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),
                               data=capture_object, request_options=request_options)

          def update(self, advanced_payment_id, advanced_payment_object, request_options=None):
              """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long

              Args:
                  advanced_payment_id (str): The Advanced Payment ID
                  advanced_payment_object (dict): Advanced Payment to be updated
                  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 advanced_payment_object must be a Dictionary

              Returns:
                  dict: Advanced Payment modification response
              """
              if not isinstance(advanced_payment_object, dict):
                  raise ValueError(
                      "Param advanced_payment_object must be a Dictionary")

              return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),
                               data=advanced_payment_object, request_options=request_options)

          def cancel(self, advanced_payment_id, request_options=None):
              """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long

              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: Advanced Payment cancelation response
              """
              cancel_object = {"status": "cancelled"}
              return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),
                               data=cancel_object, request_options=request_options)

          def update_release_date(self, advanced_payment_id, release_date, request_options=None):
              """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id_disbursements_disbursement_id_disburses/post/)  # pylint: disable=line-too-long

              Args:
                  advanced_payment_id (str): The Advanced Payment ID
                  release_date (datetime): Advanced Payment to be canceled
                  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 release_date must be a DateTime

              Returns:
                  dict: Advanced Payment release date modification response
              """
              if not isinstance(release_date, datetime):
                  raise ValueError("Param release_date must be a DateTime")

              disbursement_object = {
                  "money_release_date": release_date.strftime("%Y-%m-%d %H:%M:%S.%f")}

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

  ### Ancestors

  - MPBase

  ### Methods

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

    Click here for more info # pylint: disable=line-too-long

    ## 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`
      Advanced Payment cancelation response
    Expand source code

        def cancel(self, advanced_payment_id, request_options=None):
            """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long

            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: Advanced Payment cancelation response
            """
            cancel_object = {"status": "cancelled"}
            return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),
                             data=cancel_object, request_options=request_options)

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

    Click here for more info # pylint: disable=line-too-long

    ## 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`
      Advanced Payment capture response
    Expand source code

        def capture(self, advanced_payment_id, request_options=None):
            """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long

            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: Advanced Payment capture response
            """
            capture_object = {"capture": True}
            return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),
                             data=capture_object, request_options=request_options)

  `def create(self, advanced_payment_object, request_options=None)`

    Click here for more info # pylint: disable=line-too-long

    ## Args

    `advanced_payment_object` :`dict`
      Advanced Payment 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 advanced_payment_object must be a Dictionary

    ## Returns

    `dict`
      Advanced Payment creation response
    Expand source code

        def create(self, advanced_payment_object, request_options=None):
            """[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments/post/)  # pylint: disable=line-too-long

            Args:
                advanced_payment_object (dict): Advanced Payment 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 advanced_payment_object must be a Dictionary

            Returns:
                dict: Advanced Payment creation response
            """
            if not isinstance(advanced_payment_object, dict):
                raise ValueError(
                    "Param advanced_payment_object must be a Dictionary")

            return self._post(uri="/v1/advanced_payments", data=advanced_payment_object,
                              request_options=request_options)

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

    Click here for more info # pylint: disable=line-too-long

    ## 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`
      Advanced Payment find response
    Expand source code

        def get(self, advanced_payment_id, request_options=None):
            """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/get/)  # pylint: disable=line-too-long

            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: Advanced Payment find response
            """
            return self._get(uri="/v1/advanced_payments/" + str(advanced_payment_id),
                             request_options=request_options)

  `def search(self, filters=None, request_options=None)`

    Click here for more info # pylint: disable=line-too-long

    ## Args

    `filters` :`dict`
      The search filters parameters

    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`
      Advanced Payment search response
    Expand source code

        def search(self, filters=None, request_options=None):
            """[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments_id_search/get/)  # pylint: disable=line-too-long

            Args:
                filters (dict): The search filters parameters
                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: Advanced Payment search response
            """
            return self._get(uri="/v1/advanced_payments/search", filters=filters,
                             request_options=request_options)

  `def update(self, advanced_payment_id, advanced_payment_object, request_options=None)`

    Click here for more info # pylint: disable=line-too-long

    ## Args

    `advanced_payment_id` :`str`
      The Advanced Payment ID
    `advanced_payment_object` :`dict`
      Advanced Payment to be updated
    `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 advanced_payment_object must be a Dictionary

    ## Returns

    `dict`
      Advanced Payment modification response
    Expand source code

        def update(self, advanced_payment_id, advanced_payment_object, request_options=None):
            """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long

            Args:
                advanced_payment_id (str): The Advanced Payment ID
                advanced_payment_object (dict): Advanced Payment to be updated
                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 advanced_payment_object must be a Dictionary

            Returns:
                dict: Advanced Payment modification response
            """
            if not isinstance(advanced_payment_object, dict):
                raise ValueError(
                    "Param advanced_payment_object must be a Dictionary")

            return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),
                             data=advanced_payment_object, request_options=request_options)

  `def update_release_date(self, advanced_payment_id, release_date, request_options=None)`

    Click here for more info # pylint: disable=line-too-long

    ## Args

    `advanced_payment_id` :`str`
      The Advanced Payment ID
    `release_date` :`datetime`
      Advanced Payment to be canceled
    `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 release_date must be a DateTime

    ## Returns

    `dict`
      Advanced Payment release date modification response
    Expand source code

        def update_release_date(self, advanced_payment_id, release_date, request_options=None):
            """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id_disbursements_disbursement_id_disburses/post/)  # pylint: disable=line-too-long

            Args:
                advanced_payment_id (str): The Advanced Payment ID
                release_date (datetime): Advanced Payment to be canceled
                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 release_date must be a DateTime

            Returns:
                dict: Advanced Payment release date modification response
            """
            if not isinstance(release_date, datetime):
                raise ValueError("Param release_date must be a DateTime")

            disbursement_object = {
                "money_release_date": release_date.strftime("%Y-%m-%d %H:%M:%S.%f")}

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

  ### Inherited members

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