[ { "path": ".github/ISSUE_TEMPLATE/bug_report.yml", "content": "name: ๐Ÿ› Bug Report\ndescription: Report a bug or unexpected behavior in the SDK\ntitle: \"[BUG]: \"\nlabels: [\"bug\", \"needs-triage\"]\nassignees: [\"danielalfarourrea\",\"luismeli10\",\"orojaspardo\"]\n\nbody:\n - type: markdown\n attributes:\n value: |\n ## ๐Ÿ› Thanks for reporting this issue!\n\n Please make sure you tested with the latest version of the relevant packages and/or checked existing issues to avoid duplicates. If the bug persists, open the issue with a clear and concise description including screenshots, if applicable. We appreciate your feedback!\n\n **Before reporting a bug:**\n - ๐Ÿ” **Search [existing issues](./issues?q=is%3Aissue) to avoid duplicates**\n - ๐Ÿ“š **Verify you are using the [latest version](../../releases)**\n - ๐Ÿ’ก **Try to reproduce the problem in sandbox environment**\n - โš ๏ธ **IMPORTANT: Your bug will be resolved faster if you can share a self-contained example that doesn't rely on internal or private dependencies.**\n\n > **๐Ÿ”’ SECURITY WARNING:** Issues without reproduction steps or code examples may be immediately closed as not actionable. Always remember to **REMOVE ALL PII AND PERSONAL INFORMATION** from your examples. **Bugs opened with real data will be immediately reported and closed.**\n\n - type: input\n id: sdk-version\n attributes:\n label: ๐Ÿ“ฆ SDK Version\n description: \"Example: 2.1.0\"\n placeholder: \"x.y.z\"\n validations:\n required: true\n\n - type: textarea\n id: environment-details\n attributes:\n label: ๐Ÿ–ฅ๏ธ Environment Details\n description: |\n System and dependencies information\n placeholder: |\n - Operating System: [e.g. Ubuntu 20.04, Windows 11, macOS 13]\n - Language Version: [e.g. Python 3.9.0, Node.js 18.0.0]\n - Framework: [e.g. Django 4.0, Express 4.18]\n - Package Manager: [e.g. pip 21.0, npm 8.0]\n - Other relevant dependencies: ...\n validations:\n required: true\n\n - type: dropdown\n id: country\n attributes:\n label: ๐ŸŒŽ Country\n description: Country where the issue occurs\n options:\n - Argentina (MLA)\n - Brazil (MLB)\n - Chile (MLC)\n - Colombia (MCO)\n - Mexico (MLM)\n - Peru (MPE)\n - Uruguay (MLU)\n - Other\n validations:\n required: true\n\n - type: textarea\n id: description\n attributes:\n label: ๐Ÿ“ Bug Description\n description: A clear and concise description of what the bug is\n placeholder: The SDK fails when I try to...\n validations:\n required: true\n\n - type: textarea\n id: expected\n attributes:\n label: โœ… Expected Behavior\n description: A clear description of the behavior you expected from the SDK\n placeholder: I expected the SDK to...\n validations:\n required: true\n\n - type: textarea\n id: actual\n attributes:\n label: โŒ Actual Behavior\n description: A description of what the SDK actually does instead\n placeholder: Instead, the SDK...\n validations:\n required: true\n\n - type: textarea\n id: reproduce\n attributes:\n label: ๐Ÿ”„ Steps To Reproduce\n description: Detailed steps to reproduce the problem\n placeholder: |\n 1. Configure the SDK with...\n 2. Execute the method...\n 3. Send the following parameters...\n 4. Observe the error...\n validations:\n required: true\n\n - type: textarea\n id: code-sample\n attributes:\n label: ๐Ÿ’ป Code Example\n description: |\n Minimal code that reproduces the problem. **REMOVE ALL CREDENTIALS AND SENSITIVE DATA.**\n\n You can provide:\n - A CodeSandbox (https://codepen.io/pen/)\n - A link to a GitHub repository\n - A minimal code example that reproduces the problem\n - A screenshot of the application if you think it is relevant\n\n **Remember to REMOVE ALL SENSITIVE DATA FIRST.**\n render: python\n placeholder: |\n import mercadopago\n\n sdk = mercadopago.SDK(\"YOUR_ACCESS_TOKEN\") # โš ๏ธ DO NOT USE REAL TOKENS\n\n # Your code here that reproduces the bug...\n validations:\n required: true\n\n - type: textarea\n id: error-logs\n attributes:\n label: ๐Ÿ“‹ Logs and Error Messages\n description: Copy complete logs, stack traces, or error messages\n render: shell\n placeholder: |\n Error: ...\n Stack trace: ...\n\n - type: checkboxes\n id: checklist\n attributes:\n label: โœ… Checklist\n options:\n - label: I have verified that I am using the latest SDK version\n required: true\n - label: I have searched existing issues and this bug has not been reported\n required: true\n - label: I have included a minimal code example to reproduce the problem\n required: true\n - label: I have removed all sensitive information (tokens, credentials, real data)\n required: true" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: false\ncontact_links:\n - name: Support Center Mercado Pago - ES\n url: https://www.mercadopago.com/developers/es/support/center\n about: Problems with payments, account, or general inquiries\n - name: Support Center Mercado Pago - PT\n url: https://www.mercadopago.com/developers/pt/support/center\n about: Problems with payments, account, or general inquiries" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.yml", "content": "name: โœจ Feature Request\ndescription: Propose a new feature for the Mercado Pago SDK\ntitle: \"[FEATURE]: \"\nlabels: [\"enhancement\", \"needs-triage\"]\nassignees: [\"danielalfarourrea\",\"luismeli10\",\"orojaspardo\"]\n\nbody:\n - type: markdown\n attributes:\n value: |\n ## ๐Ÿ’ก Thanks for contributing with ideas!\n\n Your feedback is valuable to improve the SDK. Before submitting:\n - ๐Ÿ” **Search [existing issues](./issues?q=is%3Aissue) to avoid duplicates**.\n - ๐Ÿ“š **Check the [documentation](https://www.mercadopago.com/developers/es/docs) to confirm this isn't already supported**.\n\n - type: dropdown\n id: feature-type\n attributes:\n label: โš™๏ธ Feature Type\n description: What type of improvement are you proposing?\n options:\n - New feature\n - Enhancement of existing feature\n - Support for new Mercado Pago product\n - Better error handling\n - Documentation improvement\n - Performance optimization\n - Other\n validations:\n required: true\n\n - type: textarea\n id: problem\n attributes:\n label: ๐ŸŽฏ Problem to solve\n description: Describe the problem or need this feature would solve.\n placeholder: |\n As a developer of [application type]...\n I need [feature]...\n To be able to [goal]...\n validations:\n required: true\n\n - type: textarea\n id: solution\n attributes:\n label: ๐Ÿ’ก Proposed Solution\n description: Describe how you would like this new feature to work.\n placeholder: |\n I would like the SDK to support...\n The implementation could be...\n Usage example:\n ```\n // example code\n ```\n validations:\n required: true\n\n - type: textarea\n id: alternatives\n attributes:\n label: ๐Ÿ”„ Alternatives Considered\n description: |\n Have you tried any workarounds?\n Are there similar features in other SDKs or libraries?\n placeholder: |\n - Alternative 1: ...\n - Alternative 2: ...\n - In the [language] SDK they do...\n\n - type: checkboxes\n id: checklist\n attributes:\n label: โœ… Checklist\n options:\n - label: I have searched existing issues and this feature has not been requested before\n required: true\n - label: I have clearly described the problem I am trying to solve\n required: true\n - label: I have proposed a concrete solution or API design\n required: true\n - label: This feature would benefit other users, not just my specific use case\n required: true\n - label: I have not included any sensitive information (tokens, credentials, real data)\n required: true" }, { "path": ".github/ISSUE_TEMPLATE/question.yml", "content": "name: ๐Ÿ’ฌ Question\ndescription: Ask a question about the Mercado Pago SDK\ntitle: \"[QUESTION]: \"\nlabels: [\"question\", \"needs-triage\"]\nassignees: [\"danielalfarourrea\",\"luismeli10\",\"orojaspardo\"]\n\nbody:\n - type: markdown\n attributes:\n value: |\n ## ๐Ÿ‘‹ Thanks for using the Mercado Pago SDK!\n\n Before asking your question, please:\n - ๐Ÿ” **Search [existing issues](./issues?q=is%3Aissue) to see if it was already answered**\n - ๐Ÿ“š **Check the [official documentation](https://www.mercadopago.com/developers/es/docs)**\n - ๐Ÿ’ก **Review the repository examples**\n\n - type: input\n id: sdk-version\n attributes:\n label: ๐Ÿ“ฆ SDK Version\n description: \"Example: 2.1.0\"\n placeholder: \"x.y.z\"\n validations:\n required: true\n\n - type: dropdown\n id: country\n attributes:\n label: ๐ŸŒŽ Country\n description: In which country are you operating?\n options:\n - Argentina (MLA)\n - Brazil (MLB)\n - Chile (MLC)\n - Colombia (MCO)\n - Mexico (MLM)\n - Peru (MPE)\n - Uruguay (MLU)\n - Other\n validations:\n required: true\n\n - type: textarea\n id: context\n attributes:\n label: ๐Ÿ–ฅ๏ธ Environment Details\n description: |\n Provide details about your environment to help us understand your setup:\n - Platform (Web, Mobile, Backend)\n - Framework used\n - Relevant error messages\n - Documentation consulted\n placeholder: |\n - Platform: [e.g. Backend, Web, Mobile]\n - Language Version: [e.g. Python 3.9.0, Node.js 18.0.0]\n - Framework: [e.g. Django 4.0, Express 4.18]\n - Other relevant dependencies: ...\n\n - type: textarea\n id: question\n attributes:\n label: โ“ Your Question\n description: Ask your question as clearly and specifically as possible. The more detail you provide, the faster we can help.\n placeholder: |\n What are you trying to do?\n What have you tried so far?\n What is the result you are getting vs. what you expected?\n Is there an error message involved?\n validations:\n required: true\n\n - type: textarea\n id: code-sample\n attributes:\n label: ๐Ÿ’ป Code Example (optional)\n description: If applicable, share a code snippet that illustrates your question. **Remember to remove all sensitive data (tokens, credentials, etc)**\n render: python\n placeholder: |\n import mercadopago\n\n sdk = mercadopago.SDK(\"YOUR_ACCESS_TOKEN\") # โš ๏ธ DO NOT USE REAL TOKENS\n # Your code here...\n\n - type: checkboxes\n id: checklist\n attributes:\n label: โœ… Checklist\n options:\n - label: I have searched existing issues\n required: true\n - label: I have checked the official documentation\n required: true\n - label: I have removed sensitive information (tokens, credentials, etc)\n required: true" }, { "path": ".github/workflows/cd.yml", "content": "# This workflow will install Python dependencies and upload a version in the PyPI\nname: CD - Upload PyPI\n\non:\n release:\n types: [ released ]\n\njobs:\n upload:\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/checkout@v2\n\n # Sets up python\n - uses: actions/setup-python@v2\n with:\n python-version: 3.12\n\n # Install dependencies\n - name: \"Installs dependencies\"\n run: |\n python3 -m pip install --upgrade pip\n python3 -m pip install setuptools build twine\n python3 -m pip install .\n\n # Build and upload to PyPI\n - name: \"Builds and uploads to PyPI\"\n run: |\n python3 -m build\n python3 -m twine check dist/*\n python3 -m twine upload dist/*\n env:\n TWINE_USERNAME: __token__\n TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}\n" }, { "path": ".github/workflows/ci.yml", "content": "# This workflow will install Python dependencies, run tests and lint with a variety of Python versions\n# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions\n\nname: CI - Lint and Tests\n\non:\n pull_request:\n branches:\n - 'master'\n\njobs:\n build:\n\n runs-on: ubuntu-latest\n strategy:\n matrix:\n python-version: ['3.9', '3.10', '3.11', '3.12']\n\n steps:\n - uses: actions/checkout@v2\n - name: Set up Python ${{ matrix.python-version }}\n uses: actions/setup-python@v2\n with:\n python-version: ${{ matrix.python-version }}\n\n - name: Install dependencies\n run: |\n python -m pip install --upgrade pip\n python -m pip install requests\n\n - name: Lint with Pylint\n run: |\n pip install pylint\n pylint mercadopago\n pylint --rcfile=tests/.pylintrc tests\n\n - name: Lint with Isort\n run: |\n pip install isort\n isort .\n\n - name: Test with unittest\n run: |\n python -m unittest discover tests/\n env:\n ACCESS_TOKEN: ${{secrets.ACCESS_TOKEN}}\n" }, { "path": ".gitignore", "content": "*.py[cod]\n*.pyc\n.DS_Store\n.idea\nvenv\n\n# C extensions\n*.so\n\n# Packages\n*.egg\n*.egg-info\ndist\nbuild\neggs\nparts\nbin\nvar\nsdist\ndevelop-eggs\n.installed.cfg\nlib64\n__pycache__\n\n# Installer logs\npip-log.txt\n\n# Unit test / coverage reports\n.coverage\n.tox\nnosetests.xml\n\n# Translations\n*.mo\n\n# Mr Developer\n.mr.developer.cfg\n.project\n.pydevproject\n\n# Demo\nimg/\nPRESS.md\n\n# vscode\n.vscode\n" }, { "path": ".pre-commit-config.yaml", "content": "repos:\n - repo: https://github.com/melisource/fury_websec-git-hooks\n rev: v2.0.0\n hooks:\n - id: pre_commit_hook\n stages: [commit]\n - id: post_commit_hook\n stages: [post-commit]\n \n - repo: https://github.com/melisource/fury_datasec-git-hooks\n rev: 1.2.2\n hooks:\n - id: pre_commit_hook\n stages: [commit]\n - id: post_commit_hook\n stages: [post-commit]\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as\ncontributors and maintainers pledge to make participation in \nour community a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression,\nlevel of experience, education, socio-economic status, nationality, personal\nappearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment\ninclude:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or\nadvances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment of individuals or the company\n* Publishing others' private information, such as a physical or electronic\naddress, without explicit permission\n* Other conduct that could reasonably be considered inappropriate in a\nprofessional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable\nbehavior and are expected to take appropriate and fair corrective action in\nresponse to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or\nreject comments, commits, code, wiki edits, issues, and other contributions\nthat are not aligned with this Code of Conduct, as well as temporarily or\npermanently ban any contributor for other behavior deemed inappropriate, threatening, offensive, or harmful with or without prior notice..\n\n\n## Scope\n\nThis Code of Conduct applies within all project spaces and it also applies when\nan individual is representing the project or its community in public spaces.\nExamples of representing a project or community include using an official\nproject email address, posting via an official social media account, or acting\nas an appointed representative at an online or offline event. Representation of\na project may be further defined and clarified by project maintainers.\n\nThis Code of Conduct also applies outside the project spaces when there is a\nreasonable belief that an individual's behavior may have a negative impact on\nthe project, the company or the community.\n\n## Enforcement\n\nProject maintainers who do not follow or enforce the Code of Conduct in good\nfaith may face temporary or permanent repercussions as determined by other\nmembers of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,\navailable at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see\nhttps://www.contributor-covenant.org/faq" }, { "path": "CODING_GUIDELINES.md", "content": "# Coding Guidelines\n\nThe Mercado Pago Python SDK is a collaborative effort from the start. The SDK team thinks that contributions from different developer will enrich it's feature set and make it more relevant to the community.\n\nHowever; absorbing all contributions as-is, while expedient, might lead to difficulties in maintenance of the codebase is left unchecked. Collaborative codebases often establish guidelines for contributors to ensure code remains maintainable over time. The effort to maintain the SDK is no different in this regard so a bit of guidance is in order.\n\nThe purpose of this guide is to set a baseline for contributions. These guidelines are not intended to limit the tools at your disposal nor to rewire the way you think but rather to encourage good neighbor behavior.\n\n## Language Guidelines\n\nWe use **english** language. This is to be consistent everywhere, and to be considerate with developers that do not speak our native language.\n\nTherefore: source code, comments, documentation, commit messages, review comments, and any other kind of contribution *MUST* use english language.\n\nTypos are unavoidable, but try to reduce them by using a spellchecker. Most IDEs can be configured to run one automatically.\n\n## Code Guidelines\n\n* Set your IDE to follow the [`.editorconfig`](https://editorconfig.org/) in each repository.\n* Follow the [PEP 8 Style Guide](https://pep8.org/).\n\nGenerally speaking, be conscious when contributing and try following the same style that the code in the SDK already has. If you have any doubts, just ask us!\n\nThis rules will be enforced automatically when making a pull requests, and checks will fail if you do not follow them, resulting in your contribution being automatically rejected until fixed.\n\n## Comment Guidelines\n\nComments in code are a hard thing to write, not because the words are difficult to produce but because it is hard to make relevant comments. Too much of it and people do not read comments (and it obfuscates code reading) and too little of it gives you no recourse but to read large portions of codebase to get insight as to what a feature/codeblock is doing. Both situations are undesirable and efforts should be made at all time to have a please comment reading experience\n\nAs a general rule you would have to comment on decisions you made while coding that are not part of any specification.\n\nIn particular you should always comment any decision that:\n\n* Departs from common wisdom or convention (The **why's** are necessary).\n* Takes a significant amount of time to produce. A good rule of thumb here is that if you spent more than 1 hour thinking on how to produce a fragment of code that took 2 minutes of wrist time to write you should document your thinking to aid reader and allow for validation.\n* Need to preserve properties of the implementation. This is the case of performance sensitive portions of the codebase, goroutines synchronization, implementations of security primitives, congestion control algorithms, etc.\n\nAs a general rule of what not to comment you should avoid:\n\n* Commenting on structure of programs that is already part of a convention, specified or otherwise.\n* Having pedantic explanations of behavior that can be found by immediate examination of the surrounding code artifacts.\n* Commenting on behavior you cannot attest.\n\n### Branching Guidelines\n\nCurrently `master` is our only long term branch, below a few suggestions of short term branches naming:\n\n* `hotfix/something-needs-fix`: Small routine patches in code to features already there.\n* `feature/something-new`: A new feature or a change in a existent feature. Beware of breaking changes that would require a major version bump.\n* `doc/improves-documentation-for-this-feature`: If you add or change documentation with no impact to the source code.\n\n### Git Guidelines\n\nAll commits **SHOULD** follow the [seven rules of a great Git commit message](https://chris.beams.io/posts/git-commit):\n\n1. Separate subject from body with a blank line.\n2. Limit the subject line to 72 characters.\n3. Capitalize the subject line.\n4. Do not end the subject line with a period.\n5. Use the imperative mood in the subject line.\n6. Wrap the body at 72 characters.\n7. Use the body to explain what and why vs. how.\n\nCommits such as \"fix tests\", \"now it's working\" and many other common messages we find usually in code **WON'T** be accepted.\n\nIdeally we would like to enforce these rules, but we are realistic and understand that it might be a big change for some people. So unless deviating heavily from what was stated we might accept your commits even if not following these rules perfectly.\n\nPlease avoid taking to much time to deliver code, and always [rebase](https://git-scm.com/docs/git-rebase) your code to avoid reverse merge commits.\n\nWhen reviewing, check if the PR adheres to [PEP 8 Style Guide](https://pep8.org/).\n" }, { "path": "CONTRIBUTING.md", "content": "# Contributing to the Mercado Pago Python SDK\n\nThank you for your interest in contributing to the Mercado Pago Python SDK!\n\n## How to contribute\n\nIn order to contribute to the Mercado Pago Python SDK effectively we provide guidelines to address common case for contributions. Presently we have guides for the following type of changes.\n\n* Request For Change (RFC) / Feature Request: These are suggestions / requests for features the SDK currently does not have. The SDK team evaluates these requests for adequacy / relevance / capacity and overall architectural consistency.\n* Bug Reports: These are reports of non compliant behavior with the SDK specification and other blatantly wrong behavior of the Mercado Pago Python SDK.\n\nIn addition to contributing in the form of Bug Reports and RFCs it is also possible to contribute directly in code with a Pull Request (PR). In the case of a Pull Request you should also indicate the nature of the Pull Request (Feature/Bug/etc.) to help the team asses the Pull Request. If you are enthusiastic about a particular Feature being added or a bug being fixed, a PR is often the quickest way to promote your change as the team does not have to allocate as much resources to process the contribution.\n\nIn the case of PRs it is often best to consult with the SDK team before embarking on a PR, specially if it's a beefy one. Spending time on a PR that might later be rejected because major discrepancies with vision or competing contributions is an uncomfortable outcome for all involved people. Remember the SDK team with privilege overall consistency and progress over any one particular contribution.\n\n## Coding Guidance\n\nAll contributions *MUST* follow the [Coding Guidelines](CODING_GUIDELINES.md). Contributions that fail to follow this guidelines will be disregarded and told to make the required modifications to do so.\n\n## Request For Change / Feature Request\n\nGenerally speaking an RFC is needed when you want to add a new feature or change an existing one in an incompatible way that might result in a major version bump to the toolkit.\n\nThough it seems a little bureaucratic, the process is in place in order to avoid frustration of a potential contributor by making the discussions take place before any code is written. Once the design and direction is fully agreed then the contributor can work peacefully knowing that their change will be committed.\n\nAs of this moment all you need to do is create an issue and use the [Feature Request Template](.github/ISSUE_TEMPLATE/feature_request.md).\n\nPlease prepend your issue title with `[RFC]` so that's easier to filter.\n\n## Bug Reports\n\nBugs are a reality in software. We can't fix what we don't know about, so please report liberally. If you're not sure if something is a bug or not, feel free to file it anyway.\n\nBefore reporting a bug, please search existing issues and pull requests, as it's possible that someone else has already reported your error. In the off case that you find your issue as fixed/closed, please add a reference to it on your new one.\n\nYour issue should contain a title and a clear description of the issue. You should also include as much relevant information as possible and a code sample that demonstrates the issue. The goal of a bug report is to make it easy for yourself - and others - to replicate the bug and develop a fix.\n\nOpening an issue is as easy as following [this link](https://github.com/mercadopago/sdk-dotnet/issues/new) and filling out the given template.\n\nBug reports may also be sent in the form of a [pull request](#pull-request) containing a failing test.\n\n## Pull Request\n\nFirst and foremost: Source code, documentation, commit messages, review comments, and any other kind of contribution must *MUST* follow the [Coding Guidelines](CODING_GUIDELINES.md).\n\nWe use the \"fork and pull\" model [described here](https://help.github.com/articles/about-collaborative-development-models/), where contributors push changes to their personal fork and create pull requests to bring those changes into the source repository.\n\nYour basic steps to get going:\n\n* Fork the corresponding toolkit repository and create a branch from master for the issue you are working on.\n* Commit as you go following our git conventions.\n* Include tests that cover all non-trivial code. The existing tests should provide a template on how to test the toolkit correctly.\n* Make sure all test passes.\n* All code changes are expected to comply with the formatting style.\n* Push your commits to GitHub and create a pull request against the corresponding toolkit component master branch.\n\nIf taking to much time to deliver code, **always** [rebase](https://git-scm.com/docs/git-rebase) towards `master` before asking for a review, and avoid reverse merge commits.\n" }, { "path": "LICENSE", "content": "MIT License\n\nCopyright (c) 2021 MercadoPago Developers\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE." }, { "path": "MANIFEST.in", "content": "include README.rst\ninclude LICENSE" }, { "path": "README.md", "content": "# Mercado Pago SDK for Python\n\n[![PyPI](https://img.shields.io/pypi/v/mercadopago.svg)](https://pypi.python.org/pypi/mercadopago)\n[![PyPI Downloads](https://img.shields.io/pypi/dm/mercadopago.svg)](https://pypi.python.org/pypi/mercadopago)\n[![APM](https://img.shields.io/apm/l/vim-mode)](https://github.com/mercadopago/sdk-python)\n\nThis library provides developers with a simple set of bindings to help you integrate Mercado Pago API to a website and start receiving payments.\n\n## ๐Ÿ’ก Requirements\n\nPython 3 or higher.\n\n## ๐Ÿ“ฒ Installation \n\nRun ```pip3 install mercadopago```\n\n## ๐ŸŒŸ Getting Started\n\nFirst time using Mercado Pago? Create your [Mercado Pago account](https://www.mercadopago.com).\n\nCopy your `Access Token` in the [credentials panel](https://www.mercadopago.com/developers/panel/credentials) and replace the text `YOUR_ACCESS_TOKEN` with it.\n\n### Simple usage\n \n```python\nimport mercadopago\n\nsdk = mercadopago.SDK(\"YOUR_ACCESS_TOKEN\")\n\nrequest_options = mercadopago.config.RequestOptions()\nrequest_options.custom_headers = {\n 'x-idempotency-key': ''\n}\n\npayment_data = {\n \"transaction_amount\": 100,\n \"token\": \"CARD_TOKEN\",\n \"description\": \"Payment description\",\n \"payment_method_id\": 'visa',\n \"installments\": 1,\n \"payer\": {\n \"email\": 'test_user_123456@testuser.com'\n }\n}\nresult = sdk.payment().create(payment_data, request_options)\npayment = result[\"response\"]\n\nprint(payment)\n```\n\n### Per-request configuration\n\nAll methods that make API calls accept an optional `RequestOptions` object. This can be used to configure some special options of the request, such as changing credentials or custom headers.\n\n```python\nimport mercadopago\nfrom mercadopago.config import RequestOptions\n\nrequest_options = RequestOptions(access_token='YOUR_ACCESS_TOKEN')\n# ...\n\nresult = sdk.payment().create(payment_data, request_options)\npayment = result[\"response\"]\n```\n\n## ๐Ÿ“š Documentation \n\nVisit our Dev Site for further information regarding:\n - [APIs](https://www.mercadopago.com/developers/en/reference)\n - [Checkout Pro](https://www.mercadopago.com/developers/en/guides/online-payments/checkout-pro/introduction)\n - [Checkout API](https://www.mercadopago.com/developers/en/guides/online-payments/checkout-api/introduction)\n - [Web Tokenize Checkout](https://www.mercadopago.com/developers/en/guides/online-payments/web-tokenize-checkout/introduction)\n\nCheck our official code reference to explore all available functionalities.\n\n## ๐Ÿค Contributing\n\nAll contributions are welcome, ranging from people wanting to triage issues, others wanting to write documentation, to people wanting to contribute code.\n\nPlease read and follow our [contribution guidelines](CONTRIBUTING.md). Contributions not following this guidelines will be disregarded. The guidelines are in place to make all of our lives easier and make contribution a consistent process for everyone.\n\n## โค๏ธ Support\n\nIf you require technical support, please contact our support team at [developers.mercadopago.com](https://developers.mercadopago.com).\n\n## ๐Ÿป License\n\n```\nMIT license. Copyright (c) 2021 - Mercado Pago / Mercado Libre\nFor more information, see the LICENSE file.\n```\n" }, { "path": "SUPPORT.md", "content": "# ๐Ÿ†˜ Support and Help\n\n> **Quick guide:** Have a bug? โ†’ [Bug Report](../../issues/new/choose) | Questions? โ†’ [Question](../../issues/new/choose) | New idea? โ†’ [Feature Request](../../issues/new/choose)\n\n---\n\n## ๐ŸŽฏ Quick Decision Guide\n\n| If you need... | Then... |\n|----------------|---------|\n| ๐Ÿ’ฌ Question about how to use the SDK | [Create Question](../../issues/new/choose) |\n| ๐Ÿ› Report an error or bug | [Create Bug Report](../../issues/new/choose) |\n| โœจ Propose new feature | [Create Feature Request](../../issues/new/choose) |\n| ๐Ÿ’ณ Problem with your MP account | [Official MP Support - ES ](https://www.mercadopago.com.co/developers/en/support/center)- [Official MP Support - PT ](https://www.mercadopago.com.co/developers/pt/support/center) |\n \n---\n\n## ๐Ÿ“š Before Creating an Issue\n\n**Search first, ask later:**\n\n1. **[Official Documentation](https://www.mercadopago.com/developers/es/docs)** - Most questions are answered here\n2. **[Closed Issues](../../issues?q=is%3Aissue+is%3Aclosed)** - Your problem may be solved\n3. **[Open Issues](../../issues?q=is%3Aissue+is%3Aopen)** - Your problem may be already reported\n---\n\n## ๐Ÿ’ฌ How to Report Issues\n\n### 1. For Questions ๐Ÿ’ฌ\n\n**When to use?** Doubts about usage, configuration, or best practices.\n\n**Steps:**\n\n1. Search in [closed questions](../../issues?q=is%3Aissue+is%3Aclosed+label%3Aquestion)\n2. [Create new question](../../issues/new/choose)\n3. **Include:** SDK version, country, environment, code example.\n\n### 2. For Bugs ๐Ÿ›\n\n**When to use?** Errors, unexpected behavior and/or crashes.\n\n**Steps:**\n\n1. Verify [latest version](../../releases/latest)\n2. Search in [existing bugs](../../issues?q=is%3Aissue+label%3Abug)\n3. [Report bug](../../issues/new/choose)\n4. **Include:** reproducible steps, logs, environment, SDK version.\n\n### 3. For Features โœจ\n\n**When to use?** Propose improvements or new features\n\n**Steps:**\n\n1. Search in [feature requests](../../issues?q=is%3Aissue+label%3Afeature%20request)\n2. [Propose feature](../../issues/new/choose)\n3. **Explain:** problem it solves, use cases, benefit.\n\n### 4. To Contribute ๐Ÿค\n\n**Want to help?** Read [CONTRIBUTING.md](./CONTRIBUTING.md)\n\n---\n\n## ๐Ÿ”’ Security\n\n### โš ๏ธ NEVER Share in Public Issues:\n\n- โŒ Access tokens or production credentials\n- โŒ Client IDs / Client Secrets\n- โŒ Customer or card data\n- โŒ Personally Identifiable Information (PII)\n\n> **โš ๏ธ IMPORTANT:** Issues with real data will be closed and reported immediately.\n\n---\n\n## ๐ŸŒŽ Official Mercado Pago SDK Support\n\n### โšก GitHub Issues Scope\n\n**GitHub Issues is ONLY for SDK technical support.**\n\nโœ… **Use GitHub for:**\n\n- SDK bugs\n- Questions about SDK usage\n- SDK features\n- Code contributions\n\nโŒ **DO NOT use GitHub for:**\n\n- Problems with your MP account\n- Specific transactions or payments\n- Commercial or billing topics\n- Homologation/certification\n- Account access or credentials\n- Webhook configuration in your account\n\n### ๐Ÿข Contact Official MP Support for:\n\n[**๐Ÿ”— Official Mercado Pago Support - ES**](https://www.mercadopago.com.co/developers/es/support/center)\n[**๐Ÿ”— Official Mercado Pago Support - PT**](https://www.mercadopago.com.co/developers/pt/support/center)\n\n- โœ‰๏ธ Account problems\n- ๐Ÿ’ณ Transactions and payments\n- ๐Ÿค Commercial topics\n- ๐Ÿ“‹ Homologation\n- ๐Ÿ” Account access\n- ๐ŸŒ Webhooks in your account\n- ๐Ÿ“Š Reports and statistics\n\n---\n\n## ๐Ÿ”— Resources and Contacts\n\n### Documentation\n\n- **[Official Documentation](https://www.mercadopago.com/developers/es/docs)** - Complete guides\n- **[API Reference](https://www.mercadopago.com/developers/en/reference)** - API reference\n- **[SDKs](https://www.mercadopago.com/developers/en/docs/sdks-library/server-side)** - Other SDKs\n\n### Support\n\n- **[GitHub Issues](../../issues/new/choose)** - SDK technical support\n\n### Community channels\n\n- **[Discord](https://discord.gg/96nqqpaycN)** - Community channel\n- **[Newsletter](https://www.mercadopago.com/developers/panel/contact)** - Mercado Pago Newsletter\n- **[Status Page](https://status.mercadopago.com/)** - Service status\n\n---\n\n## ๐Ÿ’ก Tips for Getting Quick Help\n\n1. **๐Ÿ” Search first** - Saves everyone time\n2. **๐Ÿ“ Be specific** - \"Error 400 on POST /payments\" vs \"It doesn't work\"\n3. **๐Ÿ’ป Reproducible code** - Minimal and complete example\n4. **๐Ÿ“‹ Follow templates** - They're designed to help you\n5. **๐Ÿšซ No sensitive data** - Protect your security\n6. **๐Ÿค Be respectful** - We're all part of the community\n\n---\n\n๐Ÿ’™ **Thank you for being part of the Mercado Pago developer community!**" }, { "path": "docs/config/config.html", "content": "\n\n\n\n\n\nmercadopago.config.config API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.config.config

\n
\n
\n

Module: config

\n
\n\nExpand source code\n\n
"""\nModule: config\n"""\nimport platform\n\n\nclass Config:\n    """\n    General infos of your SDK\n    """\n\n    def __init__(self):\n        self.__version = "2.2.0"\n        self.__user_agent = "MercadoPago Python SDK v" + self.__version\n        self.__product_id = "bc32bpftrpp001u8nhlg"\n        self.__tracking_id = "platform:" + platform.python_version()\n        self.__tracking_id += ",type:SDK" + self.__version + ",so;"\n\n    __api_base_url = "https://api.mercadopago.com"\n    __mime_json = "application/json"\n    __mime_form = "application/x-www-form-urlencoded"\n\n    @property\n    def version(self):\n        """\n        Sets the attribute value of version\n        """\n        return self.__version\n\n    @property\n    def user_agent(self):\n        """\n        Sets the attribute value of user agent\n        """\n        return self.__user_agent\n\n    @property\n    def product_id(self):\n        """\n        Sets the attribute value of product id\n        """\n        return self.__product_id\n\n    @property\n    def tracking_id(self):\n        """\n        Sets the attribute value of tracking id\n        """\n        return self.__tracking_id\n\n    @property\n    def api_base_url(self):\n        """\n        Sets the attribute value of api base url\n        """\n        return self.__api_base_url\n\n    @property\n    def mime_json(self):\n        """\n        Sets the attribute value of mime json\n        """\n        return self.__mime_json\n\n    @property\n    def mime_form(self):\n        """\n        Sets the attribute value of mime form\n        """\n        return self.__mime_form
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass Config\n
\n
\n

General infos of your SDK

\n
\n\nExpand source code\n\n
class Config:\n    """\n    General infos of your SDK\n    """\n\n    def __init__(self):\n        self.__version = "2.2.0"\n        self.__user_agent = "MercadoPago Python SDK v" + self.__version\n        self.__product_id = "bc32bpftrpp001u8nhlg"\n        self.__tracking_id = "platform:" + platform.python_version()\n        self.__tracking_id += ",type:SDK" + self.__version + ",so;"\n\n    __api_base_url = "https://api.mercadopago.com"\n    __mime_json = "application/json"\n    __mime_form = "application/x-www-form-urlencoded"\n\n    @property\n    def version(self):\n        """\n        Sets the attribute value of version\n        """\n        return self.__version\n\n    @property\n    def user_agent(self):\n        """\n        Sets the attribute value of user agent\n        """\n        return self.__user_agent\n\n    @property\n    def product_id(self):\n        """\n        Sets the attribute value of product id\n        """\n        return self.__product_id\n\n    @property\n    def tracking_id(self):\n        """\n        Sets the attribute value of tracking id\n        """\n        return self.__tracking_id\n\n    @property\n    def api_base_url(self):\n        """\n        Sets the attribute value of api base url\n        """\n        return self.__api_base_url\n\n    @property\n    def mime_json(self):\n        """\n        Sets the attribute value of mime json\n        """\n        return self.__mime_json\n\n    @property\n    def mime_form(self):\n        """\n        Sets the attribute value of mime form\n        """\n        return self.__mime_form
\n
\n

Instance variables

\n
\n
var api_base_url
\n
\n

Sets the attribute value of api base url

\n
\n\nExpand source code\n\n
@property\ndef api_base_url(self):\n    """\n    Sets the attribute value of api base url\n    """\n    return self.__api_base_url
\n
\n
\n
var mime_form
\n
\n

Sets the attribute value of mime form

\n
\n\nExpand source code\n\n
@property\ndef mime_form(self):\n    """\n    Sets the attribute value of mime form\n    """\n    return self.__mime_form
\n
\n
\n
var mime_json
\n
\n

Sets the attribute value of mime json

\n
\n\nExpand source code\n\n
@property\ndef mime_json(self):\n    """\n    Sets the attribute value of mime json\n    """\n    return self.__mime_json
\n
\n
\n
var product_id
\n
\n

Sets the attribute value of product id

\n
\n\nExpand source code\n\n
@property\ndef product_id(self):\n    """\n    Sets the attribute value of product id\n    """\n    return self.__product_id
\n
\n
\n
var tracking_id
\n
\n

Sets the attribute value of tracking id

\n
\n\nExpand source code\n\n
@property\ndef tracking_id(self):\n    """\n    Sets the attribute value of tracking id\n    """\n    return self.__tracking_id
\n
\n
\n
var user_agent
\n
\n

Sets the attribute value of user agent

\n
\n\nExpand source code\n\n
@property\ndef user_agent(self):\n    """\n    Sets the attribute value of user agent\n    """\n    return self.__user_agent
\n
\n
\n
var version
\n
\n

Sets the attribute value of version

\n
\n\nExpand source code\n\n
@property\ndef version(self):\n    """\n    Sets the attribute value of version\n    """\n    return self.__version
\n
\n
\n
\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/config/index.html", "content": "\n\n\n\n\n\nmercadopago.config API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.config

\n
\n
\n

Module: config/init.py

\n
\n\nExpand source code\n\n
"""\nModule: config/__init__.py\n"""\nfrom mercadopago.config.config import Config\nfrom mercadopago.config.request_options import RequestOptions\n\n\n__all__ = (\n    'Config',\n    'RequestOptions',\n)
\n
\n
\n
\n

Sub-modules

\n
\n
mercadopago.config.config
\n
\n

Module: config

\n
\n
mercadopago.config.request_options
\n
\n

Module: request_options

\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass Config\n
\n
\n

General infos of your SDK

\n
\n\nExpand source code\n\n
class Config:\n    """\n    General infos of your SDK\n    """\n\n    def __init__(self):\n        self.__version = "2.2.0"\n        self.__user_agent = "MercadoPago Python SDK v" + self.__version\n        self.__product_id = "bc32bpftrpp001u8nhlg"\n        self.__tracking_id = "platform:" + platform.python_version()\n        self.__tracking_id += ",type:SDK" + self.__version + ",so;"\n\n    __api_base_url = "https://api.mercadopago.com"\n    __mime_json = "application/json"\n    __mime_form = "application/x-www-form-urlencoded"\n\n    @property\n    def version(self):\n        """\n        Sets the attribute value of version\n        """\n        return self.__version\n\n    @property\n    def user_agent(self):\n        """\n        Sets the attribute value of user agent\n        """\n        return self.__user_agent\n\n    @property\n    def product_id(self):\n        """\n        Sets the attribute value of product id\n        """\n        return self.__product_id\n\n    @property\n    def tracking_id(self):\n        """\n        Sets the attribute value of tracking id\n        """\n        return self.__tracking_id\n\n    @property\n    def api_base_url(self):\n        """\n        Sets the attribute value of api base url\n        """\n        return self.__api_base_url\n\n    @property\n    def mime_json(self):\n        """\n        Sets the attribute value of mime json\n        """\n        return self.__mime_json\n\n    @property\n    def mime_form(self):\n        """\n        Sets the attribute value of mime form\n        """\n        return self.__mime_form
\n
\n

Instance variables

\n
\n
var api_base_url
\n
\n

Sets the attribute value of api base url

\n
\n\nExpand source code\n\n
@property\ndef api_base_url(self):\n    """\n    Sets the attribute value of api base url\n    """\n    return self.__api_base_url
\n
\n
\n
var mime_form
\n
\n

Sets the attribute value of mime form

\n
\n\nExpand source code\n\n
@property\ndef mime_form(self):\n    """\n    Sets the attribute value of mime form\n    """\n    return self.__mime_form
\n
\n
\n
var mime_json
\n
\n

Sets the attribute value of mime json

\n
\n\nExpand source code\n\n
@property\ndef mime_json(self):\n    """\n    Sets the attribute value of mime json\n    """\n    return self.__mime_json
\n
\n
\n
var product_id
\n
\n

Sets the attribute value of product id

\n
\n\nExpand source code\n\n
@property\ndef product_id(self):\n    """\n    Sets the attribute value of product id\n    """\n    return self.__product_id
\n
\n
\n
var tracking_id
\n
\n

Sets the attribute value of tracking id

\n
\n\nExpand source code\n\n
@property\ndef tracking_id(self):\n    """\n    Sets the attribute value of tracking id\n    """\n    return self.__tracking_id
\n
\n
\n
var user_agent
\n
\n

Sets the attribute value of user agent

\n
\n\nExpand source code\n\n
@property\ndef user_agent(self):\n    """\n    Sets the attribute value of user agent\n    """\n    return self.__user_agent
\n
\n
\n
var version
\n
\n

Sets the attribute value of version

\n
\n\nExpand source code\n\n
@property\ndef version(self):\n    """\n    Sets the attribute value of version\n    """\n    return self.__version
\n
\n
\n
\n
\n
\nclass RequestOptions\n(access_token=None, connection_timeout=60.0, custom_headers=None, corporation_id=None, integrator_id=None, platform_id=None, max_retries=3)\n
\n
\n

This object hold all configurations that will be used in ur REST call.

\n

All here u can customize as well add params in the requisition header (custom_headers)

\n

Initialize

\n

Args

\n
\n
access_token : str, optional
\n
Your User Access Token. Defaults to None.
\n
connection_timeout : float, optional
\n
Time to timeout the REST call. Defaults to 60.0.
\n
custom_headers : dict, optional
\n
A Dict with params to be added to the requests params.
\n
Defaults to None.
\n
corporation_id : str, optional
\n
Your Corporation ID if any. Defaults to None.
\n
integrator_id : str, optional
\n
Your Integrator ID if any. Defaults to None.
\n
platform_id : str, optional
\n
Your Platform ID if any. Defaults to None.
\n
max_retries : int, optional
\n
How many retries must be done in case of fail.
\n
\n

Defaults to 3.

\n

Raises

\n
\n
ValueError
\n
Param access_token must be a String
\n
ValueError
\n
Param connection_timeout must be a Float
\n
ValueError
\n
Param custom_headers must be a Dictionary
\n
ValueError
\n
Param corporation_id must be a String
\n
ValueError
\n
Param integrator_id must be a String
\n
ValueError
\n
Param platform_id must be a String
\n
ValueError
\n
Param max_retries must be an Integer
\n
\n
\n\nExpand source code\n\n
class RequestOptions:  # pylint: disable=too-many-instance-attributes\n\n    """This object hold all configurations that will be used in ur REST call.\n\n    All here u can customize as well add params in the requisition header (custom_headers)\n    """\n\n    __access_token = None\n    __connection_timeout = None\n    __custom_headers = None\n    __max_retries = None\n    __corporation_id = None\n    __integrator_id = None\n    __platform_id = None\n\n    def __init__(  # pylint: disable=too-many-arguments\n        self,\n        access_token=None,\n        connection_timeout=60.0,\n        custom_headers=None,\n        corporation_id=None,\n        integrator_id=None,\n        platform_id=None,\n        max_retries=3,\n    ):\n        """Initialize\n\n        Args:\n            access_token (str, optional): Your User Access Token. Defaults to None.\n            connection_timeout (float, optional): Time to timeout the REST call. Defaults to 60.0.\n            custom_headers (dict, optional): A Dict with params to be added to the requests params.\n            Defaults to None.\n            corporation_id (str, optional): Your Corporation ID if any. Defaults to None.\n            integrator_id (str, optional): Your Integrator ID if any. Defaults to None.\n            platform_id (str, optional): Your Platform ID if any. Defaults to None.\n            max_retries (int, optional): How many retries must be done in case of fail.\n            Defaults to 3.\n\n        Raises:\n            ValueError: Param access_token must be a String\n            ValueError: Param connection_timeout must be a Float\n            ValueError: Param custom_headers must be a Dictionary\n            ValueError: Param corporation_id must be a String\n            ValueError: Param integrator_id must be a String\n            ValueError: Param platform_id must be a String\n            ValueError: Param max_retries must be an Integer\n        """\n\n        if access_token is not None:\n            self.access_token = access_token\n        if connection_timeout is not None:\n            self.connection_timeout = connection_timeout\n        if custom_headers is not None:\n            self.custom_headers = custom_headers\n        if max_retries is not None:\n            self.max_retries = max_retries\n        if corporation_id is not None:\n            self.corporation_id = corporation_id\n        if integrator_id is not None:\n            self.integrator_id = integrator_id\n        if platform_id is not None:\n            self.platform_id = platform_id\n\n        self.__config = Config()\n\n    def get_headers(self):\n        """\n        Sets the attribute values of headers\n        """\n        headers = {"Authorization": "Bearer " + self.__access_token,\n                   "x-product-id": self.__config.product_id,\n                   "x-tracking-id": self.__config.tracking_id,\n                   "x-idempotency-key": str(uuid.uuid4().int),\n                   "User-Agent": self.__config.user_agent,\n                   "Accept": self.__config.mime_json}\n\n        if self.__corporation_id is not None:\n            headers["x-corporation-id"] = self.__corporation_id\n\n        if self.__integrator_id is not None:\n            headers["x-integrator-id"] = self.__integrator_id\n\n        if self.__platform_id is not None:\n            headers["x-platform-id"] = self.__platform_id\n\n        if self.__custom_headers is not None:\n            headers.update(self.__custom_headers)\n\n        return headers\n\n    @property\n    def access_token(self):\n        """\n        Sets the attribute value and validates access_token\n        """\n        return self.__access_token\n\n    @access_token.setter\n    def access_token(self, value):\n        if not isinstance(value, str):\n            raise ValueError("Param access_token must be a String")\n        self.__access_token = value\n\n    @property\n    def connection_timeout(self):\n        """\n        Sets the attribute value and validates connection timeout\n        """\n        return self.__connection_timeout\n\n    @connection_timeout.setter\n    def connection_timeout(self, value):\n        if not isinstance(value, float):\n            raise ValueError("Param connection_timeout must be a Float")\n        self.__connection_timeout = value\n\n    @property\n    def corporation_id(self):\n        """\n        Sets the attribute value and validates corporation id\n        """\n        return self.__corporation_id\n\n    @corporation_id.setter\n    def corporation_id(self, value):\n        if not isinstance(value, str):\n            raise ValueError("Param corporation_id must be a String")\n        self.__corporation_id = value\n\n    @property\n    def custom_headers(self):\n        """\n        Sets the attribute value and validates custom headers\n        """\n        return self.__custom_headers\n\n    @custom_headers.setter\n    def custom_headers(self, value):\n        if not isinstance(value, dict):\n            raise ValueError("Param custom_headers must be a Dictionary")\n        self.__custom_headers = value\n\n    @property\n    def integrator_id(self):\n        """\n        Sets the attribute value and validates integrator id\n        """\n        return self.__integrator_id\n\n    @integrator_id.setter\n    def integrator_id(self, value):\n        if not isinstance(value, str):\n            raise ValueError("Param integrator_id must be a String")\n        self.__integrator_id = value\n\n    @property\n    def max_retries(self):\n        """\n        Sets the attribute value and validates max retries\n        """\n        return self.__max_retries\n\n    @max_retries.setter\n    def max_retries(self, value):\n        if not isinstance(value, int):\n            raise ValueError("Param max_retries must be an Integer")\n        self.__max_retries = value\n\n    @property\n    def platform_id(self):\n        """\n        Sets the attribute value and validates platform id\n        """\n        return self.__platform_id\n\n    @platform_id.setter\n    def platform_id(self, value):\n        if not isinstance(value, str):\n            raise ValueError("Param platform_id must be a String")\n        self.__platform_id = value
\n
\n

Instance variables

\n
\n
var access_token
\n
\n

Sets the attribute value and validates access_token

\n
\n\nExpand source code\n\n
@property\ndef access_token(self):\n    """\n    Sets the attribute value and validates access_token\n    """\n    return self.__access_token
\n
\n
\n
var connection_timeout
\n
\n

Sets the attribute value and validates connection timeout

\n
\n\nExpand source code\n\n
@property\ndef connection_timeout(self):\n    """\n    Sets the attribute value and validates connection timeout\n    """\n    return self.__connection_timeout
\n
\n
\n
var corporation_id
\n
\n

Sets the attribute value and validates corporation id

\n
\n\nExpand source code\n\n
@property\ndef corporation_id(self):\n    """\n    Sets the attribute value and validates corporation id\n    """\n    return self.__corporation_id
\n
\n
\n
var custom_headers
\n
\n

Sets the attribute value and validates custom headers

\n
\n\nExpand source code\n\n
@property\ndef custom_headers(self):\n    """\n    Sets the attribute value and validates custom headers\n    """\n    return self.__custom_headers
\n
\n
\n
var integrator_id
\n
\n

Sets the attribute value and validates integrator id

\n
\n\nExpand source code\n\n
@property\ndef integrator_id(self):\n    """\n    Sets the attribute value and validates integrator id\n    """\n    return self.__integrator_id
\n
\n
\n
var max_retries
\n
\n

Sets the attribute value and validates max retries

\n
\n\nExpand source code\n\n
@property\ndef max_retries(self):\n    """\n    Sets the attribute value and validates max retries\n    """\n    return self.__max_retries
\n
\n
\n
var platform_id
\n
\n

Sets the attribute value and validates platform id

\n
\n\nExpand source code\n\n
@property\ndef platform_id(self):\n    """\n    Sets the attribute value and validates platform id\n    """\n    return self.__platform_id
\n
\n
\n
\n

Methods

\n
\n
\ndef get_headers(self)\n
\n
\n

Sets the attribute values of headers

\n
\n\nExpand source code\n\n
def get_headers(self):\n    """\n    Sets the attribute values of headers\n    """\n    headers = {"Authorization": "Bearer " + self.__access_token,\n               "x-product-id": self.__config.product_id,\n               "x-tracking-id": self.__config.tracking_id,\n               "x-idempotency-key": str(uuid.uuid4().int),\n               "User-Agent": self.__config.user_agent,\n               "Accept": self.__config.mime_json}\n\n    if self.__corporation_id is not None:\n        headers["x-corporation-id"] = self.__corporation_id\n\n    if self.__integrator_id is not None:\n        headers["x-integrator-id"] = self.__integrator_id\n\n    if self.__platform_id is not None:\n        headers["x-platform-id"] = self.__platform_id\n\n    if self.__custom_headers is not None:\n        headers.update(self.__custom_headers)\n\n    return headers
\n
\n
\n
\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/config/request_options.html", "content": "\n\n\n\n\n\nmercadopago.config.request_options API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.config.request_options

\n
\n
\n

Module: request_options

\n
\n\nExpand source code\n\n
"""\nModule: request_options\n"""\nimport uuid\n\nfrom .config import Config\n\n\nclass RequestOptions:  # pylint: disable=too-many-instance-attributes\n\n    """This object hold all configurations that will be used in ur REST call.\n\n    All here u can customize as well add params in the requisition header (custom_headers)\n    """\n\n    __access_token = None\n    __connection_timeout = None\n    __custom_headers = None\n    __max_retries = None\n    __corporation_id = None\n    __integrator_id = None\n    __platform_id = None\n\n    def __init__(  # pylint: disable=too-many-arguments\n        self,\n        access_token=None,\n        connection_timeout=60.0,\n        custom_headers=None,\n        corporation_id=None,\n        integrator_id=None,\n        platform_id=None,\n        max_retries=3,\n    ):\n        """Initialize\n\n        Args:\n            access_token (str, optional): Your User Access Token. Defaults to None.\n            connection_timeout (float, optional): Time to timeout the REST call. Defaults to 60.0.\n            custom_headers (dict, optional): A Dict with params to be added to the requests params.\n            Defaults to None.\n            corporation_id (str, optional): Your Corporation ID if any. Defaults to None.\n            integrator_id (str, optional): Your Integrator ID if any. Defaults to None.\n            platform_id (str, optional): Your Platform ID if any. Defaults to None.\n            max_retries (int, optional): How many retries must be done in case of fail.\n            Defaults to 3.\n\n        Raises:\n            ValueError: Param access_token must be a String\n            ValueError: Param connection_timeout must be a Float\n            ValueError: Param custom_headers must be a Dictionary\n            ValueError: Param corporation_id must be a String\n            ValueError: Param integrator_id must be a String\n            ValueError: Param platform_id must be a String\n            ValueError: Param max_retries must be an Integer\n        """\n\n        if access_token is not None:\n            self.access_token = access_token\n        if connection_timeout is not None:\n            self.connection_timeout = connection_timeout\n        if custom_headers is not None:\n            self.custom_headers = custom_headers\n        if max_retries is not None:\n            self.max_retries = max_retries\n        if corporation_id is not None:\n            self.corporation_id = corporation_id\n        if integrator_id is not None:\n            self.integrator_id = integrator_id\n        if platform_id is not None:\n            self.platform_id = platform_id\n\n        self.__config = Config()\n\n    def get_headers(self):\n        """\n        Sets the attribute values of headers\n        """\n        headers = {"Authorization": "Bearer " + self.__access_token,\n                   "x-product-id": self.__config.product_id,\n                   "x-tracking-id": self.__config.tracking_id,\n                   "x-idempotency-key": str(uuid.uuid4().int),\n                   "User-Agent": self.__config.user_agent,\n                   "Accept": self.__config.mime_json}\n\n        if self.__corporation_id is not None:\n            headers["x-corporation-id"] = self.__corporation_id\n\n        if self.__integrator_id is not None:\n            headers["x-integrator-id"] = self.__integrator_id\n\n        if self.__platform_id is not None:\n            headers["x-platform-id"] = self.__platform_id\n\n        if self.__custom_headers is not None:\n            headers.update(self.__custom_headers)\n\n        return headers\n\n    @property\n    def access_token(self):\n        """\n        Sets the attribute value and validates access_token\n        """\n        return self.__access_token\n\n    @access_token.setter\n    def access_token(self, value):\n        if not isinstance(value, str):\n            raise ValueError("Param access_token must be a String")\n        self.__access_token = value\n\n    @property\n    def connection_timeout(self):\n        """\n        Sets the attribute value and validates connection timeout\n        """\n        return self.__connection_timeout\n\n    @connection_timeout.setter\n    def connection_timeout(self, value):\n        if not isinstance(value, float):\n            raise ValueError("Param connection_timeout must be a Float")\n        self.__connection_timeout = value\n\n    @property\n    def corporation_id(self):\n        """\n        Sets the attribute value and validates corporation id\n        """\n        return self.__corporation_id\n\n    @corporation_id.setter\n    def corporation_id(self, value):\n        if not isinstance(value, str):\n            raise ValueError("Param corporation_id must be a String")\n        self.__corporation_id = value\n\n    @property\n    def custom_headers(self):\n        """\n        Sets the attribute value and validates custom headers\n        """\n        return self.__custom_headers\n\n    @custom_headers.setter\n    def custom_headers(self, value):\n        if not isinstance(value, dict):\n            raise ValueError("Param custom_headers must be a Dictionary")\n        self.__custom_headers = value\n\n    @property\n    def integrator_id(self):\n        """\n        Sets the attribute value and validates integrator id\n        """\n        return self.__integrator_id\n\n    @integrator_id.setter\n    def integrator_id(self, value):\n        if not isinstance(value, str):\n            raise ValueError("Param integrator_id must be a String")\n        self.__integrator_id = value\n\n    @property\n    def max_retries(self):\n        """\n        Sets the attribute value and validates max retries\n        """\n        return self.__max_retries\n\n    @max_retries.setter\n    def max_retries(self, value):\n        if not isinstance(value, int):\n            raise ValueError("Param max_retries must be an Integer")\n        self.__max_retries = value\n\n    @property\n    def platform_id(self):\n        """\n        Sets the attribute value and validates platform id\n        """\n        return self.__platform_id\n\n    @platform_id.setter\n    def platform_id(self, value):\n        if not isinstance(value, str):\n            raise ValueError("Param platform_id must be a String")\n        self.__platform_id = value
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass RequestOptions\n(access_token=None, connection_timeout=60.0, custom_headers=None, corporation_id=None, integrator_id=None, platform_id=None, max_retries=3)\n
\n
\n

This object hold all configurations that will be used in ur REST call.

\n

All here u can customize as well add params in the requisition header (custom_headers)

\n

Initialize

\n

Args

\n
\n
access_token : str, optional
\n
Your User Access Token. Defaults to None.
\n
connection_timeout : float, optional
\n
Time to timeout the REST call. Defaults to 60.0.
\n
custom_headers : dict, optional
\n
A Dict with params to be added to the requests params.
\n
Defaults to None.
\n
corporation_id : str, optional
\n
Your Corporation ID if any. Defaults to None.
\n
integrator_id : str, optional
\n
Your Integrator ID if any. Defaults to None.
\n
platform_id : str, optional
\n
Your Platform ID if any. Defaults to None.
\n
max_retries : int, optional
\n
How many retries must be done in case of fail.
\n
\n

Defaults to 3.

\n

Raises

\n
\n
ValueError
\n
Param access_token must be a String
\n
ValueError
\n
Param connection_timeout must be a Float
\n
ValueError
\n
Param custom_headers must be a Dictionary
\n
ValueError
\n
Param corporation_id must be a String
\n
ValueError
\n
Param integrator_id must be a String
\n
ValueError
\n
Param platform_id must be a String
\n
ValueError
\n
Param max_retries must be an Integer
\n
\n
\n\nExpand source code\n\n
class RequestOptions:  # pylint: disable=too-many-instance-attributes\n\n    """This object hold all configurations that will be used in ur REST call.\n\n    All here u can customize as well add params in the requisition header (custom_headers)\n    """\n\n    __access_token = None\n    __connection_timeout = None\n    __custom_headers = None\n    __max_retries = None\n    __corporation_id = None\n    __integrator_id = None\n    __platform_id = None\n\n    def __init__(  # pylint: disable=too-many-arguments\n        self,\n        access_token=None,\n        connection_timeout=60.0,\n        custom_headers=None,\n        corporation_id=None,\n        integrator_id=None,\n        platform_id=None,\n        max_retries=3,\n    ):\n        """Initialize\n\n        Args:\n            access_token (str, optional): Your User Access Token. Defaults to None.\n            connection_timeout (float, optional): Time to timeout the REST call. Defaults to 60.0.\n            custom_headers (dict, optional): A Dict with params to be added to the requests params.\n            Defaults to None.\n            corporation_id (str, optional): Your Corporation ID if any. Defaults to None.\n            integrator_id (str, optional): Your Integrator ID if any. Defaults to None.\n            platform_id (str, optional): Your Platform ID if any. Defaults to None.\n            max_retries (int, optional): How many retries must be done in case of fail.\n            Defaults to 3.\n\n        Raises:\n            ValueError: Param access_token must be a String\n            ValueError: Param connection_timeout must be a Float\n            ValueError: Param custom_headers must be a Dictionary\n            ValueError: Param corporation_id must be a String\n            ValueError: Param integrator_id must be a String\n            ValueError: Param platform_id must be a String\n            ValueError: Param max_retries must be an Integer\n        """\n\n        if access_token is not None:\n            self.access_token = access_token\n        if connection_timeout is not None:\n            self.connection_timeout = connection_timeout\n        if custom_headers is not None:\n            self.custom_headers = custom_headers\n        if max_retries is not None:\n            self.max_retries = max_retries\n        if corporation_id is not None:\n            self.corporation_id = corporation_id\n        if integrator_id is not None:\n            self.integrator_id = integrator_id\n        if platform_id is not None:\n            self.platform_id = platform_id\n\n        self.__config = Config()\n\n    def get_headers(self):\n        """\n        Sets the attribute values of headers\n        """\n        headers = {"Authorization": "Bearer " + self.__access_token,\n                   "x-product-id": self.__config.product_id,\n                   "x-tracking-id": self.__config.tracking_id,\n                   "x-idempotency-key": str(uuid.uuid4().int),\n                   "User-Agent": self.__config.user_agent,\n                   "Accept": self.__config.mime_json}\n\n        if self.__corporation_id is not None:\n            headers["x-corporation-id"] = self.__corporation_id\n\n        if self.__integrator_id is not None:\n            headers["x-integrator-id"] = self.__integrator_id\n\n        if self.__platform_id is not None:\n            headers["x-platform-id"] = self.__platform_id\n\n        if self.__custom_headers is not None:\n            headers.update(self.__custom_headers)\n\n        return headers\n\n    @property\n    def access_token(self):\n        """\n        Sets the attribute value and validates access_token\n        """\n        return self.__access_token\n\n    @access_token.setter\n    def access_token(self, value):\n        if not isinstance(value, str):\n            raise ValueError("Param access_token must be a String")\n        self.__access_token = value\n\n    @property\n    def connection_timeout(self):\n        """\n        Sets the attribute value and validates connection timeout\n        """\n        return self.__connection_timeout\n\n    @connection_timeout.setter\n    def connection_timeout(self, value):\n        if not isinstance(value, float):\n            raise ValueError("Param connection_timeout must be a Float")\n        self.__connection_timeout = value\n\n    @property\n    def corporation_id(self):\n        """\n        Sets the attribute value and validates corporation id\n        """\n        return self.__corporation_id\n\n    @corporation_id.setter\n    def corporation_id(self, value):\n        if not isinstance(value, str):\n            raise ValueError("Param corporation_id must be a String")\n        self.__corporation_id = value\n\n    @property\n    def custom_headers(self):\n        """\n        Sets the attribute value and validates custom headers\n        """\n        return self.__custom_headers\n\n    @custom_headers.setter\n    def custom_headers(self, value):\n        if not isinstance(value, dict):\n            raise ValueError("Param custom_headers must be a Dictionary")\n        self.__custom_headers = value\n\n    @property\n    def integrator_id(self):\n        """\n        Sets the attribute value and validates integrator id\n        """\n        return self.__integrator_id\n\n    @integrator_id.setter\n    def integrator_id(self, value):\n        if not isinstance(value, str):\n            raise ValueError("Param integrator_id must be a String")\n        self.__integrator_id = value\n\n    @property\n    def max_retries(self):\n        """\n        Sets the attribute value and validates max retries\n        """\n        return self.__max_retries\n\n    @max_retries.setter\n    def max_retries(self, value):\n        if not isinstance(value, int):\n            raise ValueError("Param max_retries must be an Integer")\n        self.__max_retries = value\n\n    @property\n    def platform_id(self):\n        """\n        Sets the attribute value and validates platform id\n        """\n        return self.__platform_id\n\n    @platform_id.setter\n    def platform_id(self, value):\n        if not isinstance(value, str):\n            raise ValueError("Param platform_id must be a String")\n        self.__platform_id = value
\n
\n

Instance variables

\n
\n
var access_token
\n
\n

Sets the attribute value and validates access_token

\n
\n\nExpand source code\n\n
@property\ndef access_token(self):\n    """\n    Sets the attribute value and validates access_token\n    """\n    return self.__access_token
\n
\n
\n
var connection_timeout
\n
\n

Sets the attribute value and validates connection timeout

\n
\n\nExpand source code\n\n
@property\ndef connection_timeout(self):\n    """\n    Sets the attribute value and validates connection timeout\n    """\n    return self.__connection_timeout
\n
\n
\n
var corporation_id
\n
\n

Sets the attribute value and validates corporation id

\n
\n\nExpand source code\n\n
@property\ndef corporation_id(self):\n    """\n    Sets the attribute value and validates corporation id\n    """\n    return self.__corporation_id
\n
\n
\n
var custom_headers
\n
\n

Sets the attribute value and validates custom headers

\n
\n\nExpand source code\n\n
@property\ndef custom_headers(self):\n    """\n    Sets the attribute value and validates custom headers\n    """\n    return self.__custom_headers
\n
\n
\n
var integrator_id
\n
\n

Sets the attribute value and validates integrator id

\n
\n\nExpand source code\n\n
@property\ndef integrator_id(self):\n    """\n    Sets the attribute value and validates integrator id\n    """\n    return self.__integrator_id
\n
\n
\n
var max_retries
\n
\n

Sets the attribute value and validates max retries

\n
\n\nExpand source code\n\n
@property\ndef max_retries(self):\n    """\n    Sets the attribute value and validates max retries\n    """\n    return self.__max_retries
\n
\n
\n
var platform_id
\n
\n

Sets the attribute value and validates platform id

\n
\n\nExpand source code\n\n
@property\ndef platform_id(self):\n    """\n    Sets the attribute value and validates platform id\n    """\n    return self.__platform_id
\n
\n
\n
\n

Methods

\n
\n
\ndef get_headers(self)\n
\n
\n

Sets the attribute values of headers

\n
\n\nExpand source code\n\n
def get_headers(self):\n    """\n    Sets the attribute values of headers\n    """\n    headers = {"Authorization": "Bearer " + self.__access_token,\n               "x-product-id": self.__config.product_id,\n               "x-tracking-id": self.__config.tracking_id,\n               "x-idempotency-key": str(uuid.uuid4().int),\n               "User-Agent": self.__config.user_agent,\n               "Accept": self.__config.mime_json}\n\n    if self.__corporation_id is not None:\n        headers["x-corporation-id"] = self.__corporation_id\n\n    if self.__integrator_id is not None:\n        headers["x-integrator-id"] = self.__integrator_id\n\n    if self.__platform_id is not None:\n        headers["x-platform-id"] = self.__platform_id\n\n    if self.__custom_headers is not None:\n        headers.update(self.__custom_headers)\n\n    return headers
\n
\n
\n
\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/core/index.html", "content": "\n\n\n\n\n\nmercadopago.core API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.core

\n
\n
\n

Module: core/init.py

\n
\n\nExpand source code\n\n
"""\nModule: core/__init__.py\n"""\nfrom mercadopago.core.mp_base import MPBase\n\n\n__all__ = (\n    'MPBase',\n)
\n
\n
\n
\n

Sub-modules

\n
\n
mercadopago.core.mp_base
\n
\n

Module: mp_base

\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass MPBase\n(request_options, http_client)\n
\n
\n

All mercadopago.resources extends this one to call the REST services

\n

Args

\n
\n
request_options (mercadopago.config.request_options, optional):
\n
An instance of RequestOptions can be pass changing or adding custom options
\n
to ur REST calls. Defaults to None.
\n
http_client : mercadopago.http.http_client, optional
\n
An implementation of
\n
\n

HttpClient can be pass to be used to make the REST calls. Defaults to None.

\n

Raises

\n
\n
ValueError
\n
Param request_options must be a RequestOptions Object
\n
ValueError
\n
Filters must be a Dictionary
\n
\n
\n\nExpand source code\n\n
class MPBase:\n    """All mercadopago.resources extends this one to call the REST services\n\n    Args:\n        request_options (mercadopago.config.request_options, optional):\n        An instance of RequestOptions can be pass changing or adding custom options\n        to ur REST calls. Defaults to None.\n        http_client (mercadopago.http.http_client, optional): An implementation of\n        HttpClient can be pass to be used to make the REST calls. Defaults to None.\n\n    Raises:\n        ValueError: Param request_options must be a RequestOptions Object\n        ValueError: Filters must be a Dictionary\n    """\n\n    def __init__(self, request_options, http_client):\n        if not isinstance(request_options, RequestOptions):\n            raise ValueError(\n                "Param request_options must be a RequestOptions Object")\n\n        self.__request_options = request_options\n        self.__http_client = http_client\n        self.__config = Config()\n\n    def __check_request_options(self, request_options):\n        if request_options is not None and not isinstance(request_options, RequestOptions):\n            raise ValueError(\n                "Param request_options must be a RequestOptions Object")\n        if request_options is None:\n            request_options = self.__request_options\n\n        if request_options.access_token is None:\n            request_options.access_token = self.__request_options.access_token\n\n        return request_options\n\n    def __check_headers(self, request_options, extra_headers=None):\n        headers = self.__request_options.get_headers()\n        if request_options is not None:\n            headers = request_options.get_headers()\n\n        if extra_headers is not None:\n            headers.update(extra_headers)\n\n        return headers\n\n    def _get(self, uri, filters=None, request_options=None):\n        if filters is not None and not isinstance(filters, dict):\n            raise ValueError("Filters must be a Dictionary")\n\n        request_options = self.__check_request_options(request_options)\n        headers = self.__check_headers(\n            request_options, {"Content-type": self.__config.mime_json})\n\n        return self.__http_client.get(\n            url=self.__config.api_base_url + uri,\n            params=filters,\n            headers=headers,\n            timeout=request_options.connection_timeout,\n            maxretries=request_options.max_retries,\n        )\n\n    def _post(self, uri, data=None, params=None, request_options=None):\n        if data is not None:\n            data = JSONEncoder().encode(data)\n\n        request_options = self.__check_request_options(request_options)\n        headers = self.__check_headers(\n            request_options, {"Content-type": self.__config.mime_json})\n\n        return self.__http_client.post(\n            url=self.__config.api_base_url + uri,\n            data=data,\n            params=params,\n            headers=headers,\n            timeout=request_options.connection_timeout,\n            maxretries=request_options.max_retries,\n        )\n\n    def _put(self, uri, data=None, params=None, request_options=None):\n        if data is not None:\n            data = JSONEncoder().encode(data)\n\n        request_options = self.__check_request_options(request_options)\n        headers = self.__check_headers(\n            request_options, {"Content-type": self.__config.mime_json})\n\n        return self.__http_client.put(\n            url=self.__config.api_base_url + uri,\n            data=data,\n            params=params,\n            headers=headers,\n            timeout=request_options.connection_timeout,\n            maxretries=request_options.max_retries,\n        )\n\n    def _delete(self, uri, params=None, request_options=None):\n        request_options = self.__check_request_options(request_options)\n        headers = self.__check_headers(request_options)\n\n        return self.__http_client.delete(\n            url=self.__config.api_base_url + uri,\n            params=params,\n            headers=headers,\n            timeout=request_options.connection_timeout,\n            maxretries=request_options.max_retries,\n        )\n\n    @property\n    def request_options(self):\n        """\n        Returns the attribute value of the function\n        """\n        return self.__request_options\n\n    @property\n    def config(self):\n        """\n        Returns the attribute value of the function\n        """\n        return self.__config
\n
\n

Subclasses

\n\n

Instance variables

\n
\n
var config
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
@property\ndef config(self):\n    """\n    Returns the attribute value of the function\n    """\n    return self.__config
\n
\n
\n
var request_options
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
@property\ndef request_options(self):\n    """\n    Returns the attribute value of the function\n    """\n    return self.__request_options
\n
\n
\n
\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/core/mp_base.html", "content": "\n\n\n\n\n\nmercadopago.core.mp_base API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.core.mp_base

\n
\n
\n

Module: mp_base

\n
\n\nExpand source code\n\n
"""\nModule: mp_base\n"""\nfrom json.encoder import JSONEncoder\n\nfrom mercadopago.config.config import Config\nfrom mercadopago.config.request_options import RequestOptions\n\n\nclass MPBase:\n    """All mercadopago.resources extends this one to call the REST services\n\n    Args:\n        request_options (mercadopago.config.request_options, optional):\n        An instance of RequestOptions can be pass changing or adding custom options\n        to ur REST calls. Defaults to None.\n        http_client (mercadopago.http.http_client, optional): An implementation of\n        HttpClient can be pass to be used to make the REST calls. Defaults to None.\n\n    Raises:\n        ValueError: Param request_options must be a RequestOptions Object\n        ValueError: Filters must be a Dictionary\n    """\n\n    def __init__(self, request_options, http_client):\n        if not isinstance(request_options, RequestOptions):\n            raise ValueError(\n                "Param request_options must be a RequestOptions Object")\n\n        self.__request_options = request_options\n        self.__http_client = http_client\n        self.__config = Config()\n\n    def __check_request_options(self, request_options):\n        if request_options is not None and not isinstance(request_options, RequestOptions):\n            raise ValueError(\n                "Param request_options must be a RequestOptions Object")\n        if request_options is None:\n            request_options = self.__request_options\n\n        if request_options.access_token is None:\n            request_options.access_token = self.__request_options.access_token\n\n        return request_options\n\n    def __check_headers(self, request_options, extra_headers=None):\n        headers = self.__request_options.get_headers()\n        if request_options is not None:\n            headers = request_options.get_headers()\n\n        if extra_headers is not None:\n            headers.update(extra_headers)\n\n        return headers\n\n    def _get(self, uri, filters=None, request_options=None):\n        if filters is not None and not isinstance(filters, dict):\n            raise ValueError("Filters must be a Dictionary")\n\n        request_options = self.__check_request_options(request_options)\n        headers = self.__check_headers(\n            request_options, {"Content-type": self.__config.mime_json})\n\n        return self.__http_client.get(\n            url=self.__config.api_base_url + uri,\n            params=filters,\n            headers=headers,\n            timeout=request_options.connection_timeout,\n            maxretries=request_options.max_retries,\n        )\n\n    def _post(self, uri, data=None, params=None, request_options=None):\n        if data is not None:\n            data = JSONEncoder().encode(data)\n\n        request_options = self.__check_request_options(request_options)\n        headers = self.__check_headers(\n            request_options, {"Content-type": self.__config.mime_json})\n\n        return self.__http_client.post(\n            url=self.__config.api_base_url + uri,\n            data=data,\n            params=params,\n            headers=headers,\n            timeout=request_options.connection_timeout,\n            maxretries=request_options.max_retries,\n        )\n\n    def _put(self, uri, data=None, params=None, request_options=None):\n        if data is not None:\n            data = JSONEncoder().encode(data)\n\n        request_options = self.__check_request_options(request_options)\n        headers = self.__check_headers(\n            request_options, {"Content-type": self.__config.mime_json})\n\n        return self.__http_client.put(\n            url=self.__config.api_base_url + uri,\n            data=data,\n            params=params,\n            headers=headers,\n            timeout=request_options.connection_timeout,\n            maxretries=request_options.max_retries,\n        )\n\n    def _delete(self, uri, params=None, request_options=None):\n        request_options = self.__check_request_options(request_options)\n        headers = self.__check_headers(request_options)\n\n        return self.__http_client.delete(\n            url=self.__config.api_base_url + uri,\n            params=params,\n            headers=headers,\n            timeout=request_options.connection_timeout,\n            maxretries=request_options.max_retries,\n        )\n\n    @property\n    def request_options(self):\n        """\n        Returns the attribute value of the function\n        """\n        return self.__request_options\n\n    @property\n    def config(self):\n        """\n        Returns the attribute value of the function\n        """\n        return self.__config
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass MPBase\n(request_options, http_client)\n
\n
\n

All mercadopago.resources extends this one to call the REST services

\n

Args

\n
\n
request_options (mercadopago.config.request_options, optional):
\n
An instance of RequestOptions can be pass changing or adding custom options
\n
to ur REST calls. Defaults to None.
\n
http_client : mercadopago.http.http_client, optional
\n
An implementation of
\n
\n

HttpClient can be pass to be used to make the REST calls. Defaults to None.

\n

Raises

\n
\n
ValueError
\n
Param request_options must be a RequestOptions Object
\n
ValueError
\n
Filters must be a Dictionary
\n
\n
\n\nExpand source code\n\n
class MPBase:\n    """All mercadopago.resources extends this one to call the REST services\n\n    Args:\n        request_options (mercadopago.config.request_options, optional):\n        An instance of RequestOptions can be pass changing or adding custom options\n        to ur REST calls. Defaults to None.\n        http_client (mercadopago.http.http_client, optional): An implementation of\n        HttpClient can be pass to be used to make the REST calls. Defaults to None.\n\n    Raises:\n        ValueError: Param request_options must be a RequestOptions Object\n        ValueError: Filters must be a Dictionary\n    """\n\n    def __init__(self, request_options, http_client):\n        if not isinstance(request_options, RequestOptions):\n            raise ValueError(\n                "Param request_options must be a RequestOptions Object")\n\n        self.__request_options = request_options\n        self.__http_client = http_client\n        self.__config = Config()\n\n    def __check_request_options(self, request_options):\n        if request_options is not None and not isinstance(request_options, RequestOptions):\n            raise ValueError(\n                "Param request_options must be a RequestOptions Object")\n        if request_options is None:\n            request_options = self.__request_options\n\n        if request_options.access_token is None:\n            request_options.access_token = self.__request_options.access_token\n\n        return request_options\n\n    def __check_headers(self, request_options, extra_headers=None):\n        headers = self.__request_options.get_headers()\n        if request_options is not None:\n            headers = request_options.get_headers()\n\n        if extra_headers is not None:\n            headers.update(extra_headers)\n\n        return headers\n\n    def _get(self, uri, filters=None, request_options=None):\n        if filters is not None and not isinstance(filters, dict):\n            raise ValueError("Filters must be a Dictionary")\n\n        request_options = self.__check_request_options(request_options)\n        headers = self.__check_headers(\n            request_options, {"Content-type": self.__config.mime_json})\n\n        return self.__http_client.get(\n            url=self.__config.api_base_url + uri,\n            params=filters,\n            headers=headers,\n            timeout=request_options.connection_timeout,\n            maxretries=request_options.max_retries,\n        )\n\n    def _post(self, uri, data=None, params=None, request_options=None):\n        if data is not None:\n            data = JSONEncoder().encode(data)\n\n        request_options = self.__check_request_options(request_options)\n        headers = self.__check_headers(\n            request_options, {"Content-type": self.__config.mime_json})\n\n        return self.__http_client.post(\n            url=self.__config.api_base_url + uri,\n            data=data,\n            params=params,\n            headers=headers,\n            timeout=request_options.connection_timeout,\n            maxretries=request_options.max_retries,\n        )\n\n    def _put(self, uri, data=None, params=None, request_options=None):\n        if data is not None:\n            data = JSONEncoder().encode(data)\n\n        request_options = self.__check_request_options(request_options)\n        headers = self.__check_headers(\n            request_options, {"Content-type": self.__config.mime_json})\n\n        return self.__http_client.put(\n            url=self.__config.api_base_url + uri,\n            data=data,\n            params=params,\n            headers=headers,\n            timeout=request_options.connection_timeout,\n            maxretries=request_options.max_retries,\n        )\n\n    def _delete(self, uri, params=None, request_options=None):\n        request_options = self.__check_request_options(request_options)\n        headers = self.__check_headers(request_options)\n\n        return self.__http_client.delete(\n            url=self.__config.api_base_url + uri,\n            params=params,\n            headers=headers,\n            timeout=request_options.connection_timeout,\n            maxretries=request_options.max_retries,\n        )\n\n    @property\n    def request_options(self):\n        """\n        Returns the attribute value of the function\n        """\n        return self.__request_options\n\n    @property\n    def config(self):\n        """\n        Returns the attribute value of the function\n        """\n        return self.__config
\n
\n

Subclasses

\n\n

Instance variables

\n
\n
var config
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
@property\ndef config(self):\n    """\n    Returns the attribute value of the function\n    """\n    return self.__config
\n
\n
\n
var request_options
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
@property\ndef request_options(self):\n    """\n    Returns the attribute value of the function\n    """\n    return self.__request_options
\n
\n
\n
\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/http/http_client.html", "content": "\n\n\n\n\n\nmercadopago.http.http_client API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.http.http_client

\n
\n
\n

Module: http_client

\n
\n\nExpand source code\n\n
"""\nModule: http_client\n"""\nimport requests\nfrom requests.adapters import HTTPAdapter\nfrom urllib3.util import Retry\n\n\nclass HttpClient:\n    """\n    Default implementation to call all REST API's\n    """\n\n    def request(self, method, url, maxretries=None, **kwargs):  # pylint: disable=no-self-use\n        """Makes a call to the API.\n\n        All **kwargs are passed verbatim to ``requests.request``.\n        """\n        retry_strategy = Retry(\n            total=maxretries,\n            status_forcelist=[429, 500, 502, 503, 504]\n        )\n        http = requests.Session()\n        http.mount("https://", HTTPAdapter(max_retries=retry_strategy))\n        with http as session:\n            api_result = session.request(method, url, **kwargs)\n            response = {\n                "status": api_result.status_code,\n                "response": api_result.json()\n            }\n\n        return response\n\n    def get(self, url, headers, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n        """Makes a GET request to the API"""\n        return self.request(\n            "GET",\n            url=url,\n            headers=headers,\n            params=params,\n            timeout=timeout,\n            maxretries=maxretries,\n        )\n\n    def post(self, url, headers, data=None, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n        """Makes a POST request to the API"""\n        return self.request(\n            "POST",\n            url=url,\n            headers=headers,\n            data=data,\n            params=params,\n            timeout=timeout,\n            maxretries=maxretries,\n        )\n\n    def put(self, url, headers, data=None, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n        """Makes a PUT request to the API"""\n        return self.request(\n            "PUT",\n            url=url,\n            headers=headers,\n            data=data,\n            params=params,\n            timeout=timeout,\n            maxretries=maxretries,\n        )\n\n    def delete(self, url, headers, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n        """Makes a DELETE request to the API"""\n        return self.request(\n            "DELETE",\n            url=url,\n            headers=headers,\n            params=params,\n            timeout=timeout,\n            maxretries=maxretries,\n        )
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass HttpClient\n
\n
\n

Default implementation to call all REST API's

\n
\n\nExpand source code\n\n
class HttpClient:\n    """\n    Default implementation to call all REST API's\n    """\n\n    def request(self, method, url, maxretries=None, **kwargs):  # pylint: disable=no-self-use\n        """Makes a call to the API.\n\n        All **kwargs are passed verbatim to ``requests.request``.\n        """\n        retry_strategy = Retry(\n            total=maxretries,\n            status_forcelist=[429, 500, 502, 503, 504]\n        )\n        http = requests.Session()\n        http.mount("https://", HTTPAdapter(max_retries=retry_strategy))\n        with http as session:\n            api_result = session.request(method, url, **kwargs)\n            response = {\n                "status": api_result.status_code,\n                "response": api_result.json()\n            }\n\n        return response\n\n    def get(self, url, headers, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n        """Makes a GET request to the API"""\n        return self.request(\n            "GET",\n            url=url,\n            headers=headers,\n            params=params,\n            timeout=timeout,\n            maxretries=maxretries,\n        )\n\n    def post(self, url, headers, data=None, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n        """Makes a POST request to the API"""\n        return self.request(\n            "POST",\n            url=url,\n            headers=headers,\n            data=data,\n            params=params,\n            timeout=timeout,\n            maxretries=maxretries,\n        )\n\n    def put(self, url, headers, data=None, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n        """Makes a PUT request to the API"""\n        return self.request(\n            "PUT",\n            url=url,\n            headers=headers,\n            data=data,\n            params=params,\n            timeout=timeout,\n            maxretries=maxretries,\n        )\n\n    def delete(self, url, headers, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n        """Makes a DELETE request to the API"""\n        return self.request(\n            "DELETE",\n            url=url,\n            headers=headers,\n            params=params,\n            timeout=timeout,\n            maxretries=maxretries,\n        )
\n
\n

Methods

\n
\n
\ndef delete(self, url, headers, params=None, timeout=None, maxretries=None)\n
\n
\n

Makes a DELETE request to the API

\n
\n\nExpand source code\n\n
def delete(self, url, headers, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n    """Makes a DELETE request to the API"""\n    return self.request(\n        "DELETE",\n        url=url,\n        headers=headers,\n        params=params,\n        timeout=timeout,\n        maxretries=maxretries,\n    )
\n
\n
\n
\ndef get(self, url, headers, params=None, timeout=None, maxretries=None)\n
\n
\n

Makes a GET request to the API

\n
\n\nExpand source code\n\n
def get(self, url, headers, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n    """Makes a GET request to the API"""\n    return self.request(\n        "GET",\n        url=url,\n        headers=headers,\n        params=params,\n        timeout=timeout,\n        maxretries=maxretries,\n    )
\n
\n
\n
\ndef post(self, url, headers, data=None, params=None, timeout=None, maxretries=None)\n
\n
\n

Makes a POST request to the API

\n
\n\nExpand source code\n\n
def post(self, url, headers, data=None, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n    """Makes a POST request to the API"""\n    return self.request(\n        "POST",\n        url=url,\n        headers=headers,\n        data=data,\n        params=params,\n        timeout=timeout,\n        maxretries=maxretries,\n    )
\n
\n
\n
\ndef put(self, url, headers, data=None, params=None, timeout=None, maxretries=None)\n
\n
\n

Makes a PUT request to the API

\n
\n\nExpand source code\n\n
def put(self, url, headers, data=None, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n    """Makes a PUT request to the API"""\n    return self.request(\n        "PUT",\n        url=url,\n        headers=headers,\n        data=data,\n        params=params,\n        timeout=timeout,\n        maxretries=maxretries,\n    )
\n
\n
\n
\ndef request(self, method, url, maxretries=None, **kwargs)\n
\n
\n

Makes a call to the API.

\n

All **kwargs are passed verbatim to requests.request.

\n
\n\nExpand source code\n\n
def request(self, method, url, maxretries=None, **kwargs):  # pylint: disable=no-self-use\n    """Makes a call to the API.\n\n    All **kwargs are passed verbatim to ``requests.request``.\n    """\n    retry_strategy = Retry(\n        total=maxretries,\n        status_forcelist=[429, 500, 502, 503, 504]\n    )\n    http = requests.Session()\n    http.mount("https://", HTTPAdapter(max_retries=retry_strategy))\n    with http as session:\n        api_result = session.request(method, url, **kwargs)\n        response = {\n            "status": api_result.status_code,\n            "response": api_result.json()\n        }\n\n    return response
\n
\n
\n
\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/http/index.html", "content": "\n\n\n\n\n\nmercadopago.http API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.http

\n
\n
\n

Module: http/init.py

\n
\n\nExpand source code\n\n
"""\nModule: http/__init__.py\n"""\nfrom mercadopago.http.http_client import HttpClient\n\n\n__all__ = (\n    'HttpClient',\n)
\n
\n
\n
\n

Sub-modules

\n
\n
mercadopago.http.http_client
\n
\n

Module: http_client

\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass HttpClient\n
\n
\n

Default implementation to call all REST API's

\n
\n\nExpand source code\n\n
class HttpClient:\n    """\n    Default implementation to call all REST API's\n    """\n\n    def request(self, method, url, maxretries=None, **kwargs):  # pylint: disable=no-self-use\n        """Makes a call to the API.\n\n        All **kwargs are passed verbatim to ``requests.request``.\n        """\n        retry_strategy = Retry(\n            total=maxretries,\n            status_forcelist=[429, 500, 502, 503, 504]\n        )\n        http = requests.Session()\n        http.mount("https://", HTTPAdapter(max_retries=retry_strategy))\n        with http as session:\n            api_result = session.request(method, url, **kwargs)\n            response = {\n                "status": api_result.status_code,\n                "response": api_result.json()\n            }\n\n        return response\n\n    def get(self, url, headers, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n        """Makes a GET request to the API"""\n        return self.request(\n            "GET",\n            url=url,\n            headers=headers,\n            params=params,\n            timeout=timeout,\n            maxretries=maxretries,\n        )\n\n    def post(self, url, headers, data=None, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n        """Makes a POST request to the API"""\n        return self.request(\n            "POST",\n            url=url,\n            headers=headers,\n            data=data,\n            params=params,\n            timeout=timeout,\n            maxretries=maxretries,\n        )\n\n    def put(self, url, headers, data=None, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n        """Makes a PUT request to the API"""\n        return self.request(\n            "PUT",\n            url=url,\n            headers=headers,\n            data=data,\n            params=params,\n            timeout=timeout,\n            maxretries=maxretries,\n        )\n\n    def delete(self, url, headers, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n        """Makes a DELETE request to the API"""\n        return self.request(\n            "DELETE",\n            url=url,\n            headers=headers,\n            params=params,\n            timeout=timeout,\n            maxretries=maxretries,\n        )
\n
\n

Methods

\n
\n
\ndef delete(self, url, headers, params=None, timeout=None, maxretries=None)\n
\n
\n

Makes a DELETE request to the API

\n
\n\nExpand source code\n\n
def delete(self, url, headers, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n    """Makes a DELETE request to the API"""\n    return self.request(\n        "DELETE",\n        url=url,\n        headers=headers,\n        params=params,\n        timeout=timeout,\n        maxretries=maxretries,\n    )
\n
\n
\n
\ndef get(self, url, headers, params=None, timeout=None, maxretries=None)\n
\n
\n

Makes a GET request to the API

\n
\n\nExpand source code\n\n
def get(self, url, headers, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n    """Makes a GET request to the API"""\n    return self.request(\n        "GET",\n        url=url,\n        headers=headers,\n        params=params,\n        timeout=timeout,\n        maxretries=maxretries,\n    )
\n
\n
\n
\ndef post(self, url, headers, data=None, params=None, timeout=None, maxretries=None)\n
\n
\n

Makes a POST request to the API

\n
\n\nExpand source code\n\n
def post(self, url, headers, data=None, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n    """Makes a POST request to the API"""\n    return self.request(\n        "POST",\n        url=url,\n        headers=headers,\n        data=data,\n        params=params,\n        timeout=timeout,\n        maxretries=maxretries,\n    )
\n
\n
\n
\ndef put(self, url, headers, data=None, params=None, timeout=None, maxretries=None)\n
\n
\n

Makes a PUT request to the API

\n
\n\nExpand source code\n\n
def put(self, url, headers, data=None, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n    """Makes a PUT request to the API"""\n    return self.request(\n        "PUT",\n        url=url,\n        headers=headers,\n        data=data,\n        params=params,\n        timeout=timeout,\n        maxretries=maxretries,\n    )
\n
\n
\n
\ndef request(self, method, url, maxretries=None, **kwargs)\n
\n
\n

Makes a call to the API.

\n

All **kwargs are passed verbatim to requests.request.

\n
\n\nExpand source code\n\n
def request(self, method, url, maxretries=None, **kwargs):  # pylint: disable=no-self-use\n    """Makes a call to the API.\n\n    All **kwargs are passed verbatim to ``requests.request``.\n    """\n    retry_strategy = Retry(\n        total=maxretries,\n        status_forcelist=[429, 500, 502, 503, 504]\n    )\n    http = requests.Session()\n    http.mount("https://", HTTPAdapter(max_retries=retry_strategy))\n    with http as session:\n        api_result = session.request(method, url, **kwargs)\n        response = {\n            "status": api_result.status_code,\n            "response": api_result.json()\n        }\n\n    return response
\n
\n
\n
\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/index.html", "content": "\n\n\n\n\n\nmercadopago API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Package mercadopago

\n
\n
\n

Module: mercadopago/init.py

\n
\n\nExpand source code\n\n
"""\nModule: mercadopago/__init__.py\n"""\nfrom mercadopago.sdk import SDK\n\n\n__all__ = (\n    'SDK',\n)
\n
\n
\n
\n

Sub-modules

\n
\n
mercadopago.config
\n
\n

Module: config/init.py

\n
\n
mercadopago.core
\n
\n

Module: core/init.py

\n
\n
mercadopago.http
\n
\n

Module: http/init.py

\n
\n
mercadopago.resources
\n
\n

Module: resources/init.py

\n
\n
mercadopago.sdk
\n
\n

Module: sdk

\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass SDK\n(access_token, http_client=None, request_options=None)\n
\n
\n

Generate access to all API' modules, which are:

\n
    \n
  1. Advanced Payment
    2. \n
  2. Card Token
    3. \n
  3. Card
    4. \n
  4. Customer
    5. \n
  5. Disbursement Refund
    6. \n
  6. Identification Type
    7. \n
  7. Merchant Order
    8. \n
  8. Payment Methods
    9. \n
  9. Payment
    10. \n
  10. Preapproval
    11. \n
  11. Preference
    12. \n
  12. Refund
    13. \n
  13. User
    14. \n
\n

Construct ur SDK Object to have access to all APIs modules.

\n

Args

\n
\n
Click here for more info
\n
http_client : mercadopago.http.http_client, optional
\n
An implementation of
\n
HttpClient can be pass to be used to make the REST calls. Defaults to None.
\n
request_options : mercadopago.config.request_options, optional
\n
An instance
\n
\n

of RequestOptions can be pass changing or adding custom options to ur REST\ncalls. Defaults to None.

\n

Raises

\n
\n
ValueError
\n
Param request_options must be a RequestOptions Object
\n
\n
\n\nExpand source code\n\n
class SDK:\n    """Generate access to all API' modules, which are:\n\n        1. Advanced Payment\n        2. Card Token\n        3. Card\n        4. Customer\n        5. Disbursement Refund\n        6. Identification Type\n        7. Merchant Order\n        8. Payment Methods\n        9. Payment\n        10. Preapproval\n        11. Preference\n        12. Refund\n        13. User\n    """\n\n    def __init__(\n        self,\n        access_token,\n        http_client=None,\n        request_options=None,\n    ):\n        """Construct ur SDK Object to have access to all APIs modules.\n        Args:\n            [Click here for more info](https://www.mercadopago.com/mlb/account/credentials)\n            http_client (mercadopago.http.http_client, optional): An implementation of\n            HttpClient can be pass to be used to make the REST calls. Defaults to None.\n            request_options (mercadopago.config.request_options, optional): An instance\n            of RequestOptions can be pass changing or adding custom options to ur REST\n            calls. Defaults to None.\n        Raises:\n            ValueError: Param request_options must be a RequestOptions Object\n        """\n\n        self.http_client = http_client\n        if http_client is None:\n            self.http_client = HttpClient()\n\n        self.request_options = request_options\n        if request_options is None:\n            self.request_options = RequestOptions()\n\n        self.request_options.access_token = access_token\n\n    def advanced_payment(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return AdvancedPayment(request_options is not None and request_options\n                               or self.request_options, self.http_client)\n\n    def card_token(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return CardToken(request_options is not None and request_options\n                         or self.request_options, self.http_client)\n\n    def card(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return Card(request_options is not None and request_options\n                    or self.request_options, self.http_client)\n\n    def customer(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return Customer(request_options is not None and request_options\n                        or self.request_options, self.http_client)\n\n    def disbursement_refund(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return DisbursementRefund(request_options is not None and request_options\n                                  or self.request_options, self.http_client)\n\n    def identification_type(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return IdentificationType(request_options is not None and request_options\n                                  or self.request_options, self.http_client)\n\n    def merchant_order(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return MerchantOrder(request_options is not None and request_options\n                             or self.request_options, self.http_client)\n\n    def payment(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return Payment(request_options is not None and request_options\n                       or self.request_options, self.http_client)\n\n    def payment_methods(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return PaymentMethods(request_options is not None and request_options\n                              or self.request_options, self.http_client)\n\n    def preapproval(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return PreApproval(request_options is not None and request_options\n                           or self.request_options, self.http_client)\n\n    def preference(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return Preference(request_options is not None and request_options\n                          or self.request_options, self.http_client)\n\n    def refund(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return Refund(request_options is not None and request_options\n                      or self.request_options, self.http_client)\n\n    def user(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return User(request_options is not None and request_options\n                    or self.request_options, self.http_client)\n\n    @property\n    def request_options(self):\n        """\n        Sets the attribute value and validates request_options\n        """\n        return self.__request_options\n\n    @request_options.setter\n    def request_options(self, value):\n        if value is not None and not isinstance(value, RequestOptions):\n            raise ValueError(\n                "Param request_options must be a RequestOptions Object")\n        self.__request_options = value\n\n    @property\n    def http_client(self):\n        """\n        Sets the attribute value and validates http_client\n        """\n        return self.__http_client\n\n    @http_client.setter\n    def http_client(self, value):\n        if value is not None and not isinstance(value, HttpClient):\n            raise ValueError("Param http_client must be a HttpClient Object")\n        self.__http_client = value
\n
\n

Instance variables

\n
\n
var http_client
\n
\n

Sets the attribute value and validates http_client

\n
\n\nExpand source code\n\n
@property\ndef http_client(self):\n    """\n    Sets the attribute value and validates http_client\n    """\n    return self.__http_client
\n
\n
\n
var request_options
\n
\n

Sets the attribute value and validates request_options

\n
\n\nExpand source code\n\n
@property\ndef request_options(self):\n    """\n    Sets the attribute value and validates request_options\n    """\n    return self.__request_options
\n
\n
\n
\n

Methods

\n
\n
\ndef advanced_payment(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def advanced_payment(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return AdvancedPayment(request_options is not None and request_options\n                           or self.request_options, self.http_client)
\n
\n
\n
\ndef card(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def card(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return Card(request_options is not None and request_options\n                or self.request_options, self.http_client)
\n
\n
\n
\ndef card_token(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def card_token(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return CardToken(request_options is not None and request_options\n                     or self.request_options, self.http_client)
\n
\n
\n
\ndef customer(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def customer(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return Customer(request_options is not None and request_options\n                    or self.request_options, self.http_client)
\n
\n
\n
\ndef disbursement_refund(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def disbursement_refund(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return DisbursementRefund(request_options is not None and request_options\n                              or self.request_options, self.http_client)
\n
\n
\n
\ndef identification_type(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def identification_type(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return IdentificationType(request_options is not None and request_options\n                              or self.request_options, self.http_client)
\n
\n
\n
\ndef merchant_order(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def merchant_order(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return MerchantOrder(request_options is not None and request_options\n                         or self.request_options, self.http_client)
\n
\n
\n
\ndef payment(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def payment(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return Payment(request_options is not None and request_options\n                   or self.request_options, self.http_client)
\n
\n
\n
\ndef payment_methods(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def payment_methods(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return PaymentMethods(request_options is not None and request_options\n                          or self.request_options, self.http_client)
\n
\n
\n
\ndef preapproval(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def preapproval(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return PreApproval(request_options is not None and request_options\n                       or self.request_options, self.http_client)
\n
\n
\n
\ndef preference(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def preference(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return Preference(request_options is not None and request_options\n                      or self.request_options, self.http_client)
\n
\n
\n
\ndef refund(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def refund(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return Refund(request_options is not None and request_options\n                  or self.request_options, self.http_client)
\n
\n
\n
\ndef user(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def user(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return User(request_options is not None and request_options\n                or self.request_options, self.http_client)
\n
\n
\n
\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/resources/advanced_payment.html", "content": "\n\n\n\n\n\nmercadopago.resources.advanced_payment API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.resources.advanced_payment

\n
\n
\n

Module: advanced_payment

\n
\n\nExpand source code\n\n
"""\n    Module: advanced_payment\n"""\nfrom datetime import datetime\n\nfrom mercadopago.core import MPBase\n\n\nclass AdvancedPayment(MPBase):\n    """\n    Access to Advanced Payments\n    """\n\n    def search(self, filters=None, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments_id_search/get/)  # pylint: disable=line-too-long\n\n        Args:\n            filters (dict): The search filters parameters\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding custom options\n            to ur REST call. Defaults to None.\n\n        Returns:\n            dict: Advanced Payment search response\n        """\n        return self._get(uri="/v1/advanced_payments/search", filters=filters,\n                         request_options=request_options)\n\n    def get(self, advanced_payment_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/get/)  # pylint: disable=line-too-long\n\n        Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance\n            of RequestOptions can be pass changing or adding custom options to ur REST\n            call. Defaults to None.\n\n        Returns:\n            dict: Advanced Payment find response\n        """\n        return self._get(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                         request_options=request_options)\n\n    def create(self, advanced_payment_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments/post/)  # pylint: disable=line-too-long\n\n        Args:\n            advanced_payment_object (dict): Advanced Payment to be created\n            request_options (mercadopago.config.request_options, optional): An instance\n            of RequestOptions can be pass changing or adding custom options to ur REST\n            call. Defaults to None.\n\n        Raises:\n            ValueError: Param advanced_payment_object must be a Dictionary\n\n        Returns:\n            dict: Advanced Payment creation response\n        """\n        if not isinstance(advanced_payment_object, dict):\n            raise ValueError(\n                "Param advanced_payment_object must be a Dictionary")\n\n        return self._post(uri="/v1/advanced_payments", data=advanced_payment_object,\n                          request_options=request_options)\n\n    def capture(self, advanced_payment_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance\n            of RequestOptions can be pass changing or adding custom options to ur REST\n            call. Defaults to None.\n\n        Returns:\n            dict: Advanced Payment capture response\n        """\n        capture_object = {"capture": True}\n        return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                         data=capture_object, request_options=request_options)\n\n    def update(self, advanced_payment_id, advanced_payment_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            advanced_payment_object (dict): Advanced Payment to be updated\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param advanced_payment_object must be a Dictionary\n\n        Returns:\n            dict: Advanced Payment modification response\n        """\n        if not isinstance(advanced_payment_object, dict):\n            raise ValueError(\n                "Param advanced_payment_object must be a Dictionary")\n\n        return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                         data=advanced_payment_object, request_options=request_options)\n\n    def cancel(self, advanced_payment_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Advanced Payment cancelation response\n        """\n        cancel_object = {"status": "cancelled"}\n        return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                         data=cancel_object, request_options=request_options)\n\n    def update_release_date(self, advanced_payment_id, release_date, request_options=None):\n        """[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\n\n        Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            release_date (datetime): Advanced Payment to be canceled\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param release_date must be a DateTime\n\n        Returns:\n            dict: Advanced Payment release date modification response\n        """\n        if not isinstance(release_date, datetime):\n            raise ValueError("Param release_date must be a DateTime")\n\n        disbursement_object = {\n            "money_release_date": release_date.strftime("%Y-%m-%d %H:%M:%S.%f")}\n\n        return self._post(uri="/v1/advanced_payments/" + str(advanced_payment_id) + "/disburses",\n                          data=disbursement_object, request_options=request_options)
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass AdvancedPayment\n(request_options, http_client)\n
\n
\n

Access to Advanced Payments

\n
\n\nExpand source code\n\n
class AdvancedPayment(MPBase):\n    """\n    Access to Advanced Payments\n    """\n\n    def search(self, filters=None, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments_id_search/get/)  # pylint: disable=line-too-long\n\n        Args:\n            filters (dict): The search filters parameters\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding custom options\n            to ur REST call. Defaults to None.\n\n        Returns:\n            dict: Advanced Payment search response\n        """\n        return self._get(uri="/v1/advanced_payments/search", filters=filters,\n                         request_options=request_options)\n\n    def get(self, advanced_payment_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/get/)  # pylint: disable=line-too-long\n\n        Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance\n            of RequestOptions can be pass changing or adding custom options to ur REST\n            call. Defaults to None.\n\n        Returns:\n            dict: Advanced Payment find response\n        """\n        return self._get(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                         request_options=request_options)\n\n    def create(self, advanced_payment_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments/post/)  # pylint: disable=line-too-long\n\n        Args:\n            advanced_payment_object (dict): Advanced Payment to be created\n            request_options (mercadopago.config.request_options, optional): An instance\n            of RequestOptions can be pass changing or adding custom options to ur REST\n            call. Defaults to None.\n\n        Raises:\n            ValueError: Param advanced_payment_object must be a Dictionary\n\n        Returns:\n            dict: Advanced Payment creation response\n        """\n        if not isinstance(advanced_payment_object, dict):\n            raise ValueError(\n                "Param advanced_payment_object must be a Dictionary")\n\n        return self._post(uri="/v1/advanced_payments", data=advanced_payment_object,\n                          request_options=request_options)\n\n    def capture(self, advanced_payment_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance\n            of RequestOptions can be pass changing or adding custom options to ur REST\n            call. Defaults to None.\n\n        Returns:\n            dict: Advanced Payment capture response\n        """\n        capture_object = {"capture": True}\n        return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                         data=capture_object, request_options=request_options)\n\n    def update(self, advanced_payment_id, advanced_payment_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            advanced_payment_object (dict): Advanced Payment to be updated\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param advanced_payment_object must be a Dictionary\n\n        Returns:\n            dict: Advanced Payment modification response\n        """\n        if not isinstance(advanced_payment_object, dict):\n            raise ValueError(\n                "Param advanced_payment_object must be a Dictionary")\n\n        return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                         data=advanced_payment_object, request_options=request_options)\n\n    def cancel(self, advanced_payment_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Advanced Payment cancelation response\n        """\n        cancel_object = {"status": "cancelled"}\n        return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                         data=cancel_object, request_options=request_options)\n\n    def update_release_date(self, advanced_payment_id, release_date, request_options=None):\n        """[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\n\n        Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            release_date (datetime): Advanced Payment to be canceled\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param release_date must be a DateTime\n\n        Returns:\n            dict: Advanced Payment release date modification response\n        """\n        if not isinstance(release_date, datetime):\n            raise ValueError("Param release_date must be a DateTime")\n\n        disbursement_object = {\n            "money_release_date": release_date.strftime("%Y-%m-%d %H:%M:%S.%f")}\n\n        return self._post(uri="/v1/advanced_payments/" + str(advanced_payment_id) + "/disburses",\n                          data=disbursement_object, request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef cancel(self, advanced_payment_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
advanced_payment_id : str
\n
The Advanced Payment ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Advanced Payment cancelation response
\n
\n
\n\nExpand source code\n\n
def cancel(self, advanced_payment_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long\n\n    Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Advanced Payment cancelation response\n    """\n    cancel_object = {"status": "cancelled"}\n    return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                     data=cancel_object, request_options=request_options)
\n
\n
\n
\ndef capture(self, advanced_payment_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
advanced_payment_id : str
\n
The Advanced Payment ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance
\n
\n

of RequestOptions can be pass changing or adding custom options to ur REST\ncall. Defaults to None.

\n

Returns

\n
\n
dict
\n
Advanced Payment capture response
\n
\n
\n\nExpand source code\n\n
def capture(self, advanced_payment_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long\n\n    Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        request_options (mercadopago.config.request_options, optional): An instance\n        of RequestOptions can be pass changing or adding custom options to ur REST\n        call. Defaults to None.\n\n    Returns:\n        dict: Advanced Payment capture response\n    """\n    capture_object = {"capture": True}\n    return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                     data=capture_object, request_options=request_options)
\n
\n
\n
\ndef create(self, advanced_payment_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
advanced_payment_object : dict
\n
Advanced Payment to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance
\n
\n

of RequestOptions can be pass changing or adding custom options to ur REST\ncall. Defaults to None.

\n

Raises

\n
\n
ValueError
\n
Param advanced_payment_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Advanced Payment creation response
\n
\n
\n\nExpand source code\n\n
def create(self, advanced_payment_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments/post/)  # pylint: disable=line-too-long\n\n    Args:\n        advanced_payment_object (dict): Advanced Payment to be created\n        request_options (mercadopago.config.request_options, optional): An instance\n        of RequestOptions can be pass changing or adding custom options to ur REST\n        call. Defaults to None.\n\n    Raises:\n        ValueError: Param advanced_payment_object must be a Dictionary\n\n    Returns:\n        dict: Advanced Payment creation response\n    """\n    if not isinstance(advanced_payment_object, dict):\n        raise ValueError(\n            "Param advanced_payment_object must be a Dictionary")\n\n    return self._post(uri="/v1/advanced_payments", data=advanced_payment_object,\n                      request_options=request_options)
\n
\n
\n
\ndef get(self, advanced_payment_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
advanced_payment_id : str
\n
The Advanced Payment ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance
\n
\n

of RequestOptions can be pass changing or adding custom options to ur REST\ncall. Defaults to None.

\n

Returns

\n
\n
dict
\n
Advanced Payment find response
\n
\n
\n\nExpand source code\n\n
def get(self, advanced_payment_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/get/)  # pylint: disable=line-too-long\n\n    Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        request_options (mercadopago.config.request_options, optional): An instance\n        of RequestOptions can be pass changing or adding custom options to ur REST\n        call. Defaults to None.\n\n    Returns:\n        dict: Advanced Payment find response\n    """\n    return self._get(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                     request_options=request_options)
\n
\n
\n
\ndef search(self, filters=None, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
filters : dict
\n
The search filters parameters
\n
\n

request_options (mercadopago.config.request_options, optional):\nAn instance of RequestOptions can be pass changing or adding custom options\nto ur REST call. Defaults to None.

\n

Returns

\n
\n
dict
\n
Advanced Payment search response
\n
\n
\n\nExpand source code\n\n
def search(self, filters=None, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments_id_search/get/)  # pylint: disable=line-too-long\n\n    Args:\n        filters (dict): The search filters parameters\n        request_options (mercadopago.config.request_options, optional):\n        An instance of RequestOptions can be pass changing or adding custom options\n        to ur REST call. Defaults to None.\n\n    Returns:\n        dict: Advanced Payment search response\n    """\n    return self._get(uri="/v1/advanced_payments/search", filters=filters,\n                     request_options=request_options)
\n
\n
\n
\ndef update(self, advanced_payment_id, advanced_payment_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
advanced_payment_id : str
\n
The Advanced Payment ID
\n
advanced_payment_object : dict
\n
Advanced Payment to be updated
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param advanced_payment_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Advanced Payment modification response
\n
\n
\n\nExpand source code\n\n
def update(self, advanced_payment_id, advanced_payment_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long\n\n    Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        advanced_payment_object (dict): Advanced Payment to be updated\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param advanced_payment_object must be a Dictionary\n\n    Returns:\n        dict: Advanced Payment modification response\n    """\n    if not isinstance(advanced_payment_object, dict):\n        raise ValueError(\n            "Param advanced_payment_object must be a Dictionary")\n\n    return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                     data=advanced_payment_object, request_options=request_options)
\n
\n
\n
\ndef update_release_date(self, advanced_payment_id, release_date, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
advanced_payment_id : str
\n
The Advanced Payment ID
\n
release_date : datetime
\n
Advanced Payment to be canceled
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param release_date must be a DateTime
\n
\n

Returns

\n
\n
dict
\n
Advanced Payment release date modification response
\n
\n
\n\nExpand source code\n\n
def update_release_date(self, advanced_payment_id, release_date, request_options=None):\n    """[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\n\n    Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        release_date (datetime): Advanced Payment to be canceled\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param release_date must be a DateTime\n\n    Returns:\n        dict: Advanced Payment release date modification response\n    """\n    if not isinstance(release_date, datetime):\n        raise ValueError("Param release_date must be a DateTime")\n\n    disbursement_object = {\n        "money_release_date": release_date.strftime("%Y-%m-%d %H:%M:%S.%f")}\n\n    return self._post(uri="/v1/advanced_payments/" + str(advanced_payment_id) + "/disburses",\n                      data=disbursement_object, request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/resources/card.html", "content": "\n\n\n\n\n\nmercadopago.resources.card API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.resources.card

\n
\n
\n

Module: card

\n
\n\nExpand source code\n\n
"""\n    Module: card\n"""\nfrom mercadopago.core import MPBase\n\n\nclass Card(MPBase):\n    """\n    The cards class is the way to store card data of your customers\n    safely to improve the shopping experience.\n\n    This will allow your customers to complete their purchases much\n    faster and easily, since they will not have to complete their\n    card data again.\n\n    This class must be used in conjunction with the Customer class.\n\n    [Click here for more info](https://www.mercadopago.com/developers/en/guides/online-payments/web-tokenize-checkout/customers-and-cards)  # pylint: disable=line-too-long\n    """\n\n    def list_all(self, customer_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/get/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): The Customer ID owner\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding\n            custom options to ur REST call. Defaults to None.\n\n        Returns:\n            dict: Cards find response\n        """\n        return self._get(\n            uri=f"/v1/customers/{str(customer_id)}/cards",\n            request_options=request_options,\n        )\n\n    def get(self, customer_id, card_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/get/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): The Customer ID owner\n            card_id (dict): Card ID to be found\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding\n            custom options to ur REST call. Defaults to None.\n\n        Returns:\n            dict: Card find response\n        """\n        return self._get(\n            uri=f"/v1/customers/{str(customer_id)}/cards/{str(card_id)}",\n            request_options=request_options,\n        )\n\n    def create(self, customer_id, card_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/post/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): The Customer ID owner\n            card_object (dict): Card object to be created\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding\n            custom options to ur REST call. Defaults to None.\n\n        Raises:\n            ValueError: Param card_object must be a Dictionary\n\n        Returns:\n            dict: Card creation response\n        """\n        if not isinstance(card_object, dict):\n            raise ValueError("Param card_object must be a Dictionary")\n\n        return self._post(uri="/v1/customers/" + str(customer_id)\n                          + "/cards/", data=card_object, request_options=request_options)\n\n    def update(self, customer_id, card_id, card_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): Customer ID owner\n            card_id (str): Card ID to be modified\n            card_object (dict): Values to be modified\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding\n            custom options to ur REST call. Defaults to None.\n\n        Raises:\n            ValueError: Param card_object must be a Dictionary\n\n        Returns:\n            dict: Card modification response\n        """\n        if not isinstance(card_object, dict):\n            raise ValueError("Param card_object must be a Dictionary")\n\n        return self._put(uri="/v1/customers/" + str(customer_id)\n                         + "/cards/" + str(card_id), data=card_object,\n                         request_options=request_options)\n\n    def delete(self, customer_id, card_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/delete/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): Customer ID owner\n            card_id (str): Card ID to be deleted\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding\n            custom options to ur REST call. Defaults to None.\n\n        Returns:\n            dict: Card exclusion response\n        """\n        return self._delete(uri="/v1/customers/" + str(customer_id)\n                            + "/cards/" + str(card_id), request_options=request_options)
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass Card\n(request_options, http_client)\n
\n
\n

The cards class is the way to store card data of your customers\nsafely to improve the shopping experience.

\n

This will allow your customers to complete their purchases much\nfaster and easily, since they will not have to complete their\ncard data again.

\n

This class must be used in conjunction with the Customer class.

\n

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

\n
\n\nExpand source code\n\n
class Card(MPBase):\n    """\n    The cards class is the way to store card data of your customers\n    safely to improve the shopping experience.\n\n    This will allow your customers to complete their purchases much\n    faster and easily, since they will not have to complete their\n    card data again.\n\n    This class must be used in conjunction with the Customer class.\n\n    [Click here for more info](https://www.mercadopago.com/developers/en/guides/online-payments/web-tokenize-checkout/customers-and-cards)  # pylint: disable=line-too-long\n    """\n\n    def list_all(self, customer_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/get/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): The Customer ID owner\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding\n            custom options to ur REST call. Defaults to None.\n\n        Returns:\n            dict: Cards find response\n        """\n        return self._get(\n            uri=f"/v1/customers/{str(customer_id)}/cards",\n            request_options=request_options,\n        )\n\n    def get(self, customer_id, card_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/get/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): The Customer ID owner\n            card_id (dict): Card ID to be found\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding\n            custom options to ur REST call. Defaults to None.\n\n        Returns:\n            dict: Card find response\n        """\n        return self._get(\n            uri=f"/v1/customers/{str(customer_id)}/cards/{str(card_id)}",\n            request_options=request_options,\n        )\n\n    def create(self, customer_id, card_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/post/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): The Customer ID owner\n            card_object (dict): Card object to be created\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding\n            custom options to ur REST call. Defaults to None.\n\n        Raises:\n            ValueError: Param card_object must be a Dictionary\n\n        Returns:\n            dict: Card creation response\n        """\n        if not isinstance(card_object, dict):\n            raise ValueError("Param card_object must be a Dictionary")\n\n        return self._post(uri="/v1/customers/" + str(customer_id)\n                          + "/cards/", data=card_object, request_options=request_options)\n\n    def update(self, customer_id, card_id, card_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): Customer ID owner\n            card_id (str): Card ID to be modified\n            card_object (dict): Values to be modified\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding\n            custom options to ur REST call. Defaults to None.\n\n        Raises:\n            ValueError: Param card_object must be a Dictionary\n\n        Returns:\n            dict: Card modification response\n        """\n        if not isinstance(card_object, dict):\n            raise ValueError("Param card_object must be a Dictionary")\n\n        return self._put(uri="/v1/customers/" + str(customer_id)\n                         + "/cards/" + str(card_id), data=card_object,\n                         request_options=request_options)\n\n    def delete(self, customer_id, card_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/delete/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): Customer ID owner\n            card_id (str): Card ID to be deleted\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding\n            custom options to ur REST call. Defaults to None.\n\n        Returns:\n            dict: Card exclusion response\n        """\n        return self._delete(uri="/v1/customers/" + str(customer_id)\n                            + "/cards/" + str(card_id), request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, customer_id, card_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
customer_id : str
\n
The Customer ID owner
\n
card_object : dict
\n
Card object to be created
\n
\n

request_options (mercadopago.config.request_options, optional):\nAn instance of RequestOptions can be pass changing or adding\ncustom options to ur REST call. Defaults to None.

\n

Raises

\n
\n
ValueError
\n
Param card_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Card creation response
\n
\n
\n\nExpand source code\n\n
def create(self, customer_id, card_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/post/)  # pylint: disable=line-too-long\n\n    Args:\n        customer_id (str): The Customer ID owner\n        card_object (dict): Card object to be created\n        request_options (mercadopago.config.request_options, optional):\n        An instance of RequestOptions can be pass changing or adding\n        custom options to ur REST call. Defaults to None.\n\n    Raises:\n        ValueError: Param card_object must be a Dictionary\n\n    Returns:\n        dict: Card creation response\n    """\n    if not isinstance(card_object, dict):\n        raise ValueError("Param card_object must be a Dictionary")\n\n    return self._post(uri="/v1/customers/" + str(customer_id)\n                      + "/cards/", data=card_object, request_options=request_options)
\n
\n
\n
\ndef delete(self, customer_id, card_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
customer_id : str
\n
Customer ID owner
\n
card_id : str
\n
Card ID to be deleted
\n
\n

request_options (mercadopago.config.request_options, optional):\nAn instance of RequestOptions can be pass changing or adding\ncustom options to ur REST call. Defaults to None.

\n

Returns

\n
\n
dict
\n
Card exclusion response
\n
\n
\n\nExpand source code\n\n
def delete(self, customer_id, card_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/delete/)  # pylint: disable=line-too-long\n\n    Args:\n        customer_id (str): Customer ID owner\n        card_id (str): Card ID to be deleted\n        request_options (mercadopago.config.request_options, optional):\n        An instance of RequestOptions can be pass changing or adding\n        custom options to ur REST call. Defaults to None.\n\n    Returns:\n        dict: Card exclusion response\n    """\n    return self._delete(uri="/v1/customers/" + str(customer_id)\n                        + "/cards/" + str(card_id), request_options=request_options)
\n
\n
\n
\ndef get(self, customer_id, card_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
customer_id : str
\n
The Customer ID owner
\n
card_id : dict
\n
Card ID to be found
\n
\n

request_options (mercadopago.config.request_options, optional):\nAn instance of RequestOptions can be pass changing or adding\ncustom options to ur REST call. Defaults to None.

\n

Returns

\n
\n
dict
\n
Card find response
\n
\n
\n\nExpand source code\n\n
def get(self, customer_id, card_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/get/)  # pylint: disable=line-too-long\n\n    Args:\n        customer_id (str): The Customer ID owner\n        card_id (dict): Card ID to be found\n        request_options (mercadopago.config.request_options, optional):\n        An instance of RequestOptions can be pass changing or adding\n        custom options to ur REST call. Defaults to None.\n\n    Returns:\n        dict: Card find response\n    """\n    return self._get(\n        uri=f"/v1/customers/{str(customer_id)}/cards/{str(card_id)}",\n        request_options=request_options,\n    )
\n
\n
\n
\ndef list_all(self, customer_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
customer_id : str
\n
The Customer ID owner
\n
\n

request_options (mercadopago.config.request_options, optional):\nAn instance of RequestOptions can be pass changing or adding\ncustom options to ur REST call. Defaults to None.

\n

Returns

\n
\n
dict
\n
Cards find response
\n
\n
\n\nExpand source code\n\n
def list_all(self, customer_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/get/)  # pylint: disable=line-too-long\n\n    Args:\n        customer_id (str): The Customer ID owner\n        request_options (mercadopago.config.request_options, optional):\n        An instance of RequestOptions can be pass changing or adding\n        custom options to ur REST call. Defaults to None.\n\n    Returns:\n        dict: Cards find response\n    """\n    return self._get(\n        uri=f"/v1/customers/{str(customer_id)}/cards",\n        request_options=request_options,\n    )
\n
\n
\n
\ndef update(self, customer_id, card_id, card_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
customer_id : str
\n
Customer ID owner
\n
card_id : str
\n
Card ID to be modified
\n
card_object : dict
\n
Values to be modified
\n
\n

request_options (mercadopago.config.request_options, optional):\nAn instance of RequestOptions can be pass changing or adding\ncustom options to ur REST call. Defaults to None.

\n

Raises

\n
\n
ValueError
\n
Param card_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Card modification response
\n
\n
\n\nExpand source code\n\n
def update(self, customer_id, card_id, card_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/put/)  # pylint: disable=line-too-long\n\n    Args:\n        customer_id (str): Customer ID owner\n        card_id (str): Card ID to be modified\n        card_object (dict): Values to be modified\n        request_options (mercadopago.config.request_options, optional):\n        An instance of RequestOptions can be pass changing or adding\n        custom options to ur REST call. Defaults to None.\n\n    Raises:\n        ValueError: Param card_object must be a Dictionary\n\n    Returns:\n        dict: Card modification response\n    """\n    if not isinstance(card_object, dict):\n        raise ValueError("Param card_object must be a Dictionary")\n\n    return self._put(uri="/v1/customers/" + str(customer_id)\n                     + "/cards/" + str(card_id), data=card_object,\n                     request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/resources/card_token.html", "content": "\n\n\n\n\n\nmercadopago.resources.card_token API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.resources.card_token

\n
\n
\n

Module: card_token

\n
\n\nExpand source code\n\n
"""\n    Module: card_token\n"""\nfrom mercadopago.core import MPBase\n\n\nclass CardToken(MPBase):\n    """\n    This class will allow you to send your customers card data for Mercado Pago\n    server and receive a token to complete the payments transactions.\n    """\n\n    def get(self, card_token_id, request_options=None):\n        """Args:\n            card_token_id (str): The Card Token ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Card Token find response\n        """\n        return self._get(uri="/v1/card_tokens/" + str(card_token_id),\n                         request_options=request_options)\n\n    def create(self, card_token_object, request_options=None):\n        """Args:\n            card_token_object (dict): Card Token to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param card_token_object must be a Dictionary\n\n        Returns:\n            dict: Card Token creation response\n        """\n        if not isinstance(card_token_object, dict):\n            raise ValueError("Param card_token_object must be a Dictionary")\n\n        return self._post(uri="/v1/card_tokens", data=card_token_object,\n                          request_options=request_options)
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass CardToken\n(request_options, http_client)\n
\n
\n

This class will allow you to send your customers card data for Mercado Pago\nserver and receive a token to complete the payments transactions.

\n
\n\nExpand source code\n\n
class CardToken(MPBase):\n    """\n    This class will allow you to send your customers card data for Mercado Pago\n    server and receive a token to complete the payments transactions.\n    """\n\n    def get(self, card_token_id, request_options=None):\n        """Args:\n            card_token_id (str): The Card Token ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Card Token find response\n        """\n        return self._get(uri="/v1/card_tokens/" + str(card_token_id),\n                         request_options=request_options)\n\n    def create(self, card_token_object, request_options=None):\n        """Args:\n            card_token_object (dict): Card Token to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param card_token_object must be a Dictionary\n\n        Returns:\n            dict: Card Token creation response\n        """\n        if not isinstance(card_token_object, dict):\n            raise ValueError("Param card_token_object must be a Dictionary")\n\n        return self._post(uri="/v1/card_tokens", data=card_token_object,\n                          request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, card_token_object, request_options=None)\n
\n
\n

Args

\n
\n
card_token_object : dict
\n
Card Token to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param card_token_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Card Token creation response
\n
\n
\n\nExpand source code\n\n
def create(self, card_token_object, request_options=None):\n    """Args:\n        card_token_object (dict): Card Token to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param card_token_object must be a Dictionary\n\n    Returns:\n        dict: Card Token creation response\n    """\n    if not isinstance(card_token_object, dict):\n        raise ValueError("Param card_token_object must be a Dictionary")\n\n    return self._post(uri="/v1/card_tokens", data=card_token_object,\n                      request_options=request_options)
\n
\n
\n
\ndef get(self, card_token_id, request_options=None)\n
\n
\n

Args

\n
\n
card_token_id : str
\n
The Card Token ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Card Token find response
\n
\n
\n\nExpand source code\n\n
def get(self, card_token_id, request_options=None):\n    """Args:\n        card_token_id (str): The Card Token ID\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Card Token find response\n    """\n    return self._get(uri="/v1/card_tokens/" + str(card_token_id),\n                     request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/resources/customer.html", "content": "\n\n\n\n\n\nmercadopago.resources.customer API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.resources.customer

\n
\n
\n

Module: customer

\n
\n\nExpand source code\n\n
"""\n    Module: customer\n"""\nfrom mercadopago.core import MPBase\n\n\nclass Customer(MPBase):\n    """\n    This class allows you to store customers data safely to improve the shopping experience.\n\n    This will allow your customer to complete their purchases much faster and easily when\n    used in conjunction with the Cards class.\n\n    [Click here for more info](https://mercadopago.com.br/developers/en/guides/online-payments/web-tokenize-checkout/customers-and-cards)  # pylint: disable=line-too-long\n    """\n\n    def search(self, filters=None, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers_search/get/)  # pylint: disable=line-too-long\n\n        Args:\n            filters (dict): The search filters parameters\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Customer find response\n        """\n        return self._get(uri="/v1/customers/search", filters=filters,\n                         request_options=request_options)\n\n    def get(self, customer_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/customers/_customers_id/get/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): The Customer ID owner\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Customer find response\n        """\n        return self._get(uri="/v1/customers/" + str(customer_id), request_options=request_options)\n\n    def create(self, customer_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers/post/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_object (dict): Customer object to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param customer_object must be a Dictionary\n\n        Returns:\n            dict: Customer creation response\n        """\n        if not isinstance(customer_object, dict):\n            raise ValueError("Param customer_object must be a Dictionary")\n\n        return self._post(uri="/v1/customers", data=customer_object,\n                          request_options=request_options)\n\n    def update(self, customer_id, customer_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): The Customer ID owner\n            customer_object (dict): Customer object to be updated\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValeuError: Param customer_object must be a Dictionary\n\n        Returns:\n            dict: Customer modification response\n        """\n        if not isinstance(customer_object, dict):\n            raise ValueError("Param customer_object must be a Dictionary")\n\n        return self._put(uri="/v1/customers/" + str(customer_id), data=customer_object,\n                         request_options=request_options)\n\n    def delete(self, customer_id, request_options=None):\n        """\n        Args:\n            customer_id (str): The Customer ID owner\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Customer exclusion response\n        """\n        return self._delete(uri="/v1/customers/" + str(customer_id),\n                            request_options=request_options)
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass Customer\n(request_options, http_client)\n
\n
\n

This class allows you to store customers data safely to improve the shopping experience.

\n

This will allow your customer to complete their purchases much faster and easily when\nused in conjunction with the Cards class.

\n

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

\n
\n\nExpand source code\n\n
class Customer(MPBase):\n    """\n    This class allows you to store customers data safely to improve the shopping experience.\n\n    This will allow your customer to complete their purchases much faster and easily when\n    used in conjunction with the Cards class.\n\n    [Click here for more info](https://mercadopago.com.br/developers/en/guides/online-payments/web-tokenize-checkout/customers-and-cards)  # pylint: disable=line-too-long\n    """\n\n    def search(self, filters=None, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers_search/get/)  # pylint: disable=line-too-long\n\n        Args:\n            filters (dict): The search filters parameters\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Customer find response\n        """\n        return self._get(uri="/v1/customers/search", filters=filters,\n                         request_options=request_options)\n\n    def get(self, customer_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/customers/_customers_id/get/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): The Customer ID owner\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Customer find response\n        """\n        return self._get(uri="/v1/customers/" + str(customer_id), request_options=request_options)\n\n    def create(self, customer_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers/post/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_object (dict): Customer object to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param customer_object must be a Dictionary\n\n        Returns:\n            dict: Customer creation response\n        """\n        if not isinstance(customer_object, dict):\n            raise ValueError("Param customer_object must be a Dictionary")\n\n        return self._post(uri="/v1/customers", data=customer_object,\n                          request_options=request_options)\n\n    def update(self, customer_id, customer_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): The Customer ID owner\n            customer_object (dict): Customer object to be updated\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValeuError: Param customer_object must be a Dictionary\n\n        Returns:\n            dict: Customer modification response\n        """\n        if not isinstance(customer_object, dict):\n            raise ValueError("Param customer_object must be a Dictionary")\n\n        return self._put(uri="/v1/customers/" + str(customer_id), data=customer_object,\n                         request_options=request_options)\n\n    def delete(self, customer_id, request_options=None):\n        """\n        Args:\n            customer_id (str): The Customer ID owner\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Customer exclusion response\n        """\n        return self._delete(uri="/v1/customers/" + str(customer_id),\n                            request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, customer_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
customer_object : dict
\n
Customer object to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param customer_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Customer creation response
\n
\n
\n\nExpand source code\n\n
def create(self, customer_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers/post/)  # pylint: disable=line-too-long\n\n    Args:\n        customer_object (dict): Customer object to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param customer_object must be a Dictionary\n\n    Returns:\n        dict: Customer creation response\n    """\n    if not isinstance(customer_object, dict):\n        raise ValueError("Param customer_object must be a Dictionary")\n\n    return self._post(uri="/v1/customers", data=customer_object,\n                      request_options=request_options)
\n
\n
\n
\ndef delete(self, customer_id, request_options=None)\n
\n
\n

Args

\n
\n
customer_id : str
\n
The Customer ID owner
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Customer exclusion response
\n
\n
\n\nExpand source code\n\n
def delete(self, customer_id, request_options=None):\n    """\n    Args:\n        customer_id (str): The Customer ID owner\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Customer exclusion response\n    """\n    return self._delete(uri="/v1/customers/" + str(customer_id),\n                        request_options=request_options)
\n
\n
\n
\ndef get(self, customer_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
customer_id : str
\n
The Customer ID owner
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Customer find response
\n
\n
\n\nExpand source code\n\n
def get(self, customer_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/customers/_customers_id/get/)  # pylint: disable=line-too-long\n\n    Args:\n        customer_id (str): The Customer ID owner\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Customer find response\n    """\n    return self._get(uri="/v1/customers/" + str(customer_id), request_options=request_options)
\n
\n
\n
\ndef search(self, filters=None, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
filters : dict
\n
The search filters parameters
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Customer find response
\n
\n
\n\nExpand source code\n\n
def search(self, filters=None, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers_search/get/)  # pylint: disable=line-too-long\n\n    Args:\n        filters (dict): The search filters parameters\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Customer find response\n    """\n    return self._get(uri="/v1/customers/search", filters=filters,\n                     request_options=request_options)
\n
\n
\n
\ndef update(self, customer_id, customer_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
customer_id : str
\n
The Customer ID owner
\n
customer_object : dict
\n
Customer object to be updated
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValeuError
\n
Param customer_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Customer modification response
\n
\n
\n\nExpand source code\n\n
def update(self, customer_id, customer_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers_id/put/)  # pylint: disable=line-too-long\n\n    Args:\n        customer_id (str): The Customer ID owner\n        customer_object (dict): Customer object to be updated\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValeuError: Param customer_object must be a Dictionary\n\n    Returns:\n        dict: Customer modification response\n    """\n    if not isinstance(customer_object, dict):\n        raise ValueError("Param customer_object must be a Dictionary")\n\n    return self._put(uri="/v1/customers/" + str(customer_id), data=customer_object,\n                     request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/resources/disbursement_refund.html", "content": "\n\n\n\n\n\nmercadopago.resources.disbursement_refund API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.resources.disbursement_refund

\n
\n
\n

Module: disbursement_refund

\n
\n\nExpand source code\n\n
"""\n    Module: disbursement_refund\n"""\nfrom mercadopago.core import MPBase\n\n\nclass DisbursementRefund(MPBase):\n\n    """\n    Access to Advanced Payments Refunds\n    """\n\n    def list_all(self, advanced_payment_id, request_options=None):\n        """[Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Disbursement Refund find response\n        """\n        uri = f"/v1/advanced_payments/{str(advanced_payment_id)}/refunds"\n        return self._get(uri=uri, request_options=request_options)\n\n    def create_all(self, advanced_payment_id, disbursement_refund_object, request_options=None):\n        """[Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            disbursement_refund_object (dict): Disbursement Refund to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n        ValueError: Param disbursement_refund_object must be a Dictionary\n\n        Returns:\n            dict: Disbursement Refund creation all response\n        """\n        if not isinstance(disbursement_refund_object, dict):\n            raise ValueError(\n                "Param disbursement_refund_object must be a Dictionary")\n\n        return self._post(\n            uri="/v1/advanced_payments/" + str(advanced_payment_id) + "/refunds",\n            data=disbursement_refund_object,\n            request_options=request_options,\n        )\n\n    def create(self, advanced_payment_id, disbursement_id, amount, request_options=None):\n        """[Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            disbursement_id (str): Disbursement ID\n            amount: Amount to be refunded\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n        ValueError: Param amount must be a Float\n\n        Returns:\n            dict: Disbursement Refund creation response\n        """\n        if not isinstance(amount, float):\n            raise ValueError("Param amount must be a Float")\n\n        disbursement_refund_object = {"amount": amount}\n\n        uri = (\n            f"/v1/advanced_payments/{str(advanced_payment_id)}"\n            f"/disbursements/{str(disbursement_id)}/refunds"\n        )\n\n        return self._post(\n            uri=uri,\n            data=disbursement_refund_object,\n            request_options=request_options,\n        )\n\n    def save(self, advanced_payment_id, disbursement_id, disbursement_refund_object,\n             request_options=None):\n        """[Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            disbursement_id (str): Disbursement ID\n            disbursement_refund_object (dict): Disbursement Refund to be saved\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n        ValueError: Param disbursement_refund_object must be a Dictionary\n\n        Returns:\n            dict: Disbursement Refund save response\n        """\n        if not isinstance(disbursement_refund_object, dict):\n            raise ValueError(\n                "Param disbursement_refund_object must be a Dictionary")\n\n        uri = (\n            f"/v1/advanced_payments/{str(advanced_payment_id)}"\n            f"/disbursements/{str(disbursement_id)}/refunds"\n        )\n\n        return self._post(\n            uri=uri,\n            data=disbursement_refund_object,\n            request_options=request_options,\n        )
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass DisbursementRefund\n(request_options, http_client)\n
\n
\n

Access to Advanced Payments Refunds

\n
\n\nExpand source code\n\n
class DisbursementRefund(MPBase):\n\n    """\n    Access to Advanced Payments Refunds\n    """\n\n    def list_all(self, advanced_payment_id, request_options=None):\n        """[Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Disbursement Refund find response\n        """\n        uri = f"/v1/advanced_payments/{str(advanced_payment_id)}/refunds"\n        return self._get(uri=uri, request_options=request_options)\n\n    def create_all(self, advanced_payment_id, disbursement_refund_object, request_options=None):\n        """[Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            disbursement_refund_object (dict): Disbursement Refund to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n        ValueError: Param disbursement_refund_object must be a Dictionary\n\n        Returns:\n            dict: Disbursement Refund creation all response\n        """\n        if not isinstance(disbursement_refund_object, dict):\n            raise ValueError(\n                "Param disbursement_refund_object must be a Dictionary")\n\n        return self._post(\n            uri="/v1/advanced_payments/" + str(advanced_payment_id) + "/refunds",\n            data=disbursement_refund_object,\n            request_options=request_options,\n        )\n\n    def create(self, advanced_payment_id, disbursement_id, amount, request_options=None):\n        """[Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            disbursement_id (str): Disbursement ID\n            amount: Amount to be refunded\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n        ValueError: Param amount must be a Float\n\n        Returns:\n            dict: Disbursement Refund creation response\n        """\n        if not isinstance(amount, float):\n            raise ValueError("Param amount must be a Float")\n\n        disbursement_refund_object = {"amount": amount}\n\n        uri = (\n            f"/v1/advanced_payments/{str(advanced_payment_id)}"\n            f"/disbursements/{str(disbursement_id)}/refunds"\n        )\n\n        return self._post(\n            uri=uri,\n            data=disbursement_refund_object,\n            request_options=request_options,\n        )\n\n    def save(self, advanced_payment_id, disbursement_id, disbursement_refund_object,\n             request_options=None):\n        """[Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            disbursement_id (str): Disbursement ID\n            disbursement_refund_object (dict): Disbursement Refund to be saved\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n        ValueError: Param disbursement_refund_object must be a Dictionary\n\n        Returns:\n            dict: Disbursement Refund save response\n        """\n        if not isinstance(disbursement_refund_object, dict):\n            raise ValueError(\n                "Param disbursement_refund_object must be a Dictionary")\n\n        uri = (\n            f"/v1/advanced_payments/{str(advanced_payment_id)}"\n            f"/disbursements/{str(disbursement_id)}/refunds"\n        )\n\n        return self._post(\n            uri=uri,\n            data=disbursement_refund_object,\n            request_options=request_options,\n        )
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, advanced_payment_id, disbursement_id, amount, request_options=None)\n
\n
\n

[Args:\nadvanced_payment_id (str): The Advanced Payment ID\ndisbursement_id (str): Disbursement ID\namount: Amount to be refunded\nrequest_options (mercadopago.config.request_options, optional): An instance of\nRequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises:\nValueError: Param amount must be a Float

\n

Returns

\n
\n
dict
\n
Disbursement Refund creation response
\n
\n
\n\nExpand source code\n\n
def create(self, advanced_payment_id, disbursement_id, amount, request_options=None):\n    """[Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        disbursement_id (str): Disbursement ID\n        amount: Amount to be refunded\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n    ValueError: Param amount must be a Float\n\n    Returns:\n        dict: Disbursement Refund creation response\n    """\n    if not isinstance(amount, float):\n        raise ValueError("Param amount must be a Float")\n\n    disbursement_refund_object = {"amount": amount}\n\n    uri = (\n        f"/v1/advanced_payments/{str(advanced_payment_id)}"\n        f"/disbursements/{str(disbursement_id)}/refunds"\n    )\n\n    return self._post(\n        uri=uri,\n        data=disbursement_refund_object,\n        request_options=request_options,\n    )
\n
\n
\n
\ndef create_all(self, advanced_payment_id, disbursement_refund_object, request_options=None)\n
\n
\n

[Args:\nadvanced_payment_id (str): The Advanced Payment ID\ndisbursement_refund_object (dict): Disbursement Refund to be created\nrequest_options (mercadopago.config.request_options, optional): An instance of\nRequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises:\nValueError: Param disbursement_refund_object must be a Dictionary

\n

Returns

\n
\n
dict
\n
Disbursement Refund creation all response
\n
\n
\n\nExpand source code\n\n
def create_all(self, advanced_payment_id, disbursement_refund_object, request_options=None):\n    """[Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        disbursement_refund_object (dict): Disbursement Refund to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n    ValueError: Param disbursement_refund_object must be a Dictionary\n\n    Returns:\n        dict: Disbursement Refund creation all response\n    """\n    if not isinstance(disbursement_refund_object, dict):\n        raise ValueError(\n            "Param disbursement_refund_object must be a Dictionary")\n\n    return self._post(\n        uri="/v1/advanced_payments/" + str(advanced_payment_id) + "/refunds",\n        data=disbursement_refund_object,\n        request_options=request_options,\n    )
\n
\n
\n
\ndef list_all(self, advanced_payment_id, request_options=None)\n
\n
\n

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

\n

Returns

\n
\n
dict
\n
Disbursement Refund find response
\n
\n
\n\nExpand source code\n\n
def list_all(self, advanced_payment_id, request_options=None):\n    """[Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Disbursement Refund find response\n    """\n    uri = f"/v1/advanced_payments/{str(advanced_payment_id)}/refunds"\n    return self._get(uri=uri, request_options=request_options)
\n
\n
\n
\ndef save(self, advanced_payment_id, disbursement_id, disbursement_refund_object, request_options=None)\n
\n
\n

[Args:\nadvanced_payment_id (str): The Advanced Payment ID\ndisbursement_id (str): Disbursement ID\ndisbursement_refund_object (dict): Disbursement Refund to be saved\nrequest_options (mercadopago.config.request_options, optional): An instance of\nRequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises:\nValueError: Param disbursement_refund_object must be a Dictionary

\n

Returns

\n
\n
dict
\n
Disbursement Refund save response
\n
\n
\n\nExpand source code\n\n
def save(self, advanced_payment_id, disbursement_id, disbursement_refund_object,\n         request_options=None):\n    """[Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        disbursement_id (str): Disbursement ID\n        disbursement_refund_object (dict): Disbursement Refund to be saved\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n    ValueError: Param disbursement_refund_object must be a Dictionary\n\n    Returns:\n        dict: Disbursement Refund save response\n    """\n    if not isinstance(disbursement_refund_object, dict):\n        raise ValueError(\n            "Param disbursement_refund_object must be a Dictionary")\n\n    uri = (\n        f"/v1/advanced_payments/{str(advanced_payment_id)}"\n        f"/disbursements/{str(disbursement_id)}/refunds"\n    )\n\n    return self._post(\n        uri=uri,\n        data=disbursement_refund_object,\n        request_options=request_options,\n    )
\n
\n
\n
\n

Inherited members

\n\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/resources/identification_type.html", "content": "\n\n\n\n\n\nmercadopago.resources.identification_type API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.resources.identification_type

\n
\n
\n

Module: identification_type

\n
\n\nExpand source code\n\n
"""\n    Module: identification_type\n"""\nfrom mercadopago.core import MPBase\n\n\nclass IdentificationType(MPBase):\n    """\n    Access to Identification Types\n    """\n\n    def list_all(self, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/identification_types/_identification_types/get/)  # pylint: disable=line-too-long\n\n        Args:\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Identification Types find response\n        """\n        return self._get(uri="/v1/identification_types", request_options=request_options)\n\n    @property\n    def request_options(self):\n        """\n        Returns the attribute value of the function\n        """\n        return self.__request_options
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass IdentificationType\n(request_options, http_client)\n
\n
\n

Access to Identification Types

\n
\n\nExpand source code\n\n
class IdentificationType(MPBase):\n    """\n    Access to Identification Types\n    """\n\n    def list_all(self, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/identification_types/_identification_types/get/)  # pylint: disable=line-too-long\n\n        Args:\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Identification Types find response\n        """\n        return self._get(uri="/v1/identification_types", request_options=request_options)\n\n    @property\n    def request_options(self):\n        """\n        Returns the attribute value of the function\n        """\n        return self.__request_options
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef list_all(self, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Identification Types find response
\n
\n
\n\nExpand source code\n\n
def list_all(self, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/identification_types/_identification_types/get/)  # pylint: disable=line-too-long\n\n    Args:\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Identification Types find response\n    """\n    return self._get(uri="/v1/identification_types", request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/resources/index.html", "content": "\n\n\n\n\n\nmercadopago.resources API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.resources

\n
\n
\n

Module: resources/init.py

\n
\n\nExpand source code\n\n
"""\nModule: resources/__init__.py\n"""\nfrom mercadopago.config.request_options import RequestOptions\nfrom mercadopago.http.http_client import HttpClient\nfrom mercadopago.resources.advanced_payment import AdvancedPayment\nfrom mercadopago.resources.card import Card\nfrom mercadopago.resources.card_token import CardToken\nfrom mercadopago.resources.customer import Customer\nfrom mercadopago.resources.disbursement_refund import DisbursementRefund\nfrom mercadopago.resources.identification_type import IdentificationType\nfrom mercadopago.resources.merchant_order import MerchantOrder\nfrom mercadopago.resources.payment import Payment\nfrom mercadopago.resources.payment_methods import PaymentMethods\nfrom mercadopago.resources.preapproval import PreApproval\nfrom mercadopago.resources.preference import Preference\nfrom mercadopago.resources.refund import Refund\nfrom mercadopago.resources.user import User\n\n\n__all__ = (\n    'AdvancedPayment',\n    'Card',\n    'CardToken',\n    'Customer',\n    'DisbursementRefund',\n    'HttpClient',\n    'IdentificationType',\n    'MerchantOrder',\n    'Payment',\n    'PaymentMethods',\n    'PreApproval',\n    'Preference',\n    'Refund',\n    'RequestOptions',\n    'User',\n)
\n
\n
\n
\n

Sub-modules

\n
\n
mercadopago.resources.advanced_payment
\n
\n

Module: advanced_payment

\n
\n
mercadopago.resources.card
\n
\n

Module: card

\n
\n
mercadopago.resources.card_token
\n
\n

Module: card_token

\n
\n
mercadopago.resources.customer
\n
\n

Module: customer

\n
\n
mercadopago.resources.disbursement_refund
\n
\n

Module: disbursement_refund

\n
\n
mercadopago.resources.identification_type
\n
\n

Module: identification_type

\n
\n
mercadopago.resources.merchant_order
\n
\n

Module: merchant_order

\n
\n
mercadopago.resources.payment
\n
\n

Module: payment

\n
\n
mercadopago.resources.payment_methods
\n
\n

Module: payment_methods

\n
\n
mercadopago.resources.preapproval
\n
\n

Module: preapproval

\n
\n
mercadopago.resources.preference
\n
\n

Module: preference

\n
\n
mercadopago.resources.refund
\n
\n

Module: refund

\n
\n
mercadopago.resources.user
\n
\n

Module: user

\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass AdvancedPayment\n(request_options, http_client)\n
\n
\n

Access to Advanced Payments

\n
\n\nExpand source code\n\n
class AdvancedPayment(MPBase):\n    """\n    Access to Advanced Payments\n    """\n\n    def search(self, filters=None, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments_id_search/get/)  # pylint: disable=line-too-long\n\n        Args:\n            filters (dict): The search filters parameters\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding custom options\n            to ur REST call. Defaults to None.\n\n        Returns:\n            dict: Advanced Payment search response\n        """\n        return self._get(uri="/v1/advanced_payments/search", filters=filters,\n                         request_options=request_options)\n\n    def get(self, advanced_payment_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/get/)  # pylint: disable=line-too-long\n\n        Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance\n            of RequestOptions can be pass changing or adding custom options to ur REST\n            call. Defaults to None.\n\n        Returns:\n            dict: Advanced Payment find response\n        """\n        return self._get(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                         request_options=request_options)\n\n    def create(self, advanced_payment_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments/post/)  # pylint: disable=line-too-long\n\n        Args:\n            advanced_payment_object (dict): Advanced Payment to be created\n            request_options (mercadopago.config.request_options, optional): An instance\n            of RequestOptions can be pass changing or adding custom options to ur REST\n            call. Defaults to None.\n\n        Raises:\n            ValueError: Param advanced_payment_object must be a Dictionary\n\n        Returns:\n            dict: Advanced Payment creation response\n        """\n        if not isinstance(advanced_payment_object, dict):\n            raise ValueError(\n                "Param advanced_payment_object must be a Dictionary")\n\n        return self._post(uri="/v1/advanced_payments", data=advanced_payment_object,\n                          request_options=request_options)\n\n    def capture(self, advanced_payment_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance\n            of RequestOptions can be pass changing or adding custom options to ur REST\n            call. Defaults to None.\n\n        Returns:\n            dict: Advanced Payment capture response\n        """\n        capture_object = {"capture": True}\n        return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                         data=capture_object, request_options=request_options)\n\n    def update(self, advanced_payment_id, advanced_payment_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            advanced_payment_object (dict): Advanced Payment to be updated\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param advanced_payment_object must be a Dictionary\n\n        Returns:\n            dict: Advanced Payment modification response\n        """\n        if not isinstance(advanced_payment_object, dict):\n            raise ValueError(\n                "Param advanced_payment_object must be a Dictionary")\n\n        return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                         data=advanced_payment_object, request_options=request_options)\n\n    def cancel(self, advanced_payment_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Advanced Payment cancelation response\n        """\n        cancel_object = {"status": "cancelled"}\n        return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                         data=cancel_object, request_options=request_options)\n\n    def update_release_date(self, advanced_payment_id, release_date, request_options=None):\n        """[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\n\n        Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            release_date (datetime): Advanced Payment to be canceled\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param release_date must be a DateTime\n\n        Returns:\n            dict: Advanced Payment release date modification response\n        """\n        if not isinstance(release_date, datetime):\n            raise ValueError("Param release_date must be a DateTime")\n\n        disbursement_object = {\n            "money_release_date": release_date.strftime("%Y-%m-%d %H:%M:%S.%f")}\n\n        return self._post(uri="/v1/advanced_payments/" + str(advanced_payment_id) + "/disburses",\n                          data=disbursement_object, request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef cancel(self, advanced_payment_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
advanced_payment_id : str
\n
The Advanced Payment ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Advanced Payment cancelation response
\n
\n
\n\nExpand source code\n\n
def cancel(self, advanced_payment_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long\n\n    Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Advanced Payment cancelation response\n    """\n    cancel_object = {"status": "cancelled"}\n    return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                     data=cancel_object, request_options=request_options)
\n
\n
\n
\ndef capture(self, advanced_payment_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
advanced_payment_id : str
\n
The Advanced Payment ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance
\n
\n

of RequestOptions can be pass changing or adding custom options to ur REST\ncall. Defaults to None.

\n

Returns

\n
\n
dict
\n
Advanced Payment capture response
\n
\n
\n\nExpand source code\n\n
def capture(self, advanced_payment_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long\n\n    Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        request_options (mercadopago.config.request_options, optional): An instance\n        of RequestOptions can be pass changing or adding custom options to ur REST\n        call. Defaults to None.\n\n    Returns:\n        dict: Advanced Payment capture response\n    """\n    capture_object = {"capture": True}\n    return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                     data=capture_object, request_options=request_options)
\n
\n
\n
\ndef create(self, advanced_payment_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
advanced_payment_object : dict
\n
Advanced Payment to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance
\n
\n

of RequestOptions can be pass changing or adding custom options to ur REST\ncall. Defaults to None.

\n

Raises

\n
\n
ValueError
\n
Param advanced_payment_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Advanced Payment creation response
\n
\n
\n\nExpand source code\n\n
def create(self, advanced_payment_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments/post/)  # pylint: disable=line-too-long\n\n    Args:\n        advanced_payment_object (dict): Advanced Payment to be created\n        request_options (mercadopago.config.request_options, optional): An instance\n        of RequestOptions can be pass changing or adding custom options to ur REST\n        call. Defaults to None.\n\n    Raises:\n        ValueError: Param advanced_payment_object must be a Dictionary\n\n    Returns:\n        dict: Advanced Payment creation response\n    """\n    if not isinstance(advanced_payment_object, dict):\n        raise ValueError(\n            "Param advanced_payment_object must be a Dictionary")\n\n    return self._post(uri="/v1/advanced_payments", data=advanced_payment_object,\n                      request_options=request_options)
\n
\n
\n
\ndef get(self, advanced_payment_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
advanced_payment_id : str
\n
The Advanced Payment ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance
\n
\n

of RequestOptions can be pass changing or adding custom options to ur REST\ncall. Defaults to None.

\n

Returns

\n
\n
dict
\n
Advanced Payment find response
\n
\n
\n\nExpand source code\n\n
def get(self, advanced_payment_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/get/)  # pylint: disable=line-too-long\n\n    Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        request_options (mercadopago.config.request_options, optional): An instance\n        of RequestOptions can be pass changing or adding custom options to ur REST\n        call. Defaults to None.\n\n    Returns:\n        dict: Advanced Payment find response\n    """\n    return self._get(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                     request_options=request_options)
\n
\n
\n
\ndef search(self, filters=None, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
filters : dict
\n
The search filters parameters
\n
\n

request_options (mercadopago.config.request_options, optional):\nAn instance of RequestOptions can be pass changing or adding custom options\nto ur REST call. Defaults to None.

\n

Returns

\n
\n
dict
\n
Advanced Payment search response
\n
\n
\n\nExpand source code\n\n
def search(self, filters=None, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments_id_search/get/)  # pylint: disable=line-too-long\n\n    Args:\n        filters (dict): The search filters parameters\n        request_options (mercadopago.config.request_options, optional):\n        An instance of RequestOptions can be pass changing or adding custom options\n        to ur REST call. Defaults to None.\n\n    Returns:\n        dict: Advanced Payment search response\n    """\n    return self._get(uri="/v1/advanced_payments/search", filters=filters,\n                     request_options=request_options)
\n
\n
\n
\ndef update(self, advanced_payment_id, advanced_payment_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
advanced_payment_id : str
\n
The Advanced Payment ID
\n
advanced_payment_object : dict
\n
Advanced Payment to be updated
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param advanced_payment_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Advanced Payment modification response
\n
\n
\n\nExpand source code\n\n
def update(self, advanced_payment_id, advanced_payment_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/)  # pylint: disable=line-too-long\n\n    Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        advanced_payment_object (dict): Advanced Payment to be updated\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param advanced_payment_object must be a Dictionary\n\n    Returns:\n        dict: Advanced Payment modification response\n    """\n    if not isinstance(advanced_payment_object, dict):\n        raise ValueError(\n            "Param advanced_payment_object must be a Dictionary")\n\n    return self._put(uri="/v1/advanced_payments/" + str(advanced_payment_id),\n                     data=advanced_payment_object, request_options=request_options)
\n
\n
\n
\ndef update_release_date(self, advanced_payment_id, release_date, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
advanced_payment_id : str
\n
The Advanced Payment ID
\n
release_date : datetime
\n
Advanced Payment to be canceled
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param release_date must be a DateTime
\n
\n

Returns

\n
\n
dict
\n
Advanced Payment release date modification response
\n
\n
\n\nExpand source code\n\n
def update_release_date(self, advanced_payment_id, release_date, request_options=None):\n    """[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\n\n    Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        release_date (datetime): Advanced Payment to be canceled\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param release_date must be a DateTime\n\n    Returns:\n        dict: Advanced Payment release date modification response\n    """\n    if not isinstance(release_date, datetime):\n        raise ValueError("Param release_date must be a DateTime")\n\n    disbursement_object = {\n        "money_release_date": release_date.strftime("%Y-%m-%d %H:%M:%S.%f")}\n\n    return self._post(uri="/v1/advanced_payments/" + str(advanced_payment_id) + "/disburses",\n                      data=disbursement_object, request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\nclass Card\n(request_options, http_client)\n
\n
\n

The cards class is the way to store card data of your customers\nsafely to improve the shopping experience.

\n

This will allow your customers to complete their purchases much\nfaster and easily, since they will not have to complete their\ncard data again.

\n

This class must be used in conjunction with the Customer class.

\n

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

\n
\n\nExpand source code\n\n
class Card(MPBase):\n    """\n    The cards class is the way to store card data of your customers\n    safely to improve the shopping experience.\n\n    This will allow your customers to complete their purchases much\n    faster and easily, since they will not have to complete their\n    card data again.\n\n    This class must be used in conjunction with the Customer class.\n\n    [Click here for more info](https://www.mercadopago.com/developers/en/guides/online-payments/web-tokenize-checkout/customers-and-cards)  # pylint: disable=line-too-long\n    """\n\n    def list_all(self, customer_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/get/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): The Customer ID owner\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding\n            custom options to ur REST call. Defaults to None.\n\n        Returns:\n            dict: Cards find response\n        """\n        return self._get(\n            uri=f"/v1/customers/{str(customer_id)}/cards",\n            request_options=request_options,\n        )\n\n    def get(self, customer_id, card_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/get/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): The Customer ID owner\n            card_id (dict): Card ID to be found\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding\n            custom options to ur REST call. Defaults to None.\n\n        Returns:\n            dict: Card find response\n        """\n        return self._get(\n            uri=f"/v1/customers/{str(customer_id)}/cards/{str(card_id)}",\n            request_options=request_options,\n        )\n\n    def create(self, customer_id, card_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/post/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): The Customer ID owner\n            card_object (dict): Card object to be created\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding\n            custom options to ur REST call. Defaults to None.\n\n        Raises:\n            ValueError: Param card_object must be a Dictionary\n\n        Returns:\n            dict: Card creation response\n        """\n        if not isinstance(card_object, dict):\n            raise ValueError("Param card_object must be a Dictionary")\n\n        return self._post(uri="/v1/customers/" + str(customer_id)\n                          + "/cards/", data=card_object, request_options=request_options)\n\n    def update(self, customer_id, card_id, card_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): Customer ID owner\n            card_id (str): Card ID to be modified\n            card_object (dict): Values to be modified\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding\n            custom options to ur REST call. Defaults to None.\n\n        Raises:\n            ValueError: Param card_object must be a Dictionary\n\n        Returns:\n            dict: Card modification response\n        """\n        if not isinstance(card_object, dict):\n            raise ValueError("Param card_object must be a Dictionary")\n\n        return self._put(uri="/v1/customers/" + str(customer_id)\n                         + "/cards/" + str(card_id), data=card_object,\n                         request_options=request_options)\n\n    def delete(self, customer_id, card_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/delete/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): Customer ID owner\n            card_id (str): Card ID to be deleted\n            request_options (mercadopago.config.request_options, optional):\n            An instance of RequestOptions can be pass changing or adding\n            custom options to ur REST call. Defaults to None.\n\n        Returns:\n            dict: Card exclusion response\n        """\n        return self._delete(uri="/v1/customers/" + str(customer_id)\n                            + "/cards/" + str(card_id), request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, customer_id, card_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
customer_id : str
\n
The Customer ID owner
\n
card_object : dict
\n
Card object to be created
\n
\n

request_options (mercadopago.config.request_options, optional):\nAn instance of RequestOptions can be pass changing or adding\ncustom options to ur REST call. Defaults to None.

\n

Raises

\n
\n
ValueError
\n
Param card_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Card creation response
\n
\n
\n\nExpand source code\n\n
def create(self, customer_id, card_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/post/)  # pylint: disable=line-too-long\n\n    Args:\n        customer_id (str): The Customer ID owner\n        card_object (dict): Card object to be created\n        request_options (mercadopago.config.request_options, optional):\n        An instance of RequestOptions can be pass changing or adding\n        custom options to ur REST call. Defaults to None.\n\n    Raises:\n        ValueError: Param card_object must be a Dictionary\n\n    Returns:\n        dict: Card creation response\n    """\n    if not isinstance(card_object, dict):\n        raise ValueError("Param card_object must be a Dictionary")\n\n    return self._post(uri="/v1/customers/" + str(customer_id)\n                      + "/cards/", data=card_object, request_options=request_options)
\n
\n
\n
\ndef delete(self, customer_id, card_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
customer_id : str
\n
Customer ID owner
\n
card_id : str
\n
Card ID to be deleted
\n
\n

request_options (mercadopago.config.request_options, optional):\nAn instance of RequestOptions can be pass changing or adding\ncustom options to ur REST call. Defaults to None.

\n

Returns

\n
\n
dict
\n
Card exclusion response
\n
\n
\n\nExpand source code\n\n
def delete(self, customer_id, card_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/delete/)  # pylint: disable=line-too-long\n\n    Args:\n        customer_id (str): Customer ID owner\n        card_id (str): Card ID to be deleted\n        request_options (mercadopago.config.request_options, optional):\n        An instance of RequestOptions can be pass changing or adding\n        custom options to ur REST call. Defaults to None.\n\n    Returns:\n        dict: Card exclusion response\n    """\n    return self._delete(uri="/v1/customers/" + str(customer_id)\n                        + "/cards/" + str(card_id), request_options=request_options)
\n
\n
\n
\ndef get(self, customer_id, card_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
customer_id : str
\n
The Customer ID owner
\n
card_id : dict
\n
Card ID to be found
\n
\n

request_options (mercadopago.config.request_options, optional):\nAn instance of RequestOptions can be pass changing or adding\ncustom options to ur REST call. Defaults to None.

\n

Returns

\n
\n
dict
\n
Card find response
\n
\n
\n\nExpand source code\n\n
def get(self, customer_id, card_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/get/)  # pylint: disable=line-too-long\n\n    Args:\n        customer_id (str): The Customer ID owner\n        card_id (dict): Card ID to be found\n        request_options (mercadopago.config.request_options, optional):\n        An instance of RequestOptions can be pass changing or adding\n        custom options to ur REST call. Defaults to None.\n\n    Returns:\n        dict: Card find response\n    """\n    return self._get(\n        uri=f"/v1/customers/{str(customer_id)}/cards/{str(card_id)}",\n        request_options=request_options,\n    )
\n
\n
\n
\ndef list_all(self, customer_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
customer_id : str
\n
The Customer ID owner
\n
\n

request_options (mercadopago.config.request_options, optional):\nAn instance of RequestOptions can be pass changing or adding\ncustom options to ur REST call. Defaults to None.

\n

Returns

\n
\n
dict
\n
Cards find response
\n
\n
\n\nExpand source code\n\n
def list_all(self, customer_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/get/)  # pylint: disable=line-too-long\n\n    Args:\n        customer_id (str): The Customer ID owner\n        request_options (mercadopago.config.request_options, optional):\n        An instance of RequestOptions can be pass changing or adding\n        custom options to ur REST call. Defaults to None.\n\n    Returns:\n        dict: Cards find response\n    """\n    return self._get(\n        uri=f"/v1/customers/{str(customer_id)}/cards",\n        request_options=request_options,\n    )
\n
\n
\n
\ndef update(self, customer_id, card_id, card_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
customer_id : str
\n
Customer ID owner
\n
card_id : str
\n
Card ID to be modified
\n
card_object : dict
\n
Values to be modified
\n
\n

request_options (mercadopago.config.request_options, optional):\nAn instance of RequestOptions can be pass changing or adding\ncustom options to ur REST call. Defaults to None.

\n

Raises

\n
\n
ValueError
\n
Param card_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Card modification response
\n
\n
\n\nExpand source code\n\n
def update(self, customer_id, card_id, card_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/put/)  # pylint: disable=line-too-long\n\n    Args:\n        customer_id (str): Customer ID owner\n        card_id (str): Card ID to be modified\n        card_object (dict): Values to be modified\n        request_options (mercadopago.config.request_options, optional):\n        An instance of RequestOptions can be pass changing or adding\n        custom options to ur REST call. Defaults to None.\n\n    Raises:\n        ValueError: Param card_object must be a Dictionary\n\n    Returns:\n        dict: Card modification response\n    """\n    if not isinstance(card_object, dict):\n        raise ValueError("Param card_object must be a Dictionary")\n\n    return self._put(uri="/v1/customers/" + str(customer_id)\n                     + "/cards/" + str(card_id), data=card_object,\n                     request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\nclass CardToken\n(request_options, http_client)\n
\n
\n

This class will allow you to send your customers card data for Mercado Pago\nserver and receive a token to complete the payments transactions.

\n
\n\nExpand source code\n\n
class CardToken(MPBase):\n    """\n    This class will allow you to send your customers card data for Mercado Pago\n    server and receive a token to complete the payments transactions.\n    """\n\n    def get(self, card_token_id, request_options=None):\n        """Args:\n            card_token_id (str): The Card Token ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Card Token find response\n        """\n        return self._get(uri="/v1/card_tokens/" + str(card_token_id),\n                         request_options=request_options)\n\n    def create(self, card_token_object, request_options=None):\n        """Args:\n            card_token_object (dict): Card Token to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param card_token_object must be a Dictionary\n\n        Returns:\n            dict: Card Token creation response\n        """\n        if not isinstance(card_token_object, dict):\n            raise ValueError("Param card_token_object must be a Dictionary")\n\n        return self._post(uri="/v1/card_tokens", data=card_token_object,\n                          request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, card_token_object, request_options=None)\n
\n
\n

Args

\n
\n
card_token_object : dict
\n
Card Token to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param card_token_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Card Token creation response
\n
\n
\n\nExpand source code\n\n
def create(self, card_token_object, request_options=None):\n    """Args:\n        card_token_object (dict): Card Token to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param card_token_object must be a Dictionary\n\n    Returns:\n        dict: Card Token creation response\n    """\n    if not isinstance(card_token_object, dict):\n        raise ValueError("Param card_token_object must be a Dictionary")\n\n    return self._post(uri="/v1/card_tokens", data=card_token_object,\n                      request_options=request_options)
\n
\n
\n
\ndef get(self, card_token_id, request_options=None)\n
\n
\n

Args

\n
\n
card_token_id : str
\n
The Card Token ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Card Token find response
\n
\n
\n\nExpand source code\n\n
def get(self, card_token_id, request_options=None):\n    """Args:\n        card_token_id (str): The Card Token ID\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Card Token find response\n    """\n    return self._get(uri="/v1/card_tokens/" + str(card_token_id),\n                     request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\nclass Customer\n(request_options, http_client)\n
\n
\n

This class allows you to store customers data safely to improve the shopping experience.

\n

This will allow your customer to complete their purchases much faster and easily when\nused in conjunction with the Cards class.

\n

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

\n
\n\nExpand source code\n\n
class Customer(MPBase):\n    """\n    This class allows you to store customers data safely to improve the shopping experience.\n\n    This will allow your customer to complete their purchases much faster and easily when\n    used in conjunction with the Cards class.\n\n    [Click here for more info](https://mercadopago.com.br/developers/en/guides/online-payments/web-tokenize-checkout/customers-and-cards)  # pylint: disable=line-too-long\n    """\n\n    def search(self, filters=None, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers_search/get/)  # pylint: disable=line-too-long\n\n        Args:\n            filters (dict): The search filters parameters\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Customer find response\n        """\n        return self._get(uri="/v1/customers/search", filters=filters,\n                         request_options=request_options)\n\n    def get(self, customer_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/customers/_customers_id/get/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): The Customer ID owner\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Customer find response\n        """\n        return self._get(uri="/v1/customers/" + str(customer_id), request_options=request_options)\n\n    def create(self, customer_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers/post/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_object (dict): Customer object to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param customer_object must be a Dictionary\n\n        Returns:\n            dict: Customer creation response\n        """\n        if not isinstance(customer_object, dict):\n            raise ValueError("Param customer_object must be a Dictionary")\n\n        return self._post(uri="/v1/customers", data=customer_object,\n                          request_options=request_options)\n\n    def update(self, customer_id, customer_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            customer_id (str): The Customer ID owner\n            customer_object (dict): Customer object to be updated\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValeuError: Param customer_object must be a Dictionary\n\n        Returns:\n            dict: Customer modification response\n        """\n        if not isinstance(customer_object, dict):\n            raise ValueError("Param customer_object must be a Dictionary")\n\n        return self._put(uri="/v1/customers/" + str(customer_id), data=customer_object,\n                         request_options=request_options)\n\n    def delete(self, customer_id, request_options=None):\n        """\n        Args:\n            customer_id (str): The Customer ID owner\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Customer exclusion response\n        """\n        return self._delete(uri="/v1/customers/" + str(customer_id),\n                            request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, customer_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
customer_object : dict
\n
Customer object to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param customer_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Customer creation response
\n
\n
\n\nExpand source code\n\n
def create(self, customer_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers/post/)  # pylint: disable=line-too-long\n\n    Args:\n        customer_object (dict): Customer object to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param customer_object must be a Dictionary\n\n    Returns:\n        dict: Customer creation response\n    """\n    if not isinstance(customer_object, dict):\n        raise ValueError("Param customer_object must be a Dictionary")\n\n    return self._post(uri="/v1/customers", data=customer_object,\n                      request_options=request_options)
\n
\n
\n
\ndef delete(self, customer_id, request_options=None)\n
\n
\n

Args

\n
\n
customer_id : str
\n
The Customer ID owner
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Customer exclusion response
\n
\n
\n\nExpand source code\n\n
def delete(self, customer_id, request_options=None):\n    """\n    Args:\n        customer_id (str): The Customer ID owner\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Customer exclusion response\n    """\n    return self._delete(uri="/v1/customers/" + str(customer_id),\n                        request_options=request_options)
\n
\n
\n
\ndef get(self, customer_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
customer_id : str
\n
The Customer ID owner
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Customer find response
\n
\n
\n\nExpand source code\n\n
def get(self, customer_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/customers/_customers_id/get/)  # pylint: disable=line-too-long\n\n    Args:\n        customer_id (str): The Customer ID owner\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Customer find response\n    """\n    return self._get(uri="/v1/customers/" + str(customer_id), request_options=request_options)
\n
\n
\n
\ndef search(self, filters=None, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
filters : dict
\n
The search filters parameters
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Customer find response
\n
\n
\n\nExpand source code\n\n
def search(self, filters=None, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers_search/get/)  # pylint: disable=line-too-long\n\n    Args:\n        filters (dict): The search filters parameters\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Customer find response\n    """\n    return self._get(uri="/v1/customers/search", filters=filters,\n                     request_options=request_options)
\n
\n
\n
\ndef update(self, customer_id, customer_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
customer_id : str
\n
The Customer ID owner
\n
customer_object : dict
\n
Customer object to be updated
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValeuError
\n
Param customer_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Customer modification response
\n
\n
\n\nExpand source code\n\n
def update(self, customer_id, customer_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers_id/put/)  # pylint: disable=line-too-long\n\n    Args:\n        customer_id (str): The Customer ID owner\n        customer_object (dict): Customer object to be updated\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValeuError: Param customer_object must be a Dictionary\n\n    Returns:\n        dict: Customer modification response\n    """\n    if not isinstance(customer_object, dict):\n        raise ValueError("Param customer_object must be a Dictionary")\n\n    return self._put(uri="/v1/customers/" + str(customer_id), data=customer_object,\n                     request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\nclass DisbursementRefund\n(request_options, http_client)\n
\n
\n

Access to Advanced Payments Refunds

\n
\n\nExpand source code\n\n
class DisbursementRefund(MPBase):\n\n    """\n    Access to Advanced Payments Refunds\n    """\n\n    def list_all(self, advanced_payment_id, request_options=None):\n        """[Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Disbursement Refund find response\n        """\n        uri = f"/v1/advanced_payments/{str(advanced_payment_id)}/refunds"\n        return self._get(uri=uri, request_options=request_options)\n\n    def create_all(self, advanced_payment_id, disbursement_refund_object, request_options=None):\n        """[Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            disbursement_refund_object (dict): Disbursement Refund to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n        ValueError: Param disbursement_refund_object must be a Dictionary\n\n        Returns:\n            dict: Disbursement Refund creation all response\n        """\n        if not isinstance(disbursement_refund_object, dict):\n            raise ValueError(\n                "Param disbursement_refund_object must be a Dictionary")\n\n        return self._post(\n            uri="/v1/advanced_payments/" + str(advanced_payment_id) + "/refunds",\n            data=disbursement_refund_object,\n            request_options=request_options,\n        )\n\n    def create(self, advanced_payment_id, disbursement_id, amount, request_options=None):\n        """[Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            disbursement_id (str): Disbursement ID\n            amount: Amount to be refunded\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n        ValueError: Param amount must be a Float\n\n        Returns:\n            dict: Disbursement Refund creation response\n        """\n        if not isinstance(amount, float):\n            raise ValueError("Param amount must be a Float")\n\n        disbursement_refund_object = {"amount": amount}\n\n        uri = (\n            f"/v1/advanced_payments/{str(advanced_payment_id)}"\n            f"/disbursements/{str(disbursement_id)}/refunds"\n        )\n\n        return self._post(\n            uri=uri,\n            data=disbursement_refund_object,\n            request_options=request_options,\n        )\n\n    def save(self, advanced_payment_id, disbursement_id, disbursement_refund_object,\n             request_options=None):\n        """[Args:\n            advanced_payment_id (str): The Advanced Payment ID\n            disbursement_id (str): Disbursement ID\n            disbursement_refund_object (dict): Disbursement Refund to be saved\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n        ValueError: Param disbursement_refund_object must be a Dictionary\n\n        Returns:\n            dict: Disbursement Refund save response\n        """\n        if not isinstance(disbursement_refund_object, dict):\n            raise ValueError(\n                "Param disbursement_refund_object must be a Dictionary")\n\n        uri = (\n            f"/v1/advanced_payments/{str(advanced_payment_id)}"\n            f"/disbursements/{str(disbursement_id)}/refunds"\n        )\n\n        return self._post(\n            uri=uri,\n            data=disbursement_refund_object,\n            request_options=request_options,\n        )
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, advanced_payment_id, disbursement_id, amount, request_options=None)\n
\n
\n

[Args:\nadvanced_payment_id (str): The Advanced Payment ID\ndisbursement_id (str): Disbursement ID\namount: Amount to be refunded\nrequest_options (mercadopago.config.request_options, optional): An instance of\nRequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises:\nValueError: Param amount must be a Float

\n

Returns

\n
\n
dict
\n
Disbursement Refund creation response
\n
\n
\n\nExpand source code\n\n
def create(self, advanced_payment_id, disbursement_id, amount, request_options=None):\n    """[Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        disbursement_id (str): Disbursement ID\n        amount: Amount to be refunded\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n    ValueError: Param amount must be a Float\n\n    Returns:\n        dict: Disbursement Refund creation response\n    """\n    if not isinstance(amount, float):\n        raise ValueError("Param amount must be a Float")\n\n    disbursement_refund_object = {"amount": amount}\n\n    uri = (\n        f"/v1/advanced_payments/{str(advanced_payment_id)}"\n        f"/disbursements/{str(disbursement_id)}/refunds"\n    )\n\n    return self._post(\n        uri=uri,\n        data=disbursement_refund_object,\n        request_options=request_options,\n    )
\n
\n
\n
\ndef create_all(self, advanced_payment_id, disbursement_refund_object, request_options=None)\n
\n
\n

[Args:\nadvanced_payment_id (str): The Advanced Payment ID\ndisbursement_refund_object (dict): Disbursement Refund to be created\nrequest_options (mercadopago.config.request_options, optional): An instance of\nRequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises:\nValueError: Param disbursement_refund_object must be a Dictionary

\n

Returns

\n
\n
dict
\n
Disbursement Refund creation all response
\n
\n
\n\nExpand source code\n\n
def create_all(self, advanced_payment_id, disbursement_refund_object, request_options=None):\n    """[Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        disbursement_refund_object (dict): Disbursement Refund to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n    ValueError: Param disbursement_refund_object must be a Dictionary\n\n    Returns:\n        dict: Disbursement Refund creation all response\n    """\n    if not isinstance(disbursement_refund_object, dict):\n        raise ValueError(\n            "Param disbursement_refund_object must be a Dictionary")\n\n    return self._post(\n        uri="/v1/advanced_payments/" + str(advanced_payment_id) + "/refunds",\n        data=disbursement_refund_object,\n        request_options=request_options,\n    )
\n
\n
\n
\ndef list_all(self, advanced_payment_id, request_options=None)\n
\n
\n

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

\n

Returns

\n
\n
dict
\n
Disbursement Refund find response
\n
\n
\n\nExpand source code\n\n
def list_all(self, advanced_payment_id, request_options=None):\n    """[Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Disbursement Refund find response\n    """\n    uri = f"/v1/advanced_payments/{str(advanced_payment_id)}/refunds"\n    return self._get(uri=uri, request_options=request_options)
\n
\n
\n
\ndef save(self, advanced_payment_id, disbursement_id, disbursement_refund_object, request_options=None)\n
\n
\n

[Args:\nadvanced_payment_id (str): The Advanced Payment ID\ndisbursement_id (str): Disbursement ID\ndisbursement_refund_object (dict): Disbursement Refund to be saved\nrequest_options (mercadopago.config.request_options, optional): An instance of\nRequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises:\nValueError: Param disbursement_refund_object must be a Dictionary

\n

Returns

\n
\n
dict
\n
Disbursement Refund save response
\n
\n
\n\nExpand source code\n\n
def save(self, advanced_payment_id, disbursement_id, disbursement_refund_object,\n         request_options=None):\n    """[Args:\n        advanced_payment_id (str): The Advanced Payment ID\n        disbursement_id (str): Disbursement ID\n        disbursement_refund_object (dict): Disbursement Refund to be saved\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n    ValueError: Param disbursement_refund_object must be a Dictionary\n\n    Returns:\n        dict: Disbursement Refund save response\n    """\n    if not isinstance(disbursement_refund_object, dict):\n        raise ValueError(\n            "Param disbursement_refund_object must be a Dictionary")\n\n    uri = (\n        f"/v1/advanced_payments/{str(advanced_payment_id)}"\n        f"/disbursements/{str(disbursement_id)}/refunds"\n    )\n\n    return self._post(\n        uri=uri,\n        data=disbursement_refund_object,\n        request_options=request_options,\n    )
\n
\n
\n
\n

Inherited members

\n\n
\n
\nclass HttpClient\n
\n
\n

Default implementation to call all REST API's

\n
\n\nExpand source code\n\n
class HttpClient:\n    """\n    Default implementation to call all REST API's\n    """\n\n    def request(self, method, url, maxretries=None, **kwargs):  # pylint: disable=no-self-use\n        """Makes a call to the API.\n\n        All **kwargs are passed verbatim to ``requests.request``.\n        """\n        retry_strategy = Retry(\n            total=maxretries,\n            status_forcelist=[429, 500, 502, 503, 504]\n        )\n        http = requests.Session()\n        http.mount("https://", HTTPAdapter(max_retries=retry_strategy))\n        with http as session:\n            api_result = session.request(method, url, **kwargs)\n            response = {\n                "status": api_result.status_code,\n                "response": api_result.json()\n            }\n\n        return response\n\n    def get(self, url, headers, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n        """Makes a GET request to the API"""\n        return self.request(\n            "GET",\n            url=url,\n            headers=headers,\n            params=params,\n            timeout=timeout,\n            maxretries=maxretries,\n        )\n\n    def post(self, url, headers, data=None, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n        """Makes a POST request to the API"""\n        return self.request(\n            "POST",\n            url=url,\n            headers=headers,\n            data=data,\n            params=params,\n            timeout=timeout,\n            maxretries=maxretries,\n        )\n\n    def put(self, url, headers, data=None, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n        """Makes a PUT request to the API"""\n        return self.request(\n            "PUT",\n            url=url,\n            headers=headers,\n            data=data,\n            params=params,\n            timeout=timeout,\n            maxretries=maxretries,\n        )\n\n    def delete(self, url, headers, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n        """Makes a DELETE request to the API"""\n        return self.request(\n            "DELETE",\n            url=url,\n            headers=headers,\n            params=params,\n            timeout=timeout,\n            maxretries=maxretries,\n        )
\n
\n

Methods

\n
\n
\ndef delete(self, url, headers, params=None, timeout=None, maxretries=None)\n
\n
\n

Makes a DELETE request to the API

\n
\n\nExpand source code\n\n
def delete(self, url, headers, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n    """Makes a DELETE request to the API"""\n    return self.request(\n        "DELETE",\n        url=url,\n        headers=headers,\n        params=params,\n        timeout=timeout,\n        maxretries=maxretries,\n    )
\n
\n
\n
\ndef get(self, url, headers, params=None, timeout=None, maxretries=None)\n
\n
\n

Makes a GET request to the API

\n
\n\nExpand source code\n\n
def get(self, url, headers, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n    """Makes a GET request to the API"""\n    return self.request(\n        "GET",\n        url=url,\n        headers=headers,\n        params=params,\n        timeout=timeout,\n        maxretries=maxretries,\n    )
\n
\n
\n
\ndef post(self, url, headers, data=None, params=None, timeout=None, maxretries=None)\n
\n
\n

Makes a POST request to the API

\n
\n\nExpand source code\n\n
def post(self, url, headers, data=None, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n    """Makes a POST request to the API"""\n    return self.request(\n        "POST",\n        url=url,\n        headers=headers,\n        data=data,\n        params=params,\n        timeout=timeout,\n        maxretries=maxretries,\n    )
\n
\n
\n
\ndef put(self, url, headers, data=None, params=None, timeout=None, maxretries=None)\n
\n
\n

Makes a PUT request to the API

\n
\n\nExpand source code\n\n
def put(self, url, headers, data=None, params=None, timeout=None, maxretries=None):  # pylint: disable=too-many-arguments\n    """Makes a PUT request to the API"""\n    return self.request(\n        "PUT",\n        url=url,\n        headers=headers,\n        data=data,\n        params=params,\n        timeout=timeout,\n        maxretries=maxretries,\n    )
\n
\n
\n
\ndef request(self, method, url, maxretries=None, **kwargs)\n
\n
\n

Makes a call to the API.

\n

All **kwargs are passed verbatim to requests.request.

\n
\n\nExpand source code\n\n
def request(self, method, url, maxretries=None, **kwargs):  # pylint: disable=no-self-use\n    """Makes a call to the API.\n\n    All **kwargs are passed verbatim to ``requests.request``.\n    """\n    retry_strategy = Retry(\n        total=maxretries,\n        status_forcelist=[429, 500, 502, 503, 504]\n    )\n    http = requests.Session()\n    http.mount("https://", HTTPAdapter(max_retries=retry_strategy))\n    with http as session:\n        api_result = session.request(method, url, **kwargs)\n        response = {\n            "status": api_result.status_code,\n            "response": api_result.json()\n        }\n\n    return response
\n
\n
\n
\n
\n
\nclass IdentificationType\n(request_options, http_client)\n
\n
\n

Access to Identification Types

\n
\n\nExpand source code\n\n
class IdentificationType(MPBase):\n    """\n    Access to Identification Types\n    """\n\n    def list_all(self, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/identification_types/_identification_types/get/)  # pylint: disable=line-too-long\n\n        Args:\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Identification Types find response\n        """\n        return self._get(uri="/v1/identification_types", request_options=request_options)\n\n    @property\n    def request_options(self):\n        """\n        Returns the attribute value of the function\n        """\n        return self.__request_options
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef list_all(self, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Identification Types find response
\n
\n
\n\nExpand source code\n\n
def list_all(self, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/identification_types/_identification_types/get/)  # pylint: disable=line-too-long\n\n    Args:\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Identification Types find response\n    """\n    return self._get(uri="/v1/identification_types", request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\nclass MerchantOrder\n(request_options, http_client)\n
\n
\n

This class will allow you to create and manage your orders. You can attach\none or more payments in your merchant order.

\n
\n\nExpand source code\n\n
class MerchantOrder(MPBase):\n    """\n    This class will allow you to create and manage your orders. You can attach\n    one or more payments in your merchant order.\n    """\n\n    def search(self, filters=None, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_search/get/)  # pylint: disable=line-too-long\n\n        Args:\n            filters (dict): The search filters parameters\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Merchant Order find response\n        """\n        return self._get(uri="/merchant_orders/search", filters=filters,\n                         request_options=request_options)\n\n    def get(self, merchan_order_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/get/)  # pylint: disable=line-too-long\n\n        Args:\n            merchan_order_id (str): The Merchant Order ID\n            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.\n\n        Returns:\n            dict: Cards find response\n        """\n        return self._get(uri="/merchant_orders/" + str(merchan_order_id),\n                         request_options=request_options)\n\n    def update(self, merchan_order_id, merchant_order_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            merchan_order_id (str): Merchant Order ID\n            merchant_order_object (dict): Merchant Order object to be updated\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param merchant_order_object must be a Dictionary\n\n        Returns:\n            dict: Cards modification response\n        """\n        if not isinstance(merchant_order_object, dict):\n            raise ValueError(\n                "Param merchant_order_object must be a Dictionary")\n\n        return self._put(uri="/merchant_orders/" + str(merchan_order_id),\n                         data=merchant_order_object, request_options=request_options)\n\n    def create(self, merchant_order_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders/post/)  # pylint: disable=line-too-long\n\n        Args:\n            merchant_order_object (dict): Merchant Order object to be created\n            request_options (mercadopago.config.request_options, optional): An instance of RequestOptions can be pass\n                changing or adding custom options to ur REST call. Defaults to None.\n\n        Raises:\n            ValueError: Param merchant_order_object must be a Dictionary\n\n        Returns:\n            dict: Cards creation response\n        """\n        if not isinstance(merchant_order_object, dict):\n            raise ValueError(\n                "Param merchant_order_object must be a Dictionary")\n\n        return self._post(uri="/merchant_orders", data=merchant_order_object,\n                          request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, merchant_order_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
merchant_order_object : dict
\n
Merchant Order object to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of RequestOptions can be pass\nchanging or adding custom options to ur REST call. Defaults to None.
\n
\n

Raises

\n
\n
ValueError
\n
Param merchant_order_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Cards creation response
\n
\n
\n\nExpand source code\n\n
def create(self, merchant_order_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders/post/)  # pylint: disable=line-too-long\n\n    Args:\n        merchant_order_object (dict): Merchant Order object to be created\n        request_options (mercadopago.config.request_options, optional): An instance of RequestOptions can be pass\n            changing or adding custom options to ur REST call. Defaults to None.\n\n    Raises:\n        ValueError: Param merchant_order_object must be a Dictionary\n\n    Returns:\n        dict: Cards creation response\n    """\n    if not isinstance(merchant_order_object, dict):\n        raise ValueError(\n            "Param merchant_order_object must be a Dictionary")\n\n    return self._post(uri="/merchant_orders", data=merchant_order_object,\n                      request_options=request_options)
\n
\n
\n
\ndef get(self, merchan_order_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
merchan_order_id : str
\n
The Merchant Order ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.
\n
\n

Returns

\n
\n
dict
\n
Cards find response
\n
\n
\n\nExpand source code\n\n
def get(self, merchan_order_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/get/)  # pylint: disable=line-too-long\n\n    Args:\n        merchan_order_id (str): The Merchant Order ID\n        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.\n\n    Returns:\n        dict: Cards find response\n    """\n    return self._get(uri="/merchant_orders/" + str(merchan_order_id),\n                     request_options=request_options)
\n
\n
\n
\ndef search(self, filters=None, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
filters : dict
\n
The search filters parameters
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Merchant Order find response
\n
\n
\n\nExpand source code\n\n
def search(self, filters=None, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_search/get/)  # pylint: disable=line-too-long\n\n    Args:\n        filters (dict): The search filters parameters\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Merchant Order find response\n    """\n    return self._get(uri="/merchant_orders/search", filters=filters,\n                     request_options=request_options)
\n
\n
\n
\ndef update(self, merchan_order_id, merchant_order_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
merchan_order_id : str
\n
Merchant Order ID
\n
merchant_order_object : dict
\n
Merchant Order object to be updated
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param merchant_order_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Cards modification response
\n
\n
\n\nExpand source code\n\n
def update(self, merchan_order_id, merchant_order_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_id/put/)  # pylint: disable=line-too-long\n\n    Args:\n        merchan_order_id (str): Merchant Order ID\n        merchant_order_object (dict): Merchant Order object to be updated\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param merchant_order_object must be a Dictionary\n\n    Returns:\n        dict: Cards modification response\n    """\n    if not isinstance(merchant_order_object, dict):\n        raise ValueError(\n            "Param merchant_order_object must be a Dictionary")\n\n    return self._put(uri="/merchant_orders/" + str(merchan_order_id),\n                     data=merchant_order_object, request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\nclass Payment\n(request_options, http_client)\n
\n
\n

This class provides the methods to access the API that will allow you to create\nyour own payment experience on your website.

\n

From basic to advanced configurations, you control the whole experience.

\n

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

\n
\n\nExpand source code\n\n
class Payment(MPBase):\n    """\n    This class provides the methods to access the API that will allow you to create\n    your own payment experience on your website.\n\n    From basic to advanced configurations, you control the whole experience.\n\n    [Click here for more info](https://www.mercadopago.com.br/developers/en/guides/online-payments/checkout-api/introduction/)  # pylint: disable=line-too-long\n    """\n\n    def search(self, filters=None, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments_search/get/)  # pylint: disable=line-too-long\n\n        Args:\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Payment find response\n        """\n        return self._get(uri="/v1/payments/search", filters=filters,\n                         request_options=request_options)\n\n    def get(self, payment_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments_id/get/)  # pylint: disable=line-too-long\n\n        Args:\n            payment_id (str): The Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Payment find response\n        """\n        return self._get(uri="/v1/payments/" + str(payment_id), request_options=request_options)\n\n    def create(self, payment_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments/post/)  # pylint: disable=line-too-long\n\n        Args:\n            payment_object (dict): Payment to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param payment_object must be a Dictionary\n\n        Returns:\n            dict: Payment creation response\n        """\n        if not isinstance(payment_object, dict):\n            raise ValueError("Param payment_object must be a Dictionary")\n\n        return self._post(uri="/v1/payments", data=payment_object, request_options=request_options)\n\n    def update(self, payment_id, payment_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/payments/_payments_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            payment_id (str): The Payment ID\n            payment_object (dict): Payment to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param payment_object must be a Dictionary\n\n        Returns:\n            dict: Payment modification response\n        """\n        if not isinstance(payment_object, dict):\n            raise ValueError("Param payment_object must be a Dictionary")\n\n        return self._put(uri="/v1/payments/" + str(payment_id), data=payment_object,\n                         request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, payment_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
payment_object : dict
\n
Payment to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param payment_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Payment creation response
\n
\n
\n\nExpand source code\n\n
def create(self, payment_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments/post/)  # pylint: disable=line-too-long\n\n    Args:\n        payment_object (dict): Payment to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param payment_object must be a Dictionary\n\n    Returns:\n        dict: Payment creation response\n    """\n    if not isinstance(payment_object, dict):\n        raise ValueError("Param payment_object must be a Dictionary")\n\n    return self._post(uri="/v1/payments", data=payment_object, request_options=request_options)
\n
\n
\n
\ndef get(self, payment_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
payment_id : str
\n
The Payment ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Payment find response
\n
\n
\n\nExpand source code\n\n
def get(self, payment_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments_id/get/)  # pylint: disable=line-too-long\n\n    Args:\n        payment_id (str): The Payment ID\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Payment find response\n    """\n    return self._get(uri="/v1/payments/" + str(payment_id), request_options=request_options)
\n
\n
\n
\ndef search(self, filters=None, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Payment find response
\n
\n
\n\nExpand source code\n\n
def search(self, filters=None, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments_search/get/)  # pylint: disable=line-too-long\n\n    Args:\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Payment find response\n    """\n    return self._get(uri="/v1/payments/search", filters=filters,\n                     request_options=request_options)
\n
\n
\n
\ndef update(self, payment_id, payment_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
payment_id : str
\n
The Payment ID
\n
payment_object : dict
\n
Payment to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param payment_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Payment modification response
\n
\n
\n\nExpand source code\n\n
def update(self, payment_id, payment_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/payments/_payments_id/put/)  # pylint: disable=line-too-long\n\n    Args:\n        payment_id (str): The Payment ID\n        payment_object (dict): Payment to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param payment_object must be a Dictionary\n\n    Returns:\n        dict: Payment modification response\n    """\n    if not isinstance(payment_object, dict):\n        raise ValueError("Param payment_object must be a Dictionary")\n\n    return self._put(uri="/v1/payments/" + str(payment_id), data=payment_object,\n                     request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\nclass PaymentMethods\n(request_options, http_client)\n
\n
\n

Access to Payment Methods

\n
\n\nExpand source code\n\n
class PaymentMethods(MPBase):\n    """\n    Access to Payment Methods\n    """\n\n    def list_all(self, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payment_methods/_payment_methods/get/)  # pylint: disable=line-too-long\n\n        Args:\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Payment Methods find response\n        """\n        return self._get(uri="/v1/payment_methods", request_options=request_options)\n\n    @property\n    def request_options(self):\n        """\n        Returns the attribute value of the function\n        """\n        return self.__request_options
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef list_all(self, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Payment Methods find response
\n
\n
\n\nExpand source code\n\n
def list_all(self, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payment_methods/_payment_methods/get/)  # pylint: disable=line-too-long\n\n    Args:\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Payment Methods find response\n    """\n    return self._get(uri="/v1/payment_methods", request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\nclass PreApproval\n(request_options, http_client)\n
\n
\n

This class provides the methods to access the API that will allow you to create\nyour own preapproval experience on your website.

\n

From basic to advanced configurations, you control the whole experience.

\n

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

\n
\n\nExpand source code\n\n
class PreApproval(MPBase):\n    """\n    This class provides the methods to access the API that will allow you to create\n    your own preapproval experience on your website.\n\n    From basic to advanced configurations, you control the whole experience.\n\n    [Click here for more info](https://www.mercadopago.com.br/developers/en/guides/online-payments/subscriptions/introduction)  # pylint: disable=line-too-long\n    """\n\n    def __init__(self, request_options, http_client):\n        MPBase.__init__(self, request_options, http_client)\n\n    def search(self, filters=None, request_options=None):\n        """Args:\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: PreApproval find response\n        """\n        return self._get(uri="/preapproval/search", filters=filters,\n                         request_options=request_options)\n\n    def get(self, preapproval_id, request_options=None):\n        """Args:\n            preapproval_id (str): The PreApproval ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: PreApproval find response\n        """\n        return self._get(uri="/preapproval/" + str(preapproval_id), request_options=request_options)\n\n    def create(self, preapproval_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/subscriptions/_preapproval/post/)  # pylint: disable=line-too-long\n\n        Args:\n            preapproval_object (dict): PreApproval to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param preapproval_object must be a Dictionary\n\n        Returns:\n            dict: PreApproval creation response\n        """\n        if not isinstance(preapproval_object, dict):\n            raise ValueError("Param preapproval_object must be a Dictionary")\n\n        return self._post(uri="/preapproval",\n                          data=preapproval_object, request_options=request_options)\n\n    def update(self, preapproval_id, preapproval_object, request_options=None):\n        """Args:\n            preapproval_id (str): The PreApproval ID\n            preapproval_object (dict): PreApproval to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param preapproval_object must be a Dictionary\n\n        Returns:\n            dict: PreApproval modification response\n        """\n        if not isinstance(preapproval_object, dict):\n            raise ValueError("Param preapproval_object must be a Dictionary")\n\n        return self._put(uri="/preapproval" + str(preapproval_id),\n                         data=preapproval_object, request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, preapproval_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
preapproval_object : dict
\n
PreApproval to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param preapproval_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
PreApproval creation response
\n
\n
\n\nExpand source code\n\n
def create(self, preapproval_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/subscriptions/_preapproval/post/)  # pylint: disable=line-too-long\n\n    Args:\n        preapproval_object (dict): PreApproval to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param preapproval_object must be a Dictionary\n\n    Returns:\n        dict: PreApproval creation response\n    """\n    if not isinstance(preapproval_object, dict):\n        raise ValueError("Param preapproval_object must be a Dictionary")\n\n    return self._post(uri="/preapproval",\n                      data=preapproval_object, request_options=request_options)
\n
\n
\n
\ndef get(self, preapproval_id, request_options=None)\n
\n
\n

Args

\n
\n
preapproval_id : str
\n
The PreApproval ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
PreApproval find response
\n
\n
\n\nExpand source code\n\n
def get(self, preapproval_id, request_options=None):\n    """Args:\n        preapproval_id (str): The PreApproval ID\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: PreApproval find response\n    """\n    return self._get(uri="/preapproval/" + str(preapproval_id), request_options=request_options)
\n
\n
\n
\ndef search(self, filters=None, request_options=None)\n
\n
\n

Args

\n
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
PreApproval find response
\n
\n
\n\nExpand source code\n\n
def search(self, filters=None, request_options=None):\n    """Args:\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: PreApproval find response\n    """\n    return self._get(uri="/preapproval/search", filters=filters,\n                     request_options=request_options)
\n
\n
\n
\ndef update(self, preapproval_id, preapproval_object, request_options=None)\n
\n
\n

Args

\n
\n
preapproval_id : str
\n
The PreApproval ID
\n
preapproval_object : dict
\n
PreApproval to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param preapproval_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
PreApproval modification response
\n
\n
\n\nExpand source code\n\n
def update(self, preapproval_id, preapproval_object, request_options=None):\n    """Args:\n        preapproval_id (str): The PreApproval ID\n        preapproval_object (dict): PreApproval to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param preapproval_object must be a Dictionary\n\n    Returns:\n        dict: PreApproval modification response\n    """\n    if not isinstance(preapproval_object, dict):\n        raise ValueError("Param preapproval_object must be a Dictionary")\n\n    return self._put(uri="/preapproval" + str(preapproval_id),\n                     data=preapproval_object, request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\nclass Preference\n(request_options, http_client)\n
\n
\n

This class will allow you to charge your customers through our web form\nfrom any device in a simple, fast and secure way.

\n

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

\n
\n\nExpand source code\n\n
class Preference(MPBase):\n    """\n    This class will allow you to charge your customers through our web form\n    from any device in a simple, fast and secure way.\n\n    [Click here for more info](https://www.mercadopago.com.br/developers/en/guides/online-payments/checkout-pro/introduction)  # pylint: disable=line-too-long\n    """\n\n    def get(self, preference_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences_id/get/)  # pylint: disable=line-too-long\n\n        Args:\n            preference_id (str): The Preference ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Preference find response\n        """\n        return self._get(uri="/checkout/preferences/" + str(preference_id),\n                         request_options=request_options)\n\n    def update(self, preference_id, preference_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            preference_id (str): The Preference ID\n            preference_object (dict): Values to be modified\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param preference_object must be a Dictionary\n\n        Returns:\n            dict: Preference modification response\n        """\n        if not isinstance(preference_object, dict):\n            raise ValueError("Param preference_object must be a Dictionary")\n\n        return self._put(uri="/checkout/preferences/" + str(preference_id), data=preference_object,\n                         request_options=request_options)\n\n    def create(self, preference_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences/post/) # pylint: disable=line-too-long\n\n        Args:\n            preference_object (dict): Preference object to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n                RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.\n\n        Raises:\n            ValueError: Param preference_object must be a Dictionary\n\n        Returns:\n            dict: Preference creation response\n        """\n        if not isinstance(preference_object, dict):\n            raise ValueError("Param preference_object must be a Dictionary")\n\n        return self._post(uri="/checkout/preferences", data=preference_object,\n                          request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, preference_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
preference_object : dict
\n
Preference object to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of\nRequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.
\n
\n

Raises

\n
\n
ValueError
\n
Param preference_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Preference creation response
\n
\n
\n\nExpand source code\n\n
def create(self, preference_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences/post/) # pylint: disable=line-too-long\n\n    Args:\n        preference_object (dict): Preference object to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.\n\n    Raises:\n        ValueError: Param preference_object must be a Dictionary\n\n    Returns:\n        dict: Preference creation response\n    """\n    if not isinstance(preference_object, dict):\n        raise ValueError("Param preference_object must be a Dictionary")\n\n    return self._post(uri="/checkout/preferences", data=preference_object,\n                      request_options=request_options)
\n
\n
\n
\ndef get(self, preference_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
preference_id : str
\n
The Preference ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Preference find response
\n
\n
\n\nExpand source code\n\n
def get(self, preference_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences_id/get/)  # pylint: disable=line-too-long\n\n    Args:\n        preference_id (str): The Preference ID\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Preference find response\n    """\n    return self._get(uri="/checkout/preferences/" + str(preference_id),\n                     request_options=request_options)
\n
\n
\n
\ndef update(self, preference_id, preference_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
preference_id : str
\n
The Preference ID
\n
preference_object : dict
\n
Values to be modified
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param preference_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Preference modification response
\n
\n
\n\nExpand source code\n\n
def update(self, preference_id, preference_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences_id/put/)  # pylint: disable=line-too-long\n\n    Args:\n        preference_id (str): The Preference ID\n        preference_object (dict): Values to be modified\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param preference_object must be a Dictionary\n\n    Returns:\n        dict: Preference modification response\n    """\n    if not isinstance(preference_object, dict):\n        raise ValueError("Param preference_object must be a Dictionary")\n\n    return self._put(uri="/checkout/preferences/" + str(preference_id), data=preference_object,\n                     request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\nclass Refund\n(request_options, http_client)\n
\n
\n

This class will allow you to refund payments created through the Payments class.

\n

You can refund a payment within 180 days after it was approved.

\n

You must have sufficient funds in your account in order to successfully refund\nthe payment amount. Otherwise, you will get a 400 Bad Request error.

\n

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

\n
\n\nExpand source code\n\n
class Refund(MPBase):\n    """\n    This class will allow you to refund payments created through the Payments class.\n\n    You can refund a payment within 180 days after it was approved.\n\n    You must have sufficient funds in your account in order to successfully refund\n    the payment amount. Otherwise, you will get a 400 Bad Request error.\n\n    [Click here for more info](https://www.mercadopago.com.br/developers/en/guides/manage-account/account/cancellations-and-refunds#bookmark_refunds)  # pylint: disable=line-too-long\n    """\n\n    def list_all(self, payment_id, request_options=None):\n        """Args:\n            payment_id (str): The Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: List all refunds of a payment\n        """\n        return self._get(uri="/v1/payments/" + str(payment_id) + "/refunds",\n                         request_options=request_options)\n\n    def create(self, payment_id, refund_object=None, request_options=None):\n        """Args:\n            payment_id (str): The Payment ID\n            refund_object (dict): Refund to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param refund_object must be a Dictionary\n\n        Returns:\n            dict: Refund creation response\n        """\n        if refund_object is not None and not isinstance(refund_object, dict):\n            raise ValueError("Param refund_object must be a Dictionary")\n\n        return self._post(uri="/v1/payments/" + str(payment_id) + "/refunds",\n                          data=refund_object, request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, payment_id, refund_object=None, request_options=None)\n
\n
\n

Args

\n
\n
payment_id : str
\n
The Payment ID
\n
refund_object : dict
\n
Refund to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param refund_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Refund creation response
\n
\n
\n\nExpand source code\n\n
def create(self, payment_id, refund_object=None, request_options=None):\n    """Args:\n        payment_id (str): The Payment ID\n        refund_object (dict): Refund to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param refund_object must be a Dictionary\n\n    Returns:\n        dict: Refund creation response\n    """\n    if refund_object is not None and not isinstance(refund_object, dict):\n        raise ValueError("Param refund_object must be a Dictionary")\n\n    return self._post(uri="/v1/payments/" + str(payment_id) + "/refunds",\n                      data=refund_object, request_options=request_options)
\n
\n
\n
\ndef list_all(self, payment_id, request_options=None)\n
\n
\n

Args

\n
\n
payment_id : str
\n
The Payment ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
List all refunds of a payment
\n
\n
\n\nExpand source code\n\n
def list_all(self, payment_id, request_options=None):\n    """Args:\n        payment_id (str): The Payment ID\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: List all refunds of a payment\n    """\n    return self._get(uri="/v1/payments/" + str(payment_id) + "/refunds",\n                     request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\nclass RequestOptions\n(access_token=None, connection_timeout=60.0, custom_headers=None, corporation_id=None, integrator_id=None, platform_id=None, max_retries=3)\n
\n
\n

This object hold all configurations that will be used in ur REST call.

\n

All here u can customize as well add params in the requisition header (custom_headers)

\n

Initialize

\n

Args

\n
\n
access_token : str, optional
\n
Your User Access Token. Defaults to None.
\n
connection_timeout : float, optional
\n
Time to timeout the REST call. Defaults to 60.0.
\n
custom_headers : dict, optional
\n
A Dict with params to be added to the requests params.
\n
Defaults to None.
\n
corporation_id : str, optional
\n
Your Corporation ID if any. Defaults to None.
\n
integrator_id : str, optional
\n
Your Integrator ID if any. Defaults to None.
\n
platform_id : str, optional
\n
Your Platform ID if any. Defaults to None.
\n
max_retries : int, optional
\n
How many retries must be done in case of fail.
\n
\n

Defaults to 3.

\n

Raises

\n
\n
ValueError
\n
Param access_token must be a String
\n
ValueError
\n
Param connection_timeout must be a Float
\n
ValueError
\n
Param custom_headers must be a Dictionary
\n
ValueError
\n
Param corporation_id must be a String
\n
ValueError
\n
Param integrator_id must be a String
\n
ValueError
\n
Param platform_id must be a String
\n
ValueError
\n
Param max_retries must be an Integer
\n
\n
\n\nExpand source code\n\n
class RequestOptions:  # pylint: disable=too-many-instance-attributes\n\n    """This object hold all configurations that will be used in ur REST call.\n\n    All here u can customize as well add params in the requisition header (custom_headers)\n    """\n\n    __access_token = None\n    __connection_timeout = None\n    __custom_headers = None\n    __max_retries = None\n    __corporation_id = None\n    __integrator_id = None\n    __platform_id = None\n\n    def __init__(  # pylint: disable=too-many-arguments\n        self,\n        access_token=None,\n        connection_timeout=60.0,\n        custom_headers=None,\n        corporation_id=None,\n        integrator_id=None,\n        platform_id=None,\n        max_retries=3,\n    ):\n        """Initialize\n\n        Args:\n            access_token (str, optional): Your User Access Token. Defaults to None.\n            connection_timeout (float, optional): Time to timeout the REST call. Defaults to 60.0.\n            custom_headers (dict, optional): A Dict with params to be added to the requests params.\n            Defaults to None.\n            corporation_id (str, optional): Your Corporation ID if any. Defaults to None.\n            integrator_id (str, optional): Your Integrator ID if any. Defaults to None.\n            platform_id (str, optional): Your Platform ID if any. Defaults to None.\n            max_retries (int, optional): How many retries must be done in case of fail.\n            Defaults to 3.\n\n        Raises:\n            ValueError: Param access_token must be a String\n            ValueError: Param connection_timeout must be a Float\n            ValueError: Param custom_headers must be a Dictionary\n            ValueError: Param corporation_id must be a String\n            ValueError: Param integrator_id must be a String\n            ValueError: Param platform_id must be a String\n            ValueError: Param max_retries must be an Integer\n        """\n\n        if access_token is not None:\n            self.access_token = access_token\n        if connection_timeout is not None:\n            self.connection_timeout = connection_timeout\n        if custom_headers is not None:\n            self.custom_headers = custom_headers\n        if max_retries is not None:\n            self.max_retries = max_retries\n        if corporation_id is not None:\n            self.corporation_id = corporation_id\n        if integrator_id is not None:\n            self.integrator_id = integrator_id\n        if platform_id is not None:\n            self.platform_id = platform_id\n\n        self.__config = Config()\n\n    def get_headers(self):\n        """\n        Sets the attribute values of headers\n        """\n        headers = {"Authorization": "Bearer " + self.__access_token,\n                   "x-product-id": self.__config.product_id,\n                   "x-tracking-id": self.__config.tracking_id,\n                   "x-idempotency-key": str(uuid.uuid4().int),\n                   "User-Agent": self.__config.user_agent,\n                   "Accept": self.__config.mime_json}\n\n        if self.__corporation_id is not None:\n            headers["x-corporation-id"] = self.__corporation_id\n\n        if self.__integrator_id is not None:\n            headers["x-integrator-id"] = self.__integrator_id\n\n        if self.__platform_id is not None:\n            headers["x-platform-id"] = self.__platform_id\n\n        if self.__custom_headers is not None:\n            headers.update(self.__custom_headers)\n\n        return headers\n\n    @property\n    def access_token(self):\n        """\n        Sets the attribute value and validates access_token\n        """\n        return self.__access_token\n\n    @access_token.setter\n    def access_token(self, value):\n        if not isinstance(value, str):\n            raise ValueError("Param access_token must be a String")\n        self.__access_token = value\n\n    @property\n    def connection_timeout(self):\n        """\n        Sets the attribute value and validates connection timeout\n        """\n        return self.__connection_timeout\n\n    @connection_timeout.setter\n    def connection_timeout(self, value):\n        if not isinstance(value, float):\n            raise ValueError("Param connection_timeout must be a Float")\n        self.__connection_timeout = value\n\n    @property\n    def corporation_id(self):\n        """\n        Sets the attribute value and validates corporation id\n        """\n        return self.__corporation_id\n\n    @corporation_id.setter\n    def corporation_id(self, value):\n        if not isinstance(value, str):\n            raise ValueError("Param corporation_id must be a String")\n        self.__corporation_id = value\n\n    @property\n    def custom_headers(self):\n        """\n        Sets the attribute value and validates custom headers\n        """\n        return self.__custom_headers\n\n    @custom_headers.setter\n    def custom_headers(self, value):\n        if not isinstance(value, dict):\n            raise ValueError("Param custom_headers must be a Dictionary")\n        self.__custom_headers = value\n\n    @property\n    def integrator_id(self):\n        """\n        Sets the attribute value and validates integrator id\n        """\n        return self.__integrator_id\n\n    @integrator_id.setter\n    def integrator_id(self, value):\n        if not isinstance(value, str):\n            raise ValueError("Param integrator_id must be a String")\n        self.__integrator_id = value\n\n    @property\n    def max_retries(self):\n        """\n        Sets the attribute value and validates max retries\n        """\n        return self.__max_retries\n\n    @max_retries.setter\n    def max_retries(self, value):\n        if not isinstance(value, int):\n            raise ValueError("Param max_retries must be an Integer")\n        self.__max_retries = value\n\n    @property\n    def platform_id(self):\n        """\n        Sets the attribute value and validates platform id\n        """\n        return self.__platform_id\n\n    @platform_id.setter\n    def platform_id(self, value):\n        if not isinstance(value, str):\n            raise ValueError("Param platform_id must be a String")\n        self.__platform_id = value
\n
\n

Instance variables

\n
\n
var access_token
\n
\n

Sets the attribute value and validates access_token

\n
\n\nExpand source code\n\n
@property\ndef access_token(self):\n    """\n    Sets the attribute value and validates access_token\n    """\n    return self.__access_token
\n
\n
\n
var connection_timeout
\n
\n

Sets the attribute value and validates connection timeout

\n
\n\nExpand source code\n\n
@property\ndef connection_timeout(self):\n    """\n    Sets the attribute value and validates connection timeout\n    """\n    return self.__connection_timeout
\n
\n
\n
var corporation_id
\n
\n

Sets the attribute value and validates corporation id

\n
\n\nExpand source code\n\n
@property\ndef corporation_id(self):\n    """\n    Sets the attribute value and validates corporation id\n    """\n    return self.__corporation_id
\n
\n
\n
var custom_headers
\n
\n

Sets the attribute value and validates custom headers

\n
\n\nExpand source code\n\n
@property\ndef custom_headers(self):\n    """\n    Sets the attribute value and validates custom headers\n    """\n    return self.__custom_headers
\n
\n
\n
var integrator_id
\n
\n

Sets the attribute value and validates integrator id

\n
\n\nExpand source code\n\n
@property\ndef integrator_id(self):\n    """\n    Sets the attribute value and validates integrator id\n    """\n    return self.__integrator_id
\n
\n
\n
var max_retries
\n
\n

Sets the attribute value and validates max retries

\n
\n\nExpand source code\n\n
@property\ndef max_retries(self):\n    """\n    Sets the attribute value and validates max retries\n    """\n    return self.__max_retries
\n
\n
\n
var platform_id
\n
\n

Sets the attribute value and validates platform id

\n
\n\nExpand source code\n\n
@property\ndef platform_id(self):\n    """\n    Sets the attribute value and validates platform id\n    """\n    return self.__platform_id
\n
\n
\n
\n

Methods

\n
\n
\ndef get_headers(self)\n
\n
\n

Sets the attribute values of headers

\n
\n\nExpand source code\n\n
def get_headers(self):\n    """\n    Sets the attribute values of headers\n    """\n    headers = {"Authorization": "Bearer " + self.__access_token,\n               "x-product-id": self.__config.product_id,\n               "x-tracking-id": self.__config.tracking_id,\n               "x-idempotency-key": str(uuid.uuid4().int),\n               "User-Agent": self.__config.user_agent,\n               "Accept": self.__config.mime_json}\n\n    if self.__corporation_id is not None:\n        headers["x-corporation-id"] = self.__corporation_id\n\n    if self.__integrator_id is not None:\n        headers["x-integrator-id"] = self.__integrator_id\n\n    if self.__platform_id is not None:\n        headers["x-platform-id"] = self.__platform_id\n\n    if self.__custom_headers is not None:\n        headers.update(self.__custom_headers)\n\n    return headers
\n
\n
\n
\n
\n
\nclass User\n(request_options, http_client)\n
\n
\n

Access to Users

\n
\n\nExpand source code\n\n
class User(MPBase):\n    """\n    Access to Users\n    """\n\n    def get(self, request_options=None):\n        """Args:\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: User find response\n        """\n        return self._get(uri="/users/me", request_options=request_options)\n\n    @property\n    def request_options(self):\n        """\n        Returns the attribute value of the function\n        """\n        return self.__request_options
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef get(self, request_options=None)\n
\n
\n

Args

\n
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
User find response
\n
\n
\n\nExpand source code\n\n
def get(self, request_options=None):\n    """Args:\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: User find response\n    """\n    return self._get(uri="/users/me", request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/resources/merchant_order.html", "content": "\n\n\n\n\n\nmercadopago.resources.merchant_order API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.resources.merchant_order

\n
\n
\n

Module: merchant_order

\n
\n\nExpand source code\n\n
"""\n    Module: merchant_order\n"""\nfrom mercadopago.core import MPBase\n\n\nclass MerchantOrder(MPBase):\n    """\n    This class will allow you to create and manage your orders. You can attach\n    one or more payments in your merchant order.\n    """\n\n    def search(self, filters=None, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_search/get/)  # pylint: disable=line-too-long\n\n        Args:\n            filters (dict): The search filters parameters\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Merchant Order find response\n        """\n        return self._get(uri="/merchant_orders/search", filters=filters,\n                         request_options=request_options)\n\n    def get(self, merchan_order_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/get/)  # pylint: disable=line-too-long\n\n        Args:\n            merchan_order_id (str): The Merchant Order ID\n            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.\n\n        Returns:\n            dict: Cards find response\n        """\n        return self._get(uri="/merchant_orders/" + str(merchan_order_id),\n                         request_options=request_options)\n\n    def update(self, merchan_order_id, merchant_order_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            merchan_order_id (str): Merchant Order ID\n            merchant_order_object (dict): Merchant Order object to be updated\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param merchant_order_object must be a Dictionary\n\n        Returns:\n            dict: Cards modification response\n        """\n        if not isinstance(merchant_order_object, dict):\n            raise ValueError(\n                "Param merchant_order_object must be a Dictionary")\n\n        return self._put(uri="/merchant_orders/" + str(merchan_order_id),\n                         data=merchant_order_object, request_options=request_options)\n\n    def create(self, merchant_order_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders/post/)  # pylint: disable=line-too-long\n\n        Args:\n            merchant_order_object (dict): Merchant Order object to be created\n            request_options (mercadopago.config.request_options, optional): An instance of RequestOptions can be pass\n                changing or adding custom options to ur REST call. Defaults to None.\n\n        Raises:\n            ValueError: Param merchant_order_object must be a Dictionary\n\n        Returns:\n            dict: Cards creation response\n        """\n        if not isinstance(merchant_order_object, dict):\n            raise ValueError(\n                "Param merchant_order_object must be a Dictionary")\n\n        return self._post(uri="/merchant_orders", data=merchant_order_object,\n                          request_options=request_options)
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass MerchantOrder\n(request_options, http_client)\n
\n
\n

This class will allow you to create and manage your orders. You can attach\none or more payments in your merchant order.

\n
\n\nExpand source code\n\n
class MerchantOrder(MPBase):\n    """\n    This class will allow you to create and manage your orders. You can attach\n    one or more payments in your merchant order.\n    """\n\n    def search(self, filters=None, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_search/get/)  # pylint: disable=line-too-long\n\n        Args:\n            filters (dict): The search filters parameters\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Merchant Order find response\n        """\n        return self._get(uri="/merchant_orders/search", filters=filters,\n                         request_options=request_options)\n\n    def get(self, merchan_order_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/get/)  # pylint: disable=line-too-long\n\n        Args:\n            merchan_order_id (str): The Merchant Order ID\n            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.\n\n        Returns:\n            dict: Cards find response\n        """\n        return self._get(uri="/merchant_orders/" + str(merchan_order_id),\n                         request_options=request_options)\n\n    def update(self, merchan_order_id, merchant_order_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            merchan_order_id (str): Merchant Order ID\n            merchant_order_object (dict): Merchant Order object to be updated\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param merchant_order_object must be a Dictionary\n\n        Returns:\n            dict: Cards modification response\n        """\n        if not isinstance(merchant_order_object, dict):\n            raise ValueError(\n                "Param merchant_order_object must be a Dictionary")\n\n        return self._put(uri="/merchant_orders/" + str(merchan_order_id),\n                         data=merchant_order_object, request_options=request_options)\n\n    def create(self, merchant_order_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders/post/)  # pylint: disable=line-too-long\n\n        Args:\n            merchant_order_object (dict): Merchant Order object to be created\n            request_options (mercadopago.config.request_options, optional): An instance of RequestOptions can be pass\n                changing or adding custom options to ur REST call. Defaults to None.\n\n        Raises:\n            ValueError: Param merchant_order_object must be a Dictionary\n\n        Returns:\n            dict: Cards creation response\n        """\n        if not isinstance(merchant_order_object, dict):\n            raise ValueError(\n                "Param merchant_order_object must be a Dictionary")\n\n        return self._post(uri="/merchant_orders", data=merchant_order_object,\n                          request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, merchant_order_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
merchant_order_object : dict
\n
Merchant Order object to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of RequestOptions can be pass\nchanging or adding custom options to ur REST call. Defaults to None.
\n
\n

Raises

\n
\n
ValueError
\n
Param merchant_order_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Cards creation response
\n
\n
\n\nExpand source code\n\n
def create(self, merchant_order_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders/post/)  # pylint: disable=line-too-long\n\n    Args:\n        merchant_order_object (dict): Merchant Order object to be created\n        request_options (mercadopago.config.request_options, optional): An instance of RequestOptions can be pass\n            changing or adding custom options to ur REST call. Defaults to None.\n\n    Raises:\n        ValueError: Param merchant_order_object must be a Dictionary\n\n    Returns:\n        dict: Cards creation response\n    """\n    if not isinstance(merchant_order_object, dict):\n        raise ValueError(\n            "Param merchant_order_object must be a Dictionary")\n\n    return self._post(uri="/merchant_orders", data=merchant_order_object,\n                      request_options=request_options)
\n
\n
\n
\ndef get(self, merchan_order_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
merchan_order_id : str
\n
The Merchant Order ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.
\n
\n

Returns

\n
\n
dict
\n
Cards find response
\n
\n
\n\nExpand source code\n\n
def get(self, merchan_order_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/get/)  # pylint: disable=line-too-long\n\n    Args:\n        merchan_order_id (str): The Merchant Order ID\n        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.\n\n    Returns:\n        dict: Cards find response\n    """\n    return self._get(uri="/merchant_orders/" + str(merchan_order_id),\n                     request_options=request_options)
\n
\n
\n
\ndef search(self, filters=None, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
filters : dict
\n
The search filters parameters
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Merchant Order find response
\n
\n
\n\nExpand source code\n\n
def search(self, filters=None, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_search/get/)  # pylint: disable=line-too-long\n\n    Args:\n        filters (dict): The search filters parameters\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Merchant Order find response\n    """\n    return self._get(uri="/merchant_orders/search", filters=filters,\n                     request_options=request_options)
\n
\n
\n
\ndef update(self, merchan_order_id, merchant_order_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
merchan_order_id : str
\n
Merchant Order ID
\n
merchant_order_object : dict
\n
Merchant Order object to be updated
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param merchant_order_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Cards modification response
\n
\n
\n\nExpand source code\n\n
def update(self, merchan_order_id, merchant_order_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_id/put/)  # pylint: disable=line-too-long\n\n    Args:\n        merchan_order_id (str): Merchant Order ID\n        merchant_order_object (dict): Merchant Order object to be updated\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param merchant_order_object must be a Dictionary\n\n    Returns:\n        dict: Cards modification response\n    """\n    if not isinstance(merchant_order_object, dict):\n        raise ValueError(\n            "Param merchant_order_object must be a Dictionary")\n\n    return self._put(uri="/merchant_orders/" + str(merchan_order_id),\n                     data=merchant_order_object, request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/resources/payment.html", "content": "\n\n\n\n\n\nmercadopago.resources.payment API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.resources.payment

\n
\n
\n

Module: payment

\n
\n\nExpand source code\n\n
"""\n    Module: payment\n"""\nfrom mercadopago.core import MPBase\n\n\nclass Payment(MPBase):\n    """\n    This class provides the methods to access the API that will allow you to create\n    your own payment experience on your website.\n\n    From basic to advanced configurations, you control the whole experience.\n\n    [Click here for more info](https://www.mercadopago.com.br/developers/en/guides/online-payments/checkout-api/introduction/)  # pylint: disable=line-too-long\n    """\n\n    def search(self, filters=None, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments_search/get/)  # pylint: disable=line-too-long\n\n        Args:\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Payment find response\n        """\n        return self._get(uri="/v1/payments/search", filters=filters,\n                         request_options=request_options)\n\n    def get(self, payment_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments_id/get/)  # pylint: disable=line-too-long\n\n        Args:\n            payment_id (str): The Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Payment find response\n        """\n        return self._get(uri="/v1/payments/" + str(payment_id), request_options=request_options)\n\n    def create(self, payment_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments/post/)  # pylint: disable=line-too-long\n\n        Args:\n            payment_object (dict): Payment to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param payment_object must be a Dictionary\n\n        Returns:\n            dict: Payment creation response\n        """\n        if not isinstance(payment_object, dict):\n            raise ValueError("Param payment_object must be a Dictionary")\n\n        return self._post(uri="/v1/payments", data=payment_object, request_options=request_options)\n\n    def update(self, payment_id, payment_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/payments/_payments_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            payment_id (str): The Payment ID\n            payment_object (dict): Payment to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param payment_object must be a Dictionary\n\n        Returns:\n            dict: Payment modification response\n        """\n        if not isinstance(payment_object, dict):\n            raise ValueError("Param payment_object must be a Dictionary")\n\n        return self._put(uri="/v1/payments/" + str(payment_id), data=payment_object,\n                         request_options=request_options)
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass Payment\n(request_options, http_client)\n
\n
\n

This class provides the methods to access the API that will allow you to create\nyour own payment experience on your website.

\n

From basic to advanced configurations, you control the whole experience.

\n

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

\n
\n\nExpand source code\n\n
class Payment(MPBase):\n    """\n    This class provides the methods to access the API that will allow you to create\n    your own payment experience on your website.\n\n    From basic to advanced configurations, you control the whole experience.\n\n    [Click here for more info](https://www.mercadopago.com.br/developers/en/guides/online-payments/checkout-api/introduction/)  # pylint: disable=line-too-long\n    """\n\n    def search(self, filters=None, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments_search/get/)  # pylint: disable=line-too-long\n\n        Args:\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Payment find response\n        """\n        return self._get(uri="/v1/payments/search", filters=filters,\n                         request_options=request_options)\n\n    def get(self, payment_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments_id/get/)  # pylint: disable=line-too-long\n\n        Args:\n            payment_id (str): The Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Payment find response\n        """\n        return self._get(uri="/v1/payments/" + str(payment_id), request_options=request_options)\n\n    def create(self, payment_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments/post/)  # pylint: disable=line-too-long\n\n        Args:\n            payment_object (dict): Payment to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param payment_object must be a Dictionary\n\n        Returns:\n            dict: Payment creation response\n        """\n        if not isinstance(payment_object, dict):\n            raise ValueError("Param payment_object must be a Dictionary")\n\n        return self._post(uri="/v1/payments", data=payment_object, request_options=request_options)\n\n    def update(self, payment_id, payment_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/payments/_payments_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            payment_id (str): The Payment ID\n            payment_object (dict): Payment to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param payment_object must be a Dictionary\n\n        Returns:\n            dict: Payment modification response\n        """\n        if not isinstance(payment_object, dict):\n            raise ValueError("Param payment_object must be a Dictionary")\n\n        return self._put(uri="/v1/payments/" + str(payment_id), data=payment_object,\n                         request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, payment_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
payment_object : dict
\n
Payment to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param payment_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Payment creation response
\n
\n
\n\nExpand source code\n\n
def create(self, payment_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments/post/)  # pylint: disable=line-too-long\n\n    Args:\n        payment_object (dict): Payment to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param payment_object must be a Dictionary\n\n    Returns:\n        dict: Payment creation response\n    """\n    if not isinstance(payment_object, dict):\n        raise ValueError("Param payment_object must be a Dictionary")\n\n    return self._post(uri="/v1/payments", data=payment_object, request_options=request_options)
\n
\n
\n
\ndef get(self, payment_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
payment_id : str
\n
The Payment ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Payment find response
\n
\n
\n\nExpand source code\n\n
def get(self, payment_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments_id/get/)  # pylint: disable=line-too-long\n\n    Args:\n        payment_id (str): The Payment ID\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Payment find response\n    """\n    return self._get(uri="/v1/payments/" + str(payment_id), request_options=request_options)
\n
\n
\n
\ndef search(self, filters=None, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Payment find response
\n
\n
\n\nExpand source code\n\n
def search(self, filters=None, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments_search/get/)  # pylint: disable=line-too-long\n\n    Args:\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Payment find response\n    """\n    return self._get(uri="/v1/payments/search", filters=filters,\n                     request_options=request_options)
\n
\n
\n
\ndef update(self, payment_id, payment_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
payment_id : str
\n
The Payment ID
\n
payment_object : dict
\n
Payment to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param payment_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Payment modification response
\n
\n
\n\nExpand source code\n\n
def update(self, payment_id, payment_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/payments/_payments_id/put/)  # pylint: disable=line-too-long\n\n    Args:\n        payment_id (str): The Payment ID\n        payment_object (dict): Payment to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param payment_object must be a Dictionary\n\n    Returns:\n        dict: Payment modification response\n    """\n    if not isinstance(payment_object, dict):\n        raise ValueError("Param payment_object must be a Dictionary")\n\n    return self._put(uri="/v1/payments/" + str(payment_id), data=payment_object,\n                     request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/resources/payment_methods.html", "content": "\n\n\n\n\n\nmercadopago.resources.payment_methods API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.resources.payment_methods

\n
\n
\n

Module: payment_methods

\n
\n\nExpand source code\n\n
"""\n    Module: payment_methods\n"""\nfrom mercadopago.core import MPBase\n\n\nclass PaymentMethods(MPBase):\n    """\n    Access to Payment Methods\n    """\n\n    def list_all(self, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payment_methods/_payment_methods/get/)  # pylint: disable=line-too-long\n\n        Args:\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Payment Methods find response\n        """\n        return self._get(uri="/v1/payment_methods", request_options=request_options)\n\n    @property\n    def request_options(self):\n        """\n        Returns the attribute value of the function\n        """\n        return self.__request_options
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass PaymentMethods\n(request_options, http_client)\n
\n
\n

Access to Payment Methods

\n
\n\nExpand source code\n\n
class PaymentMethods(MPBase):\n    """\n    Access to Payment Methods\n    """\n\n    def list_all(self, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payment_methods/_payment_methods/get/)  # pylint: disable=line-too-long\n\n        Args:\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Payment Methods find response\n        """\n        return self._get(uri="/v1/payment_methods", request_options=request_options)\n\n    @property\n    def request_options(self):\n        """\n        Returns the attribute value of the function\n        """\n        return self.__request_options
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef list_all(self, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Payment Methods find response
\n
\n
\n\nExpand source code\n\n
def list_all(self, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/payment_methods/_payment_methods/get/)  # pylint: disable=line-too-long\n\n    Args:\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Payment Methods find response\n    """\n    return self._get(uri="/v1/payment_methods", request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/resources/preapproval.html", "content": "\n\n\n\n\n\nmercadopago.resources.preapproval API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.resources.preapproval

\n
\n
\n

Module: preapproval

\n
\n\nExpand source code\n\n
"""\n    Module: preapproval\n"""\nfrom mercadopago.core import MPBase\n\n\nclass PreApproval(MPBase):\n    """\n    This class provides the methods to access the API that will allow you to create\n    your own preapproval experience on your website.\n\n    From basic to advanced configurations, you control the whole experience.\n\n    [Click here for more info](https://www.mercadopago.com.br/developers/en/guides/online-payments/subscriptions/introduction)  # pylint: disable=line-too-long\n    """\n\n    def __init__(self, request_options, http_client):\n        MPBase.__init__(self, request_options, http_client)\n\n    def search(self, filters=None, request_options=None):\n        """Args:\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: PreApproval find response\n        """\n        return self._get(uri="/preapproval/search", filters=filters,\n                         request_options=request_options)\n\n    def get(self, preapproval_id, request_options=None):\n        """Args:\n            preapproval_id (str): The PreApproval ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: PreApproval find response\n        """\n        return self._get(uri="/preapproval/" + str(preapproval_id), request_options=request_options)\n\n    def create(self, preapproval_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/subscriptions/_preapproval/post/)  # pylint: disable=line-too-long\n\n        Args:\n            preapproval_object (dict): PreApproval to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param preapproval_object must be a Dictionary\n\n        Returns:\n            dict: PreApproval creation response\n        """\n        if not isinstance(preapproval_object, dict):\n            raise ValueError("Param preapproval_object must be a Dictionary")\n\n        return self._post(uri="/preapproval",\n                          data=preapproval_object, request_options=request_options)\n\n    def update(self, preapproval_id, preapproval_object, request_options=None):\n        """Args:\n            preapproval_id (str): The PreApproval ID\n            preapproval_object (dict): PreApproval to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param preapproval_object must be a Dictionary\n\n        Returns:\n            dict: PreApproval modification response\n        """\n        if not isinstance(preapproval_object, dict):\n            raise ValueError("Param preapproval_object must be a Dictionary")\n\n        return self._put(uri="/preapproval" + str(preapproval_id),\n                         data=preapproval_object, request_options=request_options)
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass PreApproval\n(request_options, http_client)\n
\n
\n

This class provides the methods to access the API that will allow you to create\nyour own preapproval experience on your website.

\n

From basic to advanced configurations, you control the whole experience.

\n

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

\n
\n\nExpand source code\n\n
class PreApproval(MPBase):\n    """\n    This class provides the methods to access the API that will allow you to create\n    your own preapproval experience on your website.\n\n    From basic to advanced configurations, you control the whole experience.\n\n    [Click here for more info](https://www.mercadopago.com.br/developers/en/guides/online-payments/subscriptions/introduction)  # pylint: disable=line-too-long\n    """\n\n    def __init__(self, request_options, http_client):\n        MPBase.__init__(self, request_options, http_client)\n\n    def search(self, filters=None, request_options=None):\n        """Args:\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: PreApproval find response\n        """\n        return self._get(uri="/preapproval/search", filters=filters,\n                         request_options=request_options)\n\n    def get(self, preapproval_id, request_options=None):\n        """Args:\n            preapproval_id (str): The PreApproval ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: PreApproval find response\n        """\n        return self._get(uri="/preapproval/" + str(preapproval_id), request_options=request_options)\n\n    def create(self, preapproval_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/subscriptions/_preapproval/post/)  # pylint: disable=line-too-long\n\n        Args:\n            preapproval_object (dict): PreApproval to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param preapproval_object must be a Dictionary\n\n        Returns:\n            dict: PreApproval creation response\n        """\n        if not isinstance(preapproval_object, dict):\n            raise ValueError("Param preapproval_object must be a Dictionary")\n\n        return self._post(uri="/preapproval",\n                          data=preapproval_object, request_options=request_options)\n\n    def update(self, preapproval_id, preapproval_object, request_options=None):\n        """Args:\n            preapproval_id (str): The PreApproval ID\n            preapproval_object (dict): PreApproval to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param preapproval_object must be a Dictionary\n\n        Returns:\n            dict: PreApproval modification response\n        """\n        if not isinstance(preapproval_object, dict):\n            raise ValueError("Param preapproval_object must be a Dictionary")\n\n        return self._put(uri="/preapproval" + str(preapproval_id),\n                         data=preapproval_object, request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, preapproval_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
preapproval_object : dict
\n
PreApproval to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param preapproval_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
PreApproval creation response
\n
\n
\n\nExpand source code\n\n
def create(self, preapproval_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/subscriptions/_preapproval/post/)  # pylint: disable=line-too-long\n\n    Args:\n        preapproval_object (dict): PreApproval to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param preapproval_object must be a Dictionary\n\n    Returns:\n        dict: PreApproval creation response\n    """\n    if not isinstance(preapproval_object, dict):\n        raise ValueError("Param preapproval_object must be a Dictionary")\n\n    return self._post(uri="/preapproval",\n                      data=preapproval_object, request_options=request_options)
\n
\n
\n
\ndef get(self, preapproval_id, request_options=None)\n
\n
\n

Args

\n
\n
preapproval_id : str
\n
The PreApproval ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
PreApproval find response
\n
\n
\n\nExpand source code\n\n
def get(self, preapproval_id, request_options=None):\n    """Args:\n        preapproval_id (str): The PreApproval ID\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: PreApproval find response\n    """\n    return self._get(uri="/preapproval/" + str(preapproval_id), request_options=request_options)
\n
\n
\n
\ndef search(self, filters=None, request_options=None)\n
\n
\n

Args

\n
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
PreApproval find response
\n
\n
\n\nExpand source code\n\n
def search(self, filters=None, request_options=None):\n    """Args:\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: PreApproval find response\n    """\n    return self._get(uri="/preapproval/search", filters=filters,\n                     request_options=request_options)
\n
\n
\n
\ndef update(self, preapproval_id, preapproval_object, request_options=None)\n
\n
\n

Args

\n
\n
preapproval_id : str
\n
The PreApproval ID
\n
preapproval_object : dict
\n
PreApproval to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param preapproval_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
PreApproval modification response
\n
\n
\n\nExpand source code\n\n
def update(self, preapproval_id, preapproval_object, request_options=None):\n    """Args:\n        preapproval_id (str): The PreApproval ID\n        preapproval_object (dict): PreApproval to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param preapproval_object must be a Dictionary\n\n    Returns:\n        dict: PreApproval modification response\n    """\n    if not isinstance(preapproval_object, dict):\n        raise ValueError("Param preapproval_object must be a Dictionary")\n\n    return self._put(uri="/preapproval" + str(preapproval_id),\n                     data=preapproval_object, request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/resources/preference.html", "content": "\n\n\n\n\n\nmercadopago.resources.preference API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.resources.preference

\n
\n
\n

Module: preference

\n
\n\nExpand source code\n\n
"""\n    Module: preference\n"""\nfrom mercadopago.core import MPBase\n\n\nclass Preference(MPBase):\n    """\n    This class will allow you to charge your customers through our web form\n    from any device in a simple, fast and secure way.\n\n    [Click here for more info](https://www.mercadopago.com.br/developers/en/guides/online-payments/checkout-pro/introduction)  # pylint: disable=line-too-long\n    """\n\n    def get(self, preference_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences_id/get/)  # pylint: disable=line-too-long\n\n        Args:\n            preference_id (str): The Preference ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Preference find response\n        """\n        return self._get(uri="/checkout/preferences/" + str(preference_id),\n                         request_options=request_options)\n\n    def update(self, preference_id, preference_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            preference_id (str): The Preference ID\n            preference_object (dict): Values to be modified\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param preference_object must be a Dictionary\n\n        Returns:\n            dict: Preference modification response\n        """\n        if not isinstance(preference_object, dict):\n            raise ValueError("Param preference_object must be a Dictionary")\n\n        return self._put(uri="/checkout/preferences/" + str(preference_id), data=preference_object,\n                         request_options=request_options)\n\n    def create(self, preference_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences/post/) # pylint: disable=line-too-long\n\n        Args:\n            preference_object (dict): Preference object to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n                RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.\n\n        Raises:\n            ValueError: Param preference_object must be a Dictionary\n\n        Returns:\n            dict: Preference creation response\n        """\n        if not isinstance(preference_object, dict):\n            raise ValueError("Param preference_object must be a Dictionary")\n\n        return self._post(uri="/checkout/preferences", data=preference_object,\n                          request_options=request_options)
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass Preference\n(request_options, http_client)\n
\n
\n

This class will allow you to charge your customers through our web form\nfrom any device in a simple, fast and secure way.

\n

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

\n
\n\nExpand source code\n\n
class Preference(MPBase):\n    """\n    This class will allow you to charge your customers through our web form\n    from any device in a simple, fast and secure way.\n\n    [Click here for more info](https://www.mercadopago.com.br/developers/en/guides/online-payments/checkout-pro/introduction)  # pylint: disable=line-too-long\n    """\n\n    def get(self, preference_id, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences_id/get/)  # pylint: disable=line-too-long\n\n        Args:\n            preference_id (str): The Preference ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: Preference find response\n        """\n        return self._get(uri="/checkout/preferences/" + str(preference_id),\n                         request_options=request_options)\n\n    def update(self, preference_id, preference_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences_id/put/)  # pylint: disable=line-too-long\n\n        Args:\n            preference_id (str): The Preference ID\n            preference_object (dict): Values to be modified\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param preference_object must be a Dictionary\n\n        Returns:\n            dict: Preference modification response\n        """\n        if not isinstance(preference_object, dict):\n            raise ValueError("Param preference_object must be a Dictionary")\n\n        return self._put(uri="/checkout/preferences/" + str(preference_id), data=preference_object,\n                         request_options=request_options)\n\n    def create(self, preference_object, request_options=None):\n        """[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences/post/) # pylint: disable=line-too-long\n\n        Args:\n            preference_object (dict): Preference object to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n                RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.\n\n        Raises:\n            ValueError: Param preference_object must be a Dictionary\n\n        Returns:\n            dict: Preference creation response\n        """\n        if not isinstance(preference_object, dict):\n            raise ValueError("Param preference_object must be a Dictionary")\n\n        return self._post(uri="/checkout/preferences", data=preference_object,\n                          request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, preference_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
preference_object : dict
\n
Preference object to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of\nRequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.
\n
\n

Raises

\n
\n
ValueError
\n
Param preference_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Preference creation response
\n
\n
\n\nExpand source code\n\n
def create(self, preference_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences/post/) # pylint: disable=line-too-long\n\n    Args:\n        preference_object (dict): Preference object to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.\n\n    Raises:\n        ValueError: Param preference_object must be a Dictionary\n\n    Returns:\n        dict: Preference creation response\n    """\n    if not isinstance(preference_object, dict):\n        raise ValueError("Param preference_object must be a Dictionary")\n\n    return self._post(uri="/checkout/preferences", data=preference_object,\n                      request_options=request_options)
\n
\n
\n
\ndef get(self, preference_id, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
preference_id : str
\n
The Preference ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
Preference find response
\n
\n
\n\nExpand source code\n\n
def get(self, preference_id, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences_id/get/)  # pylint: disable=line-too-long\n\n    Args:\n        preference_id (str): The Preference ID\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: Preference find response\n    """\n    return self._get(uri="/checkout/preferences/" + str(preference_id),\n                     request_options=request_options)
\n
\n
\n
\ndef update(self, preference_id, preference_object, request_options=None)\n
\n
\n

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

\n

Args

\n
\n
preference_id : str
\n
The Preference ID
\n
preference_object : dict
\n
Values to be modified
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param preference_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Preference modification response
\n
\n
\n\nExpand source code\n\n
def update(self, preference_id, preference_object, request_options=None):\n    """[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences_id/put/)  # pylint: disable=line-too-long\n\n    Args:\n        preference_id (str): The Preference ID\n        preference_object (dict): Values to be modified\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param preference_object must be a Dictionary\n\n    Returns:\n        dict: Preference modification response\n    """\n    if not isinstance(preference_object, dict):\n        raise ValueError("Param preference_object must be a Dictionary")\n\n    return self._put(uri="/checkout/preferences/" + str(preference_id), data=preference_object,\n                     request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/resources/refund.html", "content": "\n\n\n\n\n\nmercadopago.resources.refund API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.resources.refund

\n
\n
\n

Module: refund

\n
\n\nExpand source code\n\n
"""\n    Module: refund\n"""\nfrom mercadopago.core import MPBase\n\n\nclass Refund(MPBase):\n    """\n    This class will allow you to refund payments created through the Payments class.\n\n    You can refund a payment within 180 days after it was approved.\n\n    You must have sufficient funds in your account in order to successfully refund\n    the payment amount. Otherwise, you will get a 400 Bad Request error.\n\n    [Click here for more info](https://www.mercadopago.com.br/developers/en/guides/manage-account/account/cancellations-and-refunds#bookmark_refunds)  # pylint: disable=line-too-long\n    """\n\n    def list_all(self, payment_id, request_options=None):\n        """Args:\n            payment_id (str): The Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: List all refunds of a payment\n        """\n        return self._get(uri="/v1/payments/" + str(payment_id) + "/refunds",\n                         request_options=request_options)\n\n    def create(self, payment_id, refund_object=None, request_options=None):\n        """Args:\n            payment_id (str): The Payment ID\n            refund_object (dict): Refund to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param refund_object must be a Dictionary\n\n        Returns:\n            dict: Refund creation response\n        """\n        if refund_object is not None and not isinstance(refund_object, dict):\n            raise ValueError("Param refund_object must be a Dictionary")\n\n        return self._post(uri="/v1/payments/" + str(payment_id) + "/refunds",\n                          data=refund_object, request_options=request_options)
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass Refund\n(request_options, http_client)\n
\n
\n

This class will allow you to refund payments created through the Payments class.

\n

You can refund a payment within 180 days after it was approved.

\n

You must have sufficient funds in your account in order to successfully refund\nthe payment amount. Otherwise, you will get a 400 Bad Request error.

\n

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

\n
\n\nExpand source code\n\n
class Refund(MPBase):\n    """\n    This class will allow you to refund payments created through the Payments class.\n\n    You can refund a payment within 180 days after it was approved.\n\n    You must have sufficient funds in your account in order to successfully refund\n    the payment amount. Otherwise, you will get a 400 Bad Request error.\n\n    [Click here for more info](https://www.mercadopago.com.br/developers/en/guides/manage-account/account/cancellations-and-refunds#bookmark_refunds)  # pylint: disable=line-too-long\n    """\n\n    def list_all(self, payment_id, request_options=None):\n        """Args:\n            payment_id (str): The Payment ID\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: List all refunds of a payment\n        """\n        return self._get(uri="/v1/payments/" + str(payment_id) + "/refunds",\n                         request_options=request_options)\n\n    def create(self, payment_id, refund_object=None, request_options=None):\n        """Args:\n            payment_id (str): The Payment ID\n            refund_object (dict): Refund to be created\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Raises:\n            ValueError: Param refund_object must be a Dictionary\n\n        Returns:\n            dict: Refund creation response\n        """\n        if refund_object is not None and not isinstance(refund_object, dict):\n            raise ValueError("Param refund_object must be a Dictionary")\n\n        return self._post(uri="/v1/payments/" + str(payment_id) + "/refunds",\n                          data=refund_object, request_options=request_options)
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef create(self, payment_id, refund_object=None, request_options=None)\n
\n
\n

Args

\n
\n
payment_id : str
\n
The Payment ID
\n
refund_object : dict
\n
Refund to be created
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Raises

\n
\n
ValueError
\n
Param refund_object must be a Dictionary
\n
\n

Returns

\n
\n
dict
\n
Refund creation response
\n
\n
\n\nExpand source code\n\n
def create(self, payment_id, refund_object=None, request_options=None):\n    """Args:\n        payment_id (str): The Payment ID\n        refund_object (dict): Refund to be created\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Raises:\n        ValueError: Param refund_object must be a Dictionary\n\n    Returns:\n        dict: Refund creation response\n    """\n    if refund_object is not None and not isinstance(refund_object, dict):\n        raise ValueError("Param refund_object must be a Dictionary")\n\n    return self._post(uri="/v1/payments/" + str(payment_id) + "/refunds",\n                      data=refund_object, request_options=request_options)
\n
\n
\n
\ndef list_all(self, payment_id, request_options=None)\n
\n
\n

Args

\n
\n
payment_id : str
\n
The Payment ID
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
List all refunds of a payment
\n
\n
\n\nExpand source code\n\n
def list_all(self, payment_id, request_options=None):\n    """Args:\n        payment_id (str): The Payment ID\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: List all refunds of a payment\n    """\n    return self._get(uri="/v1/payments/" + str(payment_id) + "/refunds",\n                     request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/resources/user.html", "content": "\n\n\n\n\n\nmercadopago.resources.user API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.resources.user

\n
\n
\n

Module: user

\n
\n\nExpand source code\n\n
"""\n    Module: user\n"""\nfrom mercadopago.core import MPBase\n\n\nclass User(MPBase):\n    """\n    Access to Users\n    """\n\n    def get(self, request_options=None):\n        """Args:\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: User find response\n        """\n        return self._get(uri="/users/me", request_options=request_options)\n\n    @property\n    def request_options(self):\n        """\n        Returns the attribute value of the function\n        """\n        return self.__request_options
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass User\n(request_options, http_client)\n
\n
\n

Access to Users

\n
\n\nExpand source code\n\n
class User(MPBase):\n    """\n    Access to Users\n    """\n\n    def get(self, request_options=None):\n        """Args:\n            request_options (mercadopago.config.request_options, optional): An instance of\n            RequestOptions can be pass changing or adding custom options to ur REST call.\n            Defaults to None.\n\n        Returns:\n            dict: User find response\n        """\n        return self._get(uri="/users/me", request_options=request_options)\n\n    @property\n    def request_options(self):\n        """\n        Returns the attribute value of the function\n        """\n        return self.__request_options
\n
\n

Ancestors

\n\n

Methods

\n
\n
\ndef get(self, request_options=None)\n
\n
\n

Args

\n
\n
request_options : mercadopago.config.request_options, optional
\n
An instance of
\n
\n

RequestOptions can be pass changing or adding custom options to ur REST call.\nDefaults to None.

\n

Returns

\n
\n
dict
\n
User find response
\n
\n
\n\nExpand source code\n\n
def get(self, request_options=None):\n    """Args:\n        request_options (mercadopago.config.request_options, optional): An instance of\n        RequestOptions can be pass changing or adding custom options to ur REST call.\n        Defaults to None.\n\n    Returns:\n        dict: User find response\n    """\n    return self._get(uri="/users/me", request_options=request_options)
\n
\n
\n
\n

Inherited members

\n\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "docs/sdk.html", "content": "\n\n\n\n\n\nmercadopago.sdk API documentation\n\n\n\n\n\n\n\n\n\n\n\n
\n
\n
\n

Module mercadopago.sdk

\n
\n
\n

Module: sdk

\n
\n\nExpand source code\n\n
"""\nModule: sdk\n"""\nfrom mercadopago.config import RequestOptions\nfrom mercadopago.http import HttpClient\nfrom mercadopago.resources import (\n    AdvancedPayment,\n    Card,\n    CardToken,\n    Customer,\n    DisbursementRefund,\n    IdentificationType,\n    MerchantOrder,\n    Payment,\n    PaymentMethods,\n    PreApproval,\n    Preference,\n    Refund,\n    User,\n)\n\n\nclass SDK:\n    """Generate access to all API' modules, which are:\n\n        1. Advanced Payment\n        2. Card Token\n        3. Card\n        4. Customer\n        5. Disbursement Refund\n        6. Identification Type\n        7. Merchant Order\n        8. Payment Methods\n        9. Payment\n        10. Preapproval\n        11. Preference\n        12. Refund\n        13. User\n    """\n\n    def __init__(\n        self,\n        access_token,\n        http_client=None,\n        request_options=None,\n    ):\n        """Construct ur SDK Object to have access to all APIs modules.\n        Args:\n            [Click here for more info](https://www.mercadopago.com/mlb/account/credentials)\n            http_client (mercadopago.http.http_client, optional): An implementation of\n            HttpClient can be pass to be used to make the REST calls. Defaults to None.\n            request_options (mercadopago.config.request_options, optional): An instance\n            of RequestOptions can be pass changing or adding custom options to ur REST\n            calls. Defaults to None.\n        Raises:\n            ValueError: Param request_options must be a RequestOptions Object\n        """\n\n        self.http_client = http_client\n        if http_client is None:\n            self.http_client = HttpClient()\n\n        self.request_options = request_options\n        if request_options is None:\n            self.request_options = RequestOptions()\n\n        self.request_options.access_token = access_token\n\n    def advanced_payment(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return AdvancedPayment(request_options is not None and request_options\n                               or self.request_options, self.http_client)\n\n    def card_token(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return CardToken(request_options is not None and request_options\n                         or self.request_options, self.http_client)\n\n    def card(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return Card(request_options is not None and request_options\n                    or self.request_options, self.http_client)\n\n    def customer(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return Customer(request_options is not None and request_options\n                        or self.request_options, self.http_client)\n\n    def disbursement_refund(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return DisbursementRefund(request_options is not None and request_options\n                                  or self.request_options, self.http_client)\n\n    def identification_type(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return IdentificationType(request_options is not None and request_options\n                                  or self.request_options, self.http_client)\n\n    def merchant_order(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return MerchantOrder(request_options is not None and request_options\n                             or self.request_options, self.http_client)\n\n    def payment(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return Payment(request_options is not None and request_options\n                       or self.request_options, self.http_client)\n\n    def payment_methods(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return PaymentMethods(request_options is not None and request_options\n                              or self.request_options, self.http_client)\n\n    def preapproval(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return PreApproval(request_options is not None and request_options\n                           or self.request_options, self.http_client)\n\n    def preference(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return Preference(request_options is not None and request_options\n                          or self.request_options, self.http_client)\n\n    def refund(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return Refund(request_options is not None and request_options\n                      or self.request_options, self.http_client)\n\n    def user(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return User(request_options is not None and request_options\n                    or self.request_options, self.http_client)\n\n    @property\n    def request_options(self):\n        """\n        Sets the attribute value and validates request_options\n        """\n        return self.__request_options\n\n    @request_options.setter\n    def request_options(self, value):\n        if value is not None and not isinstance(value, RequestOptions):\n            raise ValueError(\n                "Param request_options must be a RequestOptions Object")\n        self.__request_options = value\n\n    @property\n    def http_client(self):\n        """\n        Sets the attribute value and validates http_client\n        """\n        return self.__http_client\n\n    @http_client.setter\n    def http_client(self, value):\n        if value is not None and not isinstance(value, HttpClient):\n            raise ValueError("Param http_client must be a HttpClient Object")\n        self.__http_client = value
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

Classes

\n
\n
\nclass SDK\n(access_token, http_client=None, request_options=None)\n
\n
\n

Generate access to all API' modules, which are:

\n
    \n
  1. Advanced Payment
    2. \n
  2. Card Token
    3. \n
  3. Card
    4. \n
  4. Customer
    5. \n
  5. Disbursement Refund
    6. \n
  6. Identification Type
    7. \n
  7. Merchant Order
    8. \n
  8. Payment Methods
    9. \n
  9. Payment
    10. \n
  10. Preapproval
    11. \n
  11. Preference
    12. \n
  12. Refund
    13. \n
  13. User
    14. \n
\n

Construct ur SDK Object to have access to all APIs modules.

\n

Args

\n
\n
Click here for more info
\n
http_client : mercadopago.http.http_client, optional
\n
An implementation of
\n
HttpClient can be pass to be used to make the REST calls. Defaults to None.
\n
request_options : mercadopago.config.request_options, optional
\n
An instance
\n
\n

of RequestOptions can be pass changing or adding custom options to ur REST\ncalls. Defaults to None.

\n

Raises

\n
\n
ValueError
\n
Param request_options must be a RequestOptions Object
\n
\n
\n\nExpand source code\n\n
class SDK:\n    """Generate access to all API' modules, which are:\n\n        1. Advanced Payment\n        2. Card Token\n        3. Card\n        4. Customer\n        5. Disbursement Refund\n        6. Identification Type\n        7. Merchant Order\n        8. Payment Methods\n        9. Payment\n        10. Preapproval\n        11. Preference\n        12. Refund\n        13. User\n    """\n\n    def __init__(\n        self,\n        access_token,\n        http_client=None,\n        request_options=None,\n    ):\n        """Construct ur SDK Object to have access to all APIs modules.\n        Args:\n            [Click here for more info](https://www.mercadopago.com/mlb/account/credentials)\n            http_client (mercadopago.http.http_client, optional): An implementation of\n            HttpClient can be pass to be used to make the REST calls. Defaults to None.\n            request_options (mercadopago.config.request_options, optional): An instance\n            of RequestOptions can be pass changing or adding custom options to ur REST\n            calls. Defaults to None.\n        Raises:\n            ValueError: Param request_options must be a RequestOptions Object\n        """\n\n        self.http_client = http_client\n        if http_client is None:\n            self.http_client = HttpClient()\n\n        self.request_options = request_options\n        if request_options is None:\n            self.request_options = RequestOptions()\n\n        self.request_options.access_token = access_token\n\n    def advanced_payment(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return AdvancedPayment(request_options is not None and request_options\n                               or self.request_options, self.http_client)\n\n    def card_token(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return CardToken(request_options is not None and request_options\n                         or self.request_options, self.http_client)\n\n    def card(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return Card(request_options is not None and request_options\n                    or self.request_options, self.http_client)\n\n    def customer(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return Customer(request_options is not None and request_options\n                        or self.request_options, self.http_client)\n\n    def disbursement_refund(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return DisbursementRefund(request_options is not None and request_options\n                                  or self.request_options, self.http_client)\n\n    def identification_type(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return IdentificationType(request_options is not None and request_options\n                                  or self.request_options, self.http_client)\n\n    def merchant_order(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return MerchantOrder(request_options is not None and request_options\n                             or self.request_options, self.http_client)\n\n    def payment(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return Payment(request_options is not None and request_options\n                       or self.request_options, self.http_client)\n\n    def payment_methods(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return PaymentMethods(request_options is not None and request_options\n                              or self.request_options, self.http_client)\n\n    def preapproval(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return PreApproval(request_options is not None and request_options\n                           or self.request_options, self.http_client)\n\n    def preference(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return Preference(request_options is not None and request_options\n                          or self.request_options, self.http_client)\n\n    def refund(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return Refund(request_options is not None and request_options\n                      or self.request_options, self.http_client)\n\n    def user(self, request_options=None):\n        """\n        Returns the attribute value of the function\n        """\n        return User(request_options is not None and request_options\n                    or self.request_options, self.http_client)\n\n    @property\n    def request_options(self):\n        """\n        Sets the attribute value and validates request_options\n        """\n        return self.__request_options\n\n    @request_options.setter\n    def request_options(self, value):\n        if value is not None and not isinstance(value, RequestOptions):\n            raise ValueError(\n                "Param request_options must be a RequestOptions Object")\n        self.__request_options = value\n\n    @property\n    def http_client(self):\n        """\n        Sets the attribute value and validates http_client\n        """\n        return self.__http_client\n\n    @http_client.setter\n    def http_client(self, value):\n        if value is not None and not isinstance(value, HttpClient):\n            raise ValueError("Param http_client must be a HttpClient Object")\n        self.__http_client = value
\n
\n

Instance variables

\n
\n
var http_client
\n
\n

Sets the attribute value and validates http_client

\n
\n\nExpand source code\n\n
@property\ndef http_client(self):\n    """\n    Sets the attribute value and validates http_client\n    """\n    return self.__http_client
\n
\n
\n
var request_options
\n
\n

Sets the attribute value and validates request_options

\n
\n\nExpand source code\n\n
@property\ndef request_options(self):\n    """\n    Sets the attribute value and validates request_options\n    """\n    return self.__request_options
\n
\n
\n
\n

Methods

\n
\n
\ndef advanced_payment(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def advanced_payment(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return AdvancedPayment(request_options is not None and request_options\n                           or self.request_options, self.http_client)
\n
\n
\n
\ndef card(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def card(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return Card(request_options is not None and request_options\n                or self.request_options, self.http_client)
\n
\n
\n
\ndef card_token(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def card_token(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return CardToken(request_options is not None and request_options\n                     or self.request_options, self.http_client)
\n
\n
\n
\ndef customer(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def customer(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return Customer(request_options is not None and request_options\n                    or self.request_options, self.http_client)
\n
\n
\n
\ndef disbursement_refund(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def disbursement_refund(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return DisbursementRefund(request_options is not None and request_options\n                              or self.request_options, self.http_client)
\n
\n
\n
\ndef identification_type(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def identification_type(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return IdentificationType(request_options is not None and request_options\n                              or self.request_options, self.http_client)
\n
\n
\n
\ndef merchant_order(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def merchant_order(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return MerchantOrder(request_options is not None and request_options\n                         or self.request_options, self.http_client)
\n
\n
\n
\ndef payment(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def payment(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return Payment(request_options is not None and request_options\n                   or self.request_options, self.http_client)
\n
\n
\n
\ndef payment_methods(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def payment_methods(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return PaymentMethods(request_options is not None and request_options\n                          or self.request_options, self.http_client)
\n
\n
\n
\ndef preapproval(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def preapproval(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return PreApproval(request_options is not None and request_options\n                       or self.request_options, self.http_client)
\n
\n
\n
\ndef preference(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def preference(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return Preference(request_options is not None and request_options\n                      or self.request_options, self.http_client)
\n
\n
\n
\ndef refund(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def refund(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return Refund(request_options is not None and request_options\n                  or self.request_options, self.http_client)
\n
\n
\n
\ndef user(self, request_options=None)\n
\n
\n

Returns the attribute value of the function

\n
\n\nExpand source code\n\n
def user(self, request_options=None):\n    """\n    Returns the attribute value of the function\n    """\n    return User(request_options is not None and request_options\n                or self.request_options, self.http_client)
\n
\n
\n
\n
\n
\n
\n
\n\n
\n\n\n" }, { "path": "mercadopago/__init__.py", "content": "\"\"\"\nModule: mercadopago/__init__.py\n\"\"\"\nfrom mercadopago.sdk import SDK\n\n\n__all__ = (\n 'SDK',\n)\n" }, { "path": "mercadopago/config/__init__.py", "content": "\"\"\"\nModule: config/__init__.py\n\"\"\"\nfrom mercadopago.config.config import Config\nfrom mercadopago.config.request_options import RequestOptions\n\n\n__all__ = (\n 'Config',\n 'RequestOptions',\n)\n" }, { "path": "mercadopago/config/config.py", "content": "\"\"\"\nModule: config\n\"\"\"\nimport platform\n\n\nclass Config:\n \"\"\"\n General infos of your SDK\n \"\"\"\n\n def __init__(self):\n self.__version = \"2.4.0\"\n self.__user_agent = \"MercadoPago Python SDK v\" + self.__version\n self.__product_id = \"bc32bpftrpp001u8nhlg\"\n self.__tracking_id = \"platform:\" + platform.python_version()\n self.__tracking_id += \",type:SDK\" + self.__version + \",so;\"\n\n __api_base_url = \"https://api.mercadopago.com\"\n __mime_json = \"application/json\"\n __mime_form = \"application/x-www-form-urlencoded\"\n\n @property\n def version(self):\n \"\"\"\n Sets the attribute value of version\n \"\"\"\n return self.__version\n\n @property\n def user_agent(self):\n \"\"\"\n Sets the attribute value of user agent\n \"\"\"\n return self.__user_agent\n\n @property\n def product_id(self):\n \"\"\"\n Sets the attribute value of product id\n \"\"\"\n return self.__product_id\n\n @property\n def tracking_id(self):\n \"\"\"\n Sets the attribute value of tracking id\n \"\"\"\n return self.__tracking_id\n\n @property\n def api_base_url(self):\n \"\"\"\n Sets the attribute value of api base url\n \"\"\"\n return self.__api_base_url\n\n @property\n def mime_json(self):\n \"\"\"\n Sets the attribute value of mime json\n \"\"\"\n return self.__mime_json\n\n @property\n def mime_form(self):\n \"\"\"\n Sets the attribute value of mime form\n \"\"\"\n return self.__mime_form\n" }, { "path": "mercadopago/config/request_options.py", "content": "\"\"\"\nModule: request_options\n\"\"\"\nimport uuid\n\nfrom .config import Config\n\n\nclass RequestOptions: # pylint: disable=too-many-instance-attributes\n\n \"\"\"This object hold all configurations that will be used in ur REST call.\n\n All here u can customize as well add params in the requisition header (custom_headers)\n \"\"\"\n\n __access_token = None\n __connection_timeout = None\n __custom_headers = None\n __max_retries = None\n __corporation_id = None\n __integrator_id = None\n __platform_id = None\n\n def __init__( # pylint: disable=too-many-positional-arguments\n # pylint: disable=too-many-arguments\n self,\n access_token=None,\n connection_timeout=60.0,\n custom_headers=None,\n corporation_id=None,\n integrator_id=None,\n platform_id=None,\n max_retries=3,\n ):\n \"\"\"Initialize\n\n Args:\n access_token (str, optional): Your User Access Token. Defaults to None.\n connection_timeout (float, optional): Time to timeout the REST call. Defaults to 60.0.\n custom_headers (dict, optional): A Dict with params to be added to the requests params.\n Defaults to None.\n corporation_id (str, optional): Your Corporation ID if any. Defaults to None.\n integrator_id (str, optional): Your Integrator ID if any. Defaults to None.\n platform_id (str, optional): Your Platform ID if any. Defaults to None.\n max_retries (int, optional): How many retries must be done in case of fail.\n Defaults to 3.\n\n Raises:\n ValueError: Param access_token must be a String\n ValueError: Param connection_timeout must be a Float\n ValueError: Param custom_headers must be a Dictionary\n ValueError: Param corporation_id must be a String\n ValueError: Param integrator_id must be a String\n ValueError: Param platform_id must be a String\n ValueError: Param max_retries must be an Integer\n \"\"\"\n\n if access_token is not None:\n self.access_token = access_token\n if connection_timeout is not None:\n self.connection_timeout = connection_timeout\n if custom_headers is not None:\n self.custom_headers = custom_headers\n if max_retries is not None:\n self.max_retries = max_retries\n if corporation_id is not None:\n self.corporation_id = corporation_id\n if integrator_id is not None:\n self.integrator_id = integrator_id\n if platform_id is not None:\n self.platform_id = platform_id\n\n self.__config = Config()\n\n def get_headers(self):\n \"\"\"\n Sets the attribute values of headers\n \"\"\"\n headers = {\"Authorization\": \"Bearer \" + self.__access_token,\n \"x-product-id\": self.__config.product_id,\n \"x-tracking-id\": self.__config.tracking_id,\n \"x-idempotency-key\": str(uuid.uuid4().int),\n \"User-Agent\": self.__config.user_agent,\n \"Accept\": self.__config.mime_json}\n\n if self.__corporation_id is not None:\n headers[\"x-corporation-id\"] = self.__corporation_id\n\n if self.__integrator_id is not None:\n headers[\"x-integrator-id\"] = self.__integrator_id\n\n if self.__platform_id is not None:\n headers[\"x-platform-id\"] = self.__platform_id\n\n if self.__custom_headers is not None:\n headers.update(self.__custom_headers)\n\n return headers\n\n @property\n def access_token(self):\n \"\"\"\n Sets the attribute value and validates access_token\n \"\"\"\n return self.__access_token\n\n @access_token.setter\n def access_token(self, value):\n if not isinstance(value, str):\n raise ValueError(\"Param access_token must be a String\")\n self.__access_token = value\n\n @property\n def connection_timeout(self):\n \"\"\"\n Sets the attribute value and validates connection timeout\n \"\"\"\n return self.__connection_timeout\n\n @connection_timeout.setter\n def connection_timeout(self, value):\n if not isinstance(value, float):\n raise ValueError(\"Param connection_timeout must be a Float\")\n self.__connection_timeout = value\n\n @property\n def corporation_id(self):\n \"\"\"\n Sets the attribute value and validates corporation id\n \"\"\"\n return self.__corporation_id\n\n @corporation_id.setter\n def corporation_id(self, value):\n if not isinstance(value, str):\n raise ValueError(\"Param corporation_id must be a String\")\n self.__corporation_id = value\n\n @property\n def custom_headers(self):\n \"\"\"\n Sets the attribute value and validates custom headers\n \"\"\"\n return self.__custom_headers\n\n @custom_headers.setter\n def custom_headers(self, value):\n if not isinstance(value, dict):\n raise ValueError(\"Param custom_headers must be a Dictionary\")\n self.__custom_headers = value\n\n @property\n def integrator_id(self):\n \"\"\"\n Sets the attribute value and validates integrator id\n \"\"\"\n return self.__integrator_id\n\n @integrator_id.setter\n def integrator_id(self, value):\n if not isinstance(value, str):\n raise ValueError(\"Param integrator_id must be a String\")\n self.__integrator_id = value\n\n @property\n def max_retries(self):\n \"\"\"\n Sets the attribute value and validates max retries\n \"\"\"\n return self.__max_retries\n\n @max_retries.setter\n def max_retries(self, value):\n if not isinstance(value, int):\n raise ValueError(\"Param max_retries must be an Integer\")\n self.__max_retries = value\n\n @property\n def platform_id(self):\n \"\"\"\n Sets the attribute value and validates platform id\n \"\"\"\n return self.__platform_id\n\n @platform_id.setter\n def platform_id(self, value):\n if not isinstance(value, str):\n raise ValueError(\"Param platform_id must be a String\")\n self.__platform_id = value\n" }, { "path": "mercadopago/core/__init__.py", "content": "\"\"\"\nModule: core/__init__.py\n\"\"\"\nfrom mercadopago.core.mp_base import MPBase\n\n\n__all__ = (\n 'MPBase',\n)\n" }, { "path": "mercadopago/core/mp_base.py", "content": "\"\"\"\nModule: mp_base\n\"\"\"\nfrom json.encoder import JSONEncoder\n\nfrom mercadopago.config.config import Config\nfrom mercadopago.config.request_options import RequestOptions\n\n\nclass MPBase:\n \"\"\"All mercadopago.resources extends this one to call the REST services\n\n Args:\n request_options (mercadopago.config.request_options, optional):\n An instance of RequestOptions can be pass changing or adding custom options\n to ur REST calls. Defaults to None.\n http_client (mercadopago.http.http_client, optional): An implementation of\n HttpClient can be pass to be used to make the REST calls. Defaults to None.\n\n Raises:\n ValueError: Param request_options must be a RequestOptions Object\n ValueError: Filters must be a Dictionary\n \"\"\"\n\n def __init__(self, request_options, http_client):\n if not isinstance(request_options, RequestOptions):\n raise ValueError(\n \"Param request_options must be a RequestOptions Object\")\n\n self.__request_options = request_options\n self.__http_client = http_client\n self.__config = Config()\n\n def __check_request_options(self, request_options):\n if request_options is not None and not isinstance(request_options, RequestOptions):\n raise ValueError(\n \"Param request_options must be a RequestOptions Object\")\n if request_options is None:\n request_options = self.__request_options\n\n if request_options.access_token is None:\n request_options.access_token = self.__request_options.access_token\n\n return request_options\n\n def __check_headers(self, request_options, extra_headers=None):\n headers = self.__request_options.get_headers()\n if request_options is not None:\n headers = request_options.get_headers()\n\n if extra_headers is not None:\n headers.update(extra_headers)\n\n return headers\n\n def _get(self, uri, filters=None, request_options=None):\n if filters is not None and not isinstance(filters, dict):\n raise ValueError(\"Filters must be a Dictionary\")\n\n request_options = self.__check_request_options(request_options)\n headers = self.__check_headers(\n request_options, {\"Content-type\": self.__config.mime_json})\n\n return self.__http_client.get(\n url=self.__config.api_base_url + uri,\n params=filters,\n headers=headers,\n timeout=request_options.connection_timeout,\n maxretries=request_options.max_retries,\n )\n\n def _post(self, uri, data=None, params=None, request_options=None):\n if data is not None:\n data = JSONEncoder().encode(data)\n\n request_options = self.__check_request_options(request_options)\n headers = self.__check_headers(\n request_options, {\"Content-type\": self.__config.mime_json})\n\n return self.__http_client.post(\n url=self.__config.api_base_url + uri,\n data=data,\n params=params,\n headers=headers,\n timeout=request_options.connection_timeout,\n maxretries=request_options.max_retries,\n )\n\n def _put(self, uri, data=None, params=None, request_options=None):\n if data is not None:\n data = JSONEncoder().encode(data)\n\n request_options = self.__check_request_options(request_options)\n headers = self.__check_headers(\n request_options, {\"Content-type\": self.__config.mime_json})\n\n return self.__http_client.put(\n url=self.__config.api_base_url + uri,\n data=data,\n params=params,\n headers=headers,\n timeout=request_options.connection_timeout,\n maxretries=request_options.max_retries,\n )\n\n def _delete(self, uri, params=None, request_options=None):\n request_options = self.__check_request_options(request_options)\n headers = self.__check_headers(request_options)\n\n return self.__http_client.delete(\n url=self.__config.api_base_url + uri,\n params=params,\n headers=headers,\n timeout=request_options.connection_timeout,\n maxretries=request_options.max_retries,\n )\n\n @property\n def request_options(self):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return self.__request_options\n\n @property\n def config(self):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return self.__config\n" }, { "path": "mercadopago/examples/order/cancel_order.py", "content": "import os\nimport time\n\nfrom mercadopago import SDK\n\ndef main():\n # Define the authentication token\n access_token = \"\"\n\n # Define the authentication token\n sdk = SDK(access_token)\n\n # Create a test card token\n def create_test_card():\n card_token_object = {\n \"card_number\": \"5031433215406351\",\n \"security_code\": \"123\",\n \"expiration_year\": \"2030\",\n \"expiration_month\": \"11\",\n \"cardholder\": {\"name\": \"APRO\"}\n }\n card_token_created = sdk.card_token().create(card_token_object)\n return card_token_created[\"response\"][\"id\"]\n\n # Create an order object\n card_token_id = create_test_card()\n order_object = {\n \"type\": \"online\",\n \"capture_mode\": \"manual\",\n \"processing_mode\": \"automatic\",\n \"total_amount\": \"880.00\",\n \"external_reference\": \"ext_ref_1234\",\n \"transactions\": {\n \"payments\": [\n {\n \"amount\": \"880.00\",\n \"payment_method\": {\n \"id\": \"master\",\n \"type\": \"credit_card\",\n \"token\": card_token_id,\n \"installments\": 2\n }\n }\n ]\n },\n \"payer\": {\n \"email\": \"\"\n }\n }\n\n try:\n # Call the method to create the order\n response = sdk.order().create(order_object)\n print(\"Order created successfully\")\n\n # Get the order ID from the response\n order_id = response[\"response\"][\"id\"]\n\n time.sleep(5)\n # Call the method to CANCEL\n order_details = sdk.order().cancel(order_id)\n print(\"Order details:\", order_details[\"response\"])\n except Exception as e:\n print(\"Error:\", e)\n\nif __name__ == \"__main__\":\n main()" }, { "path": "mercadopago/examples/order/capture_order.py", "content": "import os\nfrom mercadopago import SDK\n\ndef main():\n # Define the authentication token\n access_token = \"\"\n\n # Define the authentication token\n sdk = SDK(access_token)\n\n # Create a test card token\n def create_test_card():\n card_token_object = {\n \"card_number\": \"5031433215406351\",\n \"security_code\": \"123\",\n \"expiration_year\": \"2030\",\n \"expiration_month\": \"11\",\n \"cardholder\": {\"name\": \"APRO\"}\n }\n card_token_created = sdk.card_token().create(card_token_object)\n return card_token_created[\"response\"][\"id\"]\n\n # Create an order object\n card_token_id = create_test_card()\n order_object = {\n \"type\": \"online\",\n \"capture_mode\": \"manual\", # Mode need to be Manual to use Capture Method.\n \"processing_mode\": \"automatic\",\n \"total_amount\": \"880.00\",\n \"external_reference\": \"ext_ref_1234\",\n \"transactions\": {\n \"payments\": [\n {\n \"amount\": \"880.00\",\n \"payment_method\": {\n \"id\": \"master\",\n \"type\": \"credit_card\",\n \"token\": card_token_id,\n \"installments\": 2\n }\n }\n ]\n },\n \"payer\": {\n \"email\": \"\"\n }\n }\n\n try:\n # Call the method to create the order\n response = sdk.order().create(order_object)\n print(\"Order created successfully\")\n\n # Get the order ID from the response\n order_id = response[\"response\"][\"id\"]\n\n # Call the method to CAPTURE the order\n order_details = sdk.order().capture(order_id)\n print(\"Order details:\", order_details[\"response\"])\n except Exception as e:\n print(\"Error:\", e)\n\nif __name__ == \"__main__\":\n main()" }, { "path": "mercadopago/examples/order/create_order.py", "content": "from mercadopago import SDK\n\n\ndef main():\n # Define the authentication token\n access_token = \"\"\n\n # Define the authentication token\n sdk = SDK(access_token)\n\n # Create a test card token\n def create_test_card():\n card_token_object = {\n \"card_number\": \"5031433215406351\",\n \"security_code\": \"123\",\n \"expiration_year\": \"2030\",\n \"expiration_month\": \"11\",\n \"cardholder\": {\"name\": \"APRO\"}\n }\n card_token_created = sdk.card_token().create(card_token_object)\n return card_token_created[\"response\"][\"id\"]\n\n # Create an order object\n card_token_id = create_test_card()\n order_object = {\n \"type\": \"online\",\n \"total_amount\": \"880.00\",\n \"external_reference\": \"ext_ref_1234\",\n \"transactions\": {\n \"payments\": [\n {\n \"amount\": \"880.00\",\n \"payment_method\": {\n \"id\": \"master\",\n \"type\": \"credit_card\",\n \"token\": card_token_id,\n \"installments\": 2\n }\n }\n ]\n },\n \"payer\": {\n \"email\": \"\"\n }\n }\n\n try:\n # Call the method to create the order\n response = sdk.order().create(order_object)\n print(\"Order created successfully:\", response[\"response\"])\n except Exception as e:\n print(\"Error:\", e)\n\n\nif __name__ == \"__main__\":\n main()" }, { "path": "mercadopago/examples/order/create_transaction.py", "content": "import os\nimport time\n\nfrom mercadopago import SDK\n\ndef main():\n # Define the authentication token\n access_token = \"\"\n\n # Define the authentication token\n sdk = SDK(access_token)\n\n # Create a test card token\n def create_test_card():\n card_token_object = {\n \"card_number\": \"5031433215406351\",\n \"security_code\": \"123\",\n \"expiration_year\": \"2030\",\n \"expiration_month\": \"11\",\n \"cardholder\": {\"name\": \"APRO\"}\n }\n card_token_created = sdk.card_token().create(card_token_object)\n return card_token_created[\"response\"][\"id\"]\n\n # Create an order object\n card_token_id = create_test_card()\n order_object = {\n \"type\": \"online\",\n \"processing_mode\": \"manual\",\n \"total_amount\": \"200.00\",\n \"external_reference\": \"ext_ref_1234\",\n \"payer\": {\n \"email\": \"\"\n }\n }\n\n try:\n # Call the method to create the order\n response = sdk.order().create(order_object)\n print(\"Order created successfully\")\n\n # Get the order ID from the response\n order_id = response[\"response\"][\"id\"]\n\n transaction_object = {\n \"payments\": [\n {\n \"amount\": \"200.00\",\n \"payment_method\": {\n \"id\": \"master\",\n \"type\": \"credit_card\",\n \"token\": card_token_id,\n \"installments\": 12\n }\n }\n ]\n }\n # Call the method to CREATE A TRANSACTION in the order\n transaction_created = sdk.order().create_transaction(order_id, transaction_object)\n print(\"Transaction created:\", transaction_created[\"response\"])\n except Exception as e:\n print(\"Error:\", e)\n\nif __name__ == \"__main__\":\n main()" }, { "path": "mercadopago/examples/order/delete_transaction.py", "content": "import os\nimport time\n\nfrom mercadopago import SDK\n\ndef main():\n # Define the authentication token\n access_token = \"\"\n\n # Define the authentication token\n sdk = SDK(access_token)\n\n # Create a test card token\n def create_test_card():\n card_token_object = {\n \"card_number\": \"5031433215406351\",\n \"security_code\": \"123\",\n \"expiration_year\": \"2030\",\n \"expiration_month\": \"11\",\n \"cardholder\": {\"name\": \"APRO\"}\n }\n card_token_created = sdk.card_token().create(card_token_object)\n return card_token_created[\"response\"][\"id\"]\n\n # Create an order object\n card_token_id = create_test_card()\n order_object = {\n \"type\": \"online\",\n \"processing_mode\": \"manual\",\n \"total_amount\": \"200.00\",\n \"external_reference\": \"ext_ref_1234\",\n \"transactions\": {\n \"payments\": [\n {\n \"amount\": \"200.00\",\n \"payment_method\": {\n \"id\": \"master\",\n \"type\": \"credit_card\",\n \"token\": card_token_id,\n \"installments\": 12\n }\n }\n ]\n },\n \"payer\": {\n \"email\": \"\"\n }\n }\n\n try:\n # Call the method to create the order\n response = sdk.order().create(order_object)\n print(\"Order created successfully\")\n\n # Get the order ID from the response\n order_id = response[\"response\"][\"id\"]\n transaction_id = response[\"response\"][\"transactions\"][\"payments\"][0][\"id\"]\n\n # Call the method to DELETE the transaction in the order\n transaction_deleted = sdk.order().delete_transaction(order_id, transaction_id)\n print(\"Transaction Successful Deleted.\", transaction_deleted[\"response\"])\n except Exception as e:\n print(\"Error:\", e)\n\nif __name__ == \"__main__\":\n main()" }, { "path": "mercadopago/examples/order/get_order.py", "content": "import os\nfrom mercadopago import SDK\n\ndef main():\n # Define the authentication token\n access_token = \"\"\n\n # Define the authentication token\n sdk = SDK(access_token)\n\n # Create a test card token\n def create_test_card():\n card_token_object = {\n \"card_number\": \"5031433215406351\",\n \"security_code\": \"123\",\n \"expiration_year\": \"2030\",\n \"expiration_month\": \"11\",\n \"cardholder\": {\"name\": \"APRO\"}\n }\n card_token_created = sdk.card_token().create(card_token_object)\n return card_token_created[\"response\"][\"id\"]\n\n # Create an order object\n card_token_id = create_test_card()\n order_object = {\n \"type\": \"online\",\n \"total_amount\": \"880.00\",\n \"external_reference\": \"ext_ref_1234\",\n \"transactions\": {\n \"payments\": [\n {\n \"amount\": \"880.00\",\n \"payment_method\": {\n \"id\": \"master\",\n \"type\": \"credit_card\",\n \"token\": card_token_id,\n \"installments\": 2\n }\n }\n ]\n },\n \"payer\": {\n \"email\": \"\"\n }\n }\n\n try:\n # Call the method to create the order\n response = sdk.order().create(order_object)\n print(\"Order created successfully!\")\n\n # Get the order ID from the response\n order_id = response[\"response\"][\"id\"]\n\n # Call the method to get the order details\n order_details = sdk.order().get(order_id)\n print(\"Order details:\", order_details[\"response\"])\n except Exception as e:\n print(\"Error:\", e)\n\nif __name__ == \"__main__\":\n main()" }, { "path": "mercadopago/examples/order/process_order.py", "content": "import os\nfrom mercadopago import SDK\n\ndef main():\n # Define the authentication token\n access_token = \"\"\n\n # Define the authentication token\n sdk = SDK(access_token)\n\n # Create a test card token\n def create_test_card():\n card_token_object = {\n \"card_number\": \"5031433215406351\",\n \"security_code\": \"123\",\n \"expiration_year\": \"2030\",\n \"expiration_month\": \"11\",\n \"cardholder\": {\"name\": \"APRO\"}\n }\n card_token_created = sdk.card_token().create(card_token_object)\n return card_token_created[\"response\"][\"id\"]\n\n # Create an order object\n card_token_id = create_test_card()\n order_object = {\n \"type\": \"online\",\n \"processing_mode\": \"manual\", # Mode need to be Manual to use Process Method.\n \"total_amount\": \"880.00\",\n \"external_reference\": \"ext_ref_1234\",\n \"transactions\": {\n \"payments\": [\n {\n \"amount\": \"880.00\",\n \"payment_method\": {\n \"id\": \"master\",\n \"type\": \"credit_card\",\n \"token\": card_token_id,\n \"installments\": 2\n }\n }\n ]\n },\n \"payer\": {\n \"email\": \"\"\n }\n }\n\n try:\n # Call the method to create the order\n response = sdk.order().create(order_object)\n print(\"Order created successfully!\")\n\n # Get the order ID from the response\n order_id = response[\"response\"][\"id\"]\n print(\"Order ID:\", order_id)\n\n # Call the method to PROCESS the order created in Manual Mode\n order_details = sdk.order().process(order_id)\n print(\"Order details:\", order_details[\"response\"])\n except Exception as e:\n print(\"Error:\", e)\n\nif __name__ == \"__main__\":\n main()" }, { "path": "mercadopago/examples/order/refund_partial.py", "content": "import os\nimport time\n\nfrom mercadopago import SDK\n\ndef main():\n # Define the authentication token\n access_token = \"\"\n\n # Define the authentication token\n sdk = SDK(access_token)\n\n # Create a test card token\n def create_test_card():\n card_token_object = {\n \"card_number\": \"5031433215406351\",\n \"security_code\": \"123\",\n \"expiration_year\": \"2030\",\n \"expiration_month\": \"11\",\n \"cardholder\": {\"name\": \"APRO\"}\n }\n card_token_created = sdk.card_token().create(card_token_object)\n return card_token_created[\"response\"][\"id\"]\n\n # Create an order object\n card_token_id = create_test_card()\n order_object = {\n \"type\": \"online\",\n \"processing_mode\": \"automatic\",\n \"total_amount\": \"500.00\",\n \"external_reference\": \"ext_ref_1234\",\n \"transactions\": {\n \"payments\": [\n {\n \"amount\": \"500.00\",\n \"payment_method\": {\n \"id\": \"master\",\n \"type\": \"credit_card\",\n \"token\": card_token_id,\n \"installments\": 2\n }\n }\n ]\n },\n \"payer\": {\n \"email\": \"\"\n }\n }\n\n try:\n # Call the method to create the order\n response = sdk.order().create(order_object)\n print(\"Order created successfully.\")\n\n # Get the order ID from the response\n order_id = response[\"response\"][\"id\"]\n\n refund = {\n \"transactions\": [\n {\n \"id\": response[\"response\"][\"transactions\"][\"payments\"][0][\"id\"],\n \"amount\": \"25.00\"\n }\n ]\n }\n\n # Call the method to REFUND\n transaction_refund = sdk.order().refund_transaction(order_id, refund)\n print(\"Transaction Partially Refunded:\", transaction_refund[\"response\"])\n except Exception as e:\n print(\"Error:\", e)\n\nif __name__ == \"__main__\":\n main()" }, { "path": "mercadopago/examples/order/refund_total.py", "content": "import os\nimport time\n\nfrom mercadopago import SDK\n\ndef main():\n # Define the authentication token\n access_token = \"\"\n\n # Define the authentication token\n sdk = SDK(access_token)\n\n # Create a test card token\n def create_test_card():\n card_token_object = {\n \"card_number\": \"5031433215406351\",\n \"security_code\": \"123\",\n \"expiration_year\": \"2030\",\n \"expiration_month\": \"11\",\n \"cardholder\": {\"name\": \"APRO\"}\n }\n card_token_created = sdk.card_token().create(card_token_object)\n return card_token_created[\"response\"][\"id\"]\n\n # Create an order object\n card_token_id = create_test_card()\n order_object = {\n \"type\": \"online\",\n \"processing_mode\": \"automatic\",\n \"total_amount\": \"500.00\",\n \"external_reference\": \"ext_ref_1234\",\n \"transactions\": {\n \"payments\": [\n {\n \"amount\": \"500.00\",\n \"payment_method\": {\n \"id\": \"master\",\n \"type\": \"credit_card\",\n \"token\": card_token_id,\n \"installments\": 2\n }\n }\n ]\n },\n \"payer\": {\n \"email\": \"\"\n }\n }\n\n try:\n # Call the method to create the order\n response = sdk.order().create(order_object)\n print(\"Order created successfully.\")\n\n # Get the order ID from the response\n order_id = response[\"response\"][\"id\"]\n\n # Call the method to REFUND TOTALLY the transaction in the order\n transaction_refund = sdk.order().refund_transaction(order_id)\n print(\"Transaction Total Refunded:\", transaction_refund[\"response\"])\n except Exception as e:\n print(\"Error:\", e)\n\nif __name__ == \"__main__\":\n main()" }, { "path": "mercadopago/examples/order/update_transaction.py", "content": "import os\nimport time\n\nfrom mercadopago import SDK\n\ndef main():\n # Define the authentication token\n access_token = \"\"\n\n # Define the authentication token\n sdk = SDK(access_token)\n\n # Create a test card token\n def create_test_card():\n card_token_object = {\n \"card_number\": \"5031433215406351\",\n \"security_code\": \"123\",\n \"expiration_year\": \"2030\",\n \"expiration_month\": \"11\",\n \"cardholder\": {\"name\": \"APRO\"}\n }\n card_token_created = sdk.card_token().create(card_token_object)\n return card_token_created[\"response\"][\"id\"]\n\n # Create an order object\n card_token_id = create_test_card()\n order_object = {\n \"type\": \"online\",\n \"processing_mode\": \"manual\",\n \"total_amount\": \"500.00\",\n \"external_reference\": \"ext_ref_1234\",\n \"transactions\": {\n \"payments\": [\n {\n \"amount\": \"500.00\",\n \"payment_method\": {\n \"id\": \"master\",\n \"type\": \"credit_card\",\n \"token\": card_token_id,\n \"installments\": 2\n }\n }\n ]\n },\n \"payer\": {\n \"email\": \"\"\n }\n }\n\n try:\n # Call the method to create the order\n response = sdk.order().create(order_object)\n print(\"Order created successfully\")\n\n # Get the order ID from the response\n order_id = response[\"response\"][\"id\"]\n transaction_id = response[\"response\"][\"transactions\"][\"payments\"][0][\"id\"]\n\n transaction_update = {\n \"payment_method\": {\n \"type\": \"credit_card\",\n \"installments\": 5\n }\n }\n\n # Call the method to UPDATE the transaction in the order\n update = sdk.order().update_transaction(order_id, transaction_id, transaction_update)\n print(\"Transaction Updated:\", update[\"response\"])\n except Exception as e:\n print(\"Error:\", e)\n\nif __name__ == \"__main__\":\n main()" }, { "path": "mercadopago/examples/preference/create_preference.py", "content": "from mercadopago.sdk import SDK\n\ndef main():\n # Define the authentication token\n access_token = \"\"\n sdk = SDK(access_token)\n\n try:\n preference_data = {\n \"items\": [\n {\n \"title\": \"Dummy Item\",\n \"quantity\": 1,\n \"unit_price\": 10.0\n }\n ],\n \"notification_url\": \"https://webhook.site/test-notification\"\n }\n\n # Call the method to create the preference\n preference = sdk.preference().create(preference_data)\n print(preference)\n except Exception as e:\n print(\"Error:\", e)\n\nif __name__ == \"__main__\":\n main()\n" }, { "path": "mercadopago/http/__init__.py", "content": "\"\"\"\nModule: http/__init__.py\n\"\"\"\nfrom mercadopago.http.http_client import HttpClient\n\n\n__all__ = (\n 'HttpClient',\n)\n" }, { "path": "mercadopago/http/http_client.py", "content": "\"\"\"\nModule: http_client\n\"\"\"\n# pylint: disable=too-many-arguments\nimport requests\nfrom requests.adapters import HTTPAdapter\nfrom urllib3.util import Retry\n\n\nclass HttpClient:\n \"\"\"\n Default implementation to call all REST API's\n \"\"\"\n\n def request(self, method, url, maxretries=None, **kwargs):\n \"\"\"Makes a call to the API.\n\n All **kwargs are passed verbatim to ``requests.request``.\n \"\"\"\n retry_strategy = Retry(\n total=maxretries,\n status_forcelist=[429, 500, 502, 503, 504]\n )\n http = requests.Session()\n http.mount(\"https://\", HTTPAdapter(max_retries=retry_strategy))\n with http as session:\n api_result = session.request(method, url, **kwargs)\n response = {\"status\": api_result.status_code, \"response\": None}\n\n if api_result.status_code != 204 and api_result.content:\n try:\n response[\"response\"] = api_result.json()\n except ValueError as e:\n print(f\"Failed to parse JSON: {str(e)}\")\n response[\"response\"] = None\n\n return response\n\n def get(self, url, headers, params=None, timeout=None, maxretries=None): # pylint: disable=too-many-arguments\n # pylint: disable=too-many-positional-arguments\n \"\"\"Makes a GET request to the API\"\"\"\n return self.request(\n \"GET\",\n url=url,\n headers=headers,\n params=params,\n timeout=timeout,\n maxretries=maxretries,\n )\n\n def post(self, url, headers, data=None, params=None, timeout=None, maxretries=None): # pylint: disable=too-many-arguments\n # pylint: disable=too-many-positional-arguments\n \"\"\"Makes a POST request to the API\"\"\"\n return self.request(\n \"POST\",\n url=url,\n headers=headers,\n data=data,\n params=params,\n timeout=timeout,\n maxretries=maxretries,\n )\n\n def put(self, url, headers, data=None, params=None, timeout=None, maxretries=None): # pylint: disable=too-many-arguments\n # pylint: disable=too-many-positional-arguments\n \"\"\"Makes a PUT request to the API\"\"\"\n return self.request(\n \"PUT\",\n url=url,\n headers=headers,\n data=data,\n params=params,\n timeout=timeout,\n maxretries=maxretries,\n )\n\n def delete(self, url, headers, params=None, timeout=None, maxretries=None): # pylint: disable=too-many-arguments\n # pylint: disable=too-many-positional-arguments\n \"\"\"Makes a DELETE request to the API\"\"\"\n return self.request(\n \"DELETE\",\n url=url,\n headers=headers,\n params=params,\n timeout=timeout,\n maxretries=maxretries,\n )\n" }, { "path": "mercadopago/resources/__init__.py", "content": "\"\"\"\nModule: resources/__init__.py\n\"\"\"\nfrom mercadopago.config.request_options import RequestOptions\nfrom mercadopago.http.http_client import HttpClient\nfrom mercadopago.resources.advanced_payment import AdvancedPayment\nfrom mercadopago.resources.card import Card\nfrom mercadopago.resources.card_token import CardToken\nfrom mercadopago.resources.chargeback import Chargeback\nfrom mercadopago.resources.customer import Customer\nfrom mercadopago.resources.disbursement_refund import DisbursementRefund\nfrom mercadopago.resources.identification_type import IdentificationType\nfrom mercadopago.resources.merchant_order import MerchantOrder\nfrom mercadopago.resources.order import Order\nfrom mercadopago.resources.payment import Payment\nfrom mercadopago.resources.payment_methods import PaymentMethods\nfrom mercadopago.resources.plan import Plan\nfrom mercadopago.resources.preapproval import PreApproval\nfrom mercadopago.resources.preference import Preference\nfrom mercadopago.resources.refund import Refund\nfrom mercadopago.resources.subscription import Subscription\nfrom mercadopago.resources.user import User\n\n\n__all__ = (\n 'AdvancedPayment',\n 'Card',\n 'CardToken',\n 'Chargeback',\n 'Customer',\n 'DisbursementRefund',\n 'HttpClient',\n 'IdentificationType',\n 'MerchantOrder',\n 'Order',\n 'Payment',\n 'PaymentMethods',\n 'Plan',\n 'PreApproval',\n 'Preference',\n 'Refund',\n 'RequestOptions',\n 'Subscription',\n 'User',\n)\n" }, { "path": "mercadopago/resources/advanced_payment.py", "content": "\"\"\"\n Module: advanced_payment\n\"\"\"\nfrom datetime import datetime\n\nfrom mercadopago.core import MPBase\n\n\nclass AdvancedPayment(MPBase):\n \"\"\"\n Access to Advanced Payments\n \"\"\"\n\n def search(self, filters=None, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments_id_search/get/) # pylint: disable=line-too-long\n\n Args:\n filters (dict): The search filters parameters\n request_options (mercadopago.config.request_options, optional):\n An instance of RequestOptions can be pass changing or adding custom options\n to ur REST call. Defaults to None.\n\n Returns:\n dict: Advanced Payment search response\n \"\"\"\n return self._get(uri=\"/v1/advanced_payments/search\", filters=filters,\n request_options=request_options)\n\n def get(self, advanced_payment_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/get/) # pylint: disable=line-too-long\n\n Args:\n advanced_payment_id (str): The Advanced Payment ID\n request_options (mercadopago.config.request_options, optional): An instance\n of RequestOptions can be pass changing or adding custom options to ur REST\n call. Defaults to None.\n\n Returns:\n dict: Advanced Payment find response\n \"\"\"\n return self._get(uri=\"/v1/advanced_payments/\" + str(advanced_payment_id),\n request_options=request_options)\n\n def create(self, advanced_payment_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/advanced_payments/_advanced_payments/post/) # pylint: disable=line-too-long\n\n Args:\n advanced_payment_object (dict): Advanced Payment to be created\n request_options (mercadopago.config.request_options, optional): An instance\n of RequestOptions can be pass changing or adding custom options to ur REST\n call. Defaults to None.\n\n Raises:\n ValueError: Param advanced_payment_object must be a Dictionary\n\n Returns:\n dict: Advanced Payment creation response\n \"\"\"\n if not isinstance(advanced_payment_object, dict):\n raise ValueError(\n \"Param advanced_payment_object must be a Dictionary\")\n\n return self._post(uri=\"/v1/advanced_payments\", data=advanced_payment_object,\n request_options=request_options)\n\n def capture(self, advanced_payment_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/) # pylint: disable=line-too-long\n\n Args:\n advanced_payment_id (str): The Advanced Payment ID\n request_options (mercadopago.config.request_options, optional): An instance\n of RequestOptions can be pass changing or adding custom options to ur REST\n call. Defaults to None.\n\n Returns:\n dict: Advanced Payment capture response\n \"\"\"\n capture_object = {\"capture\": True}\n return self._put(uri=\"/v1/advanced_payments/\" + str(advanced_payment_id),\n data=capture_object, request_options=request_options)\n\n def update(self, advanced_payment_id, advanced_payment_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/) # pylint: disable=line-too-long\n\n Args:\n advanced_payment_id (str): The Advanced Payment ID\n advanced_payment_object (dict): Advanced Payment to be updated\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param advanced_payment_object must be a Dictionary\n\n Returns:\n dict: Advanced Payment modification response\n \"\"\"\n if not isinstance(advanced_payment_object, dict):\n raise ValueError(\n \"Param advanced_payment_object must be a Dictionary\")\n\n return self._put(uri=\"/v1/advanced_payments/\" + str(advanced_payment_id),\n data=advanced_payment_object, request_options=request_options)\n\n def cancel(self, advanced_payment_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/advanced_payments/_advanced_payments_id/put/) # pylint: disable=line-too-long\n\n Args:\n advanced_payment_id (str): The Advanced Payment ID\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Advanced Payment cancelation response\n \"\"\"\n cancel_object = {\"status\": \"cancelled\"}\n return self._put(uri=\"/v1/advanced_payments/\" + str(advanced_payment_id),\n data=cancel_object, request_options=request_options)\n\n def update_release_date(self, advanced_payment_id, release_date, request_options=None):\n \"\"\"[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\n\n Args:\n advanced_payment_id (str): The Advanced Payment ID\n release_date (datetime): Advanced Payment to be canceled\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param release_date must be a DateTime\n\n Returns:\n dict: Advanced Payment release date modification response\n \"\"\"\n if not isinstance(release_date, datetime):\n raise ValueError(\"Param release_date must be a DateTime\")\n\n disbursement_object = {\n \"money_release_date\": release_date.strftime(\"%Y-%m-%d %H:%M:%S.%f\")}\n\n return self._post(uri=\"/v1/advanced_payments/\" + str(advanced_payment_id) + \"/disburses\",\n data=disbursement_object, request_options=request_options)\n" }, { "path": "mercadopago/resources/card.py", "content": "\"\"\"\n Module: card\n\"\"\"\nfrom mercadopago.core import MPBase\n\n\nclass Card(MPBase):\n \"\"\"\n The cards class is the way to store card data of your customers\n safely to improve the shopping experience.\n\n This will allow your customers to complete their purchases much\n faster and easily, since they will not have to complete their\n card data again.\n\n This class must be used in conjunction with the Customer class.\n\n [Click here for more info](https://www.mercadopago.com/developers/en/guides/online-payments/web-tokenize-checkout/customers-and-cards) # pylint: disable=line-too-long\n \"\"\"\n\n def list_all(self, customer_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/get/) # pylint: disable=line-too-long\n\n Args:\n customer_id (str): The Customer ID owner\n request_options (mercadopago.config.request_options, optional):\n An instance of RequestOptions can be pass changing or adding\n custom options to ur REST call. Defaults to None.\n\n Returns:\n dict: Cards find response\n \"\"\"\n return self._get(\n uri=f\"/v1/customers/{str(customer_id)}/cards\",\n request_options=request_options,\n )\n\n def get(self, customer_id, card_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/get/) # pylint: disable=line-too-long\n\n Args:\n customer_id (str): The Customer ID owner\n card_id (dict): Card ID to be found\n request_options (mercadopago.config.request_options, optional):\n An instance of RequestOptions can be pass changing or adding\n custom options to ur REST call. Defaults to None.\n\n Returns:\n dict: Card find response\n \"\"\"\n return self._get(\n uri=f\"/v1/customers/{str(customer_id)}/cards/{str(card_id)}\",\n request_options=request_options,\n )\n\n def create(self, customer_id, card_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/post/) # pylint: disable=line-too-long\n\n Args:\n customer_id (str): The Customer ID owner\n card_object (dict): Card object to be created\n request_options (mercadopago.config.request_options, optional):\n An instance of RequestOptions can be pass changing or adding\n custom options to ur REST call. Defaults to None.\n\n Raises:\n ValueError: Param card_object must be a Dictionary\n\n Returns:\n dict: Card creation response\n \"\"\"\n if not isinstance(card_object, dict):\n raise ValueError(\"Param card_object must be a Dictionary\")\n\n return self._post(uri=\"/v1/customers/\" + str(customer_id)\n + \"/cards/\", data=card_object, request_options=request_options)\n\n def update(self, customer_id, card_id, card_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/put/) # pylint: disable=line-too-long\n\n Args:\n customer_id (str): Customer ID owner\n card_id (str): Card ID to be modified\n card_object (dict): Values to be modified\n request_options (mercadopago.config.request_options, optional):\n An instance of RequestOptions can be pass changing or adding\n custom options to ur REST call. Defaults to None.\n\n Raises:\n ValueError: Param card_object must be a Dictionary\n\n Returns:\n dict: Card modification response\n \"\"\"\n if not isinstance(card_object, dict):\n raise ValueError(\"Param card_object must be a Dictionary\")\n\n return self._put(uri=\"/v1/customers/\" + str(customer_id)\n + \"/cards/\" + str(card_id), data=card_object,\n request_options=request_options)\n\n def delete(self, customer_id, card_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards_id/delete/) # pylint: disable=line-too-long\n\n Args:\n customer_id (str): Customer ID owner\n card_id (str): Card ID to be deleted\n request_options (mercadopago.config.request_options, optional):\n An instance of RequestOptions can be pass changing or adding\n custom options to ur REST call. Defaults to None.\n\n Returns:\n dict: Card exclusion response\n \"\"\"\n return self._delete(uri=\"/v1/customers/\" + str(customer_id)\n + \"/cards/\" + str(card_id), request_options=request_options)\n" }, { "path": "mercadopago/resources/card_token.py", "content": "\"\"\"\n Module: card_token\n\"\"\"\nfrom mercadopago.core import MPBase\n\n\nclass CardToken(MPBase):\n \"\"\"\n This class will allow you to send your customers card data for Mercado Pago\n server and receive a token to complete the payments transactions.\n \"\"\"\n\n def get(self, card_token_id, request_options=None):\n \"\"\"Args:\n card_token_id (str): The Card Token ID\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Card Token find response\n \"\"\"\n return self._get(uri=\"/v1/card_tokens/\" + str(card_token_id),\n request_options=request_options)\n\n def create(self, card_token_object, request_options=None):\n \"\"\"Args:\n card_token_object (dict): Card Token to be created\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param card_token_object must be a Dictionary\n\n Returns:\n dict: Card Token creation response\n \"\"\"\n if not isinstance(card_token_object, dict):\n raise ValueError(\"Param card_token_object must be a Dictionary\")\n\n return self._post(uri=\"/v1/card_tokens\", data=card_token_object,\n request_options=request_options)\n" }, { "path": "mercadopago/resources/chargeback.py", "content": "\"\"\"\n Module: chargeback\n\"\"\"\nfrom mercadopago.core import MPBase\n\n\nclass Chargeback(MPBase):\n \"\"\"\n Access to Chargebacks\n\n [Click here for more info](https://www.mercadopago.com.br/developers/pt/guides/manage-account/account/chargebacks) # pylint: disable=line-too-long\n \"\"\"\n\n def search(self, filters=None, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.br/developers/pt/reference/chargebacks/_chargebacks_search/get) # pylint: disable=line-too-long\n\n Args:\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Chargeback find response\n \"\"\"\n return self._get(uri=\"/v1/chargebacks/search\", filters=filters,\n request_options=request_options)\n\n def get(self, chargeback_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.br/developers/pt/reference/chargebacks/_chargebacks_id/get) # pylint: disable=line-too-long\n\n Args:\n chargeback_id (str): The Chargeback ID\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Chargeback find response\n \"\"\"\n return self._get(uri=\"/v1/chargebacks/\" + str(chargeback_id),\n request_options=request_options)\n" }, { "path": "mercadopago/resources/customer.py", "content": "\"\"\"\n Module: customer\n\"\"\"\nfrom mercadopago.core import MPBase\n\n\nclass Customer(MPBase):\n \"\"\"\n This class allows you to store customers data safely to improve the shopping experience.\n\n This will allow your customer to complete their purchases much faster and easily when\n used in conjunction with the Cards class.\n\n [Click here for more info](https://mercadopago.com.br/developers/en/guides/online-payments/web-tokenize-checkout/customers-and-cards) # pylint: disable=line-too-long\n \"\"\"\n\n def search(self, filters=None, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers_search/get/) # pylint: disable=line-too-long\n\n Args:\n filters (dict): The search filters parameters\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Customer find response\n \"\"\"\n return self._get(uri=\"/v1/customers/search\", filters=filters,\n request_options=request_options)\n\n def get(self, customer_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/customers/_customers_id/get/) # pylint: disable=line-too-long\n\n Args:\n customer_id (str): The Customer ID owner\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Customer find response\n \"\"\"\n return self._get(uri=\"/v1/customers/\" + str(customer_id), request_options=request_options)\n\n def create(self, customer_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers/post/) # pylint: disable=line-too-long\n\n Args:\n customer_object (dict): Customer object to be created\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param customer_object must be a Dictionary\n\n Returns:\n dict: Customer creation response\n \"\"\"\n if not isinstance(customer_object, dict):\n raise ValueError(\"Param customer_object must be a Dictionary\")\n\n return self._post(uri=\"/v1/customers\", data=customer_object,\n request_options=request_options)\n\n def update(self, customer_id, customer_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/customers/_customers_id/put/) # pylint: disable=line-too-long\n\n Args:\n customer_id (str): The Customer ID owner\n customer_object (dict): Customer object to be updated\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValeuError: Param customer_object must be a Dictionary\n\n Returns:\n dict: Customer modification response\n \"\"\"\n if not isinstance(customer_object, dict):\n raise ValueError(\"Param customer_object must be a Dictionary\")\n\n return self._put(uri=\"/v1/customers/\" + str(customer_id), data=customer_object,\n request_options=request_options)\n\n def delete(self, customer_id, request_options=None):\n \"\"\"\n Args:\n customer_id (str): The Customer ID owner\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Customer exclusion response\n \"\"\"\n return self._delete(uri=\"/v1/customers/\" + str(customer_id),\n request_options=request_options)\n" }, { "path": "mercadopago/resources/disbursement_refund.py", "content": "\"\"\"\n Module: disbursement_refund\n\"\"\"\nfrom mercadopago.core import MPBase\n\n\nclass DisbursementRefund(MPBase):\n\n \"\"\"\n Access to Advanced Payments Refunds\n \"\"\"\n\n def list_all(self, advanced_payment_id, request_options=None):\n \"\"\"[Args:\n advanced_payment_id (str): The Advanced Payment ID\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Disbursement Refund find response\n \"\"\"\n uri = f\"/v1/advanced_payments/{str(advanced_payment_id)}/refunds\"\n return self._get(uri=uri, request_options=request_options)\n\n def create_all(self, advanced_payment_id, disbursement_refund_object, request_options=None):\n \"\"\"[Args:\n advanced_payment_id (str): The Advanced Payment ID\n disbursement_refund_object (dict): Disbursement Refund to be created\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param disbursement_refund_object must be a Dictionary\n\n Returns:\n dict: Disbursement Refund creation all response\n \"\"\"\n if not isinstance(disbursement_refund_object, dict):\n raise ValueError(\n \"Param disbursement_refund_object must be a Dictionary\")\n\n return self._post(\n uri=\"/v1/advanced_payments/\" + str(advanced_payment_id) + \"/refunds\",\n data=disbursement_refund_object,\n request_options=request_options,\n )\n\n def create(self, advanced_payment_id, disbursement_id, amount, request_options=None):\n \"\"\"[Args:\n advanced_payment_id (str): The Advanced Payment ID\n disbursement_id (str): Disbursement ID\n amount: Amount to be refunded\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param amount must be a Float\n\n Returns:\n dict: Disbursement Refund creation response\n \"\"\"\n if not isinstance(amount, float):\n raise ValueError(\"Param amount must be a Float\")\n\n disbursement_refund_object = {\"amount\": amount}\n\n uri = (\n f\"/v1/advanced_payments/{str(advanced_payment_id)}\"\n f\"/disbursements/{str(disbursement_id)}/refunds\"\n )\n\n return self._post(\n uri=uri,\n data=disbursement_refund_object,\n request_options=request_options,\n )\n\n def save(self, advanced_payment_id, disbursement_id, disbursement_refund_object,\n request_options=None):\n \"\"\"[Args:\n advanced_payment_id (str): The Advanced Payment ID\n disbursement_id (str): Disbursement ID\n disbursement_refund_object (dict): Disbursement Refund to be saved\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param disbursement_refund_object must be a Dictionary\n\n Returns:\n dict: Disbursement Refund save response\n \"\"\"\n if not isinstance(disbursement_refund_object, dict):\n raise ValueError(\n \"Param disbursement_refund_object must be a Dictionary\")\n\n uri = (\n f\"/v1/advanced_payments/{str(advanced_payment_id)}\"\n f\"/disbursements/{str(disbursement_id)}/refunds\"\n )\n\n return self._post(\n uri=uri,\n data=disbursement_refund_object,\n request_options=request_options,\n )\n" }, { "path": "mercadopago/resources/identification_type.py", "content": "\"\"\"\n Module: identification_type\n\"\"\"\nfrom mercadopago.core import MPBase\n\n\nclass IdentificationType(MPBase):\n \"\"\"\n Access to Identification Types\n \"\"\"\n\n def list_all(self, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/identification_types/_identification_types/get/) # pylint: disable=line-too-long\n\n Args:\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Identification Types find response\n \"\"\"\n return self._get(uri=\"/v1/identification_types\", request_options=request_options)\n\n @property\n def request_options(self):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return self.__request_options\n" }, { "path": "mercadopago/resources/merchant_order.py", "content": "\"\"\"\n Module: merchant_order\n\"\"\"\nfrom mercadopago.core import MPBase\n\n\nclass MerchantOrder(MPBase):\n \"\"\"\n This class will allow you to create and manage your orders. You can attach\n one or more payments in your merchant order.\n \"\"\"\n\n def search(self, filters=None, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_search/get/) # pylint: disable=line-too-long\n\n Args:\n filters (dict): The search filters parameters\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Merchant Order find response\n \"\"\"\n return self._get(uri=\"/merchant_orders/search\", filters=filters,\n request_options=request_options)\n\n def get(self, merchan_order_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/cards/_customers_customer_id_cards/get/) # pylint: disable=line-too-long\n\n Args:\n merchan_order_id (str): The Merchant Order ID\n 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.\n\n Returns:\n dict: Cards find response\n \"\"\"\n return self._get(uri=\"/merchant_orders/\" + str(merchan_order_id),\n request_options=request_options)\n\n def update(self, merchan_order_id, merchant_order_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders_id/put/) # pylint: disable=line-too-long\n\n Args:\n merchan_order_id (str): Merchant Order ID\n merchant_order_object (dict): Merchant Order object to be updated\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param merchant_order_object must be a Dictionary\n\n Returns:\n dict: Cards modification response\n \"\"\"\n if not isinstance(merchant_order_object, dict):\n raise ValueError(\n \"Param merchant_order_object must be a Dictionary\")\n\n return self._put(uri=\"/merchant_orders/\" + str(merchan_order_id),\n data=merchant_order_object, request_options=request_options)\n\n def create(self, merchant_order_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/merchant_orders/_merchant_orders/post/) # pylint: disable=line-too-long\n\n Args:\n merchant_order_object (dict): Merchant Order object to be created\n request_options (mercadopago.config.request_options, optional): An instance of RequestOptions can be pass\n changing or adding custom options to ur REST call. Defaults to None.\n\n Raises:\n ValueError: Param merchant_order_object must be a Dictionary\n\n Returns:\n dict: Cards creation response\n \"\"\"\n if not isinstance(merchant_order_object, dict):\n raise ValueError(\n \"Param merchant_order_object must be a Dictionary\")\n\n return self._post(uri=\"/merchant_orders\", data=merchant_order_object,\n request_options=request_options)\n" }, { "path": "mercadopago/resources/order.py", "content": "\"\"\"\n Module: order\n\"\"\"\nfrom mercadopago.core import MPBase\n\nclass Order(MPBase):\n \"\"\"\n This class provides the methods to access the API that will allow you to create\n your own order experience on your website.\n\n From basic to advanced configurations, you control the whole experience.\n\n [Click here for more info](https://www.mercadopago.com/developers/en/guides/online-payments/checkout-api/introduction/) # pylint: disable=line-too-long\n \"\"\"\n\n def search(self, filters=None, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/order/online-payments/search-order/get) # pylint: disable=line-too-long\n\n Args:\n filters (dict): The search filters parameters\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to the REST call.\n Defaults to None.\n\n Returns:\n dict: Order search response\n \"\"\"\n return self._get(uri=\"/v1/orders\", filters=filters,\n request_options=request_options)\n\n def create(self, order_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/order/online-payments/create/post/) # pylint: disable=line-too-long\n\n Args:\n order_object (dict): Order to be created\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to the REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param order_object must be a Dictionary\n\n Returns:\n dict: Order creation response\n \"\"\"\n if not isinstance(order_object, dict):\n raise ValueError(\"Param order_object must be a Dictionary\")\n\n return self._post(uri=\"/v1/orders\", data=order_object, request_options=request_options)\n\n def get(self, order_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/order/online-payments/get-order/get ) # pylint: disable=line-too-long\n\n Args:\n order_id (str): The Order ID\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to the REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param order_id must be a string\n\n Returns:\n dict: Order returned in the response to the request made for its creation.\n \"\"\"\n\n if not isinstance(order_id, str):\n raise ValueError(\"Param order_id must be a string\")\n\n return self._get(uri=\"/v1/orders/\" + str(order_id), request_options=request_options)\n\n def process(self, order_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/order/online/process-order/post) # pylint: disable=line-too-long\n Args:\n order_id (str): ID of the order to be processed. This value is returned in the response to the Create order request.\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to the REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param order_id must be a string\n Returns:\n dict: Order returned in the response to the request made for its creation.\n \"\"\"\n\n if not isinstance(order_id, str):\n raise ValueError(\"Param order_id must be a string\")\n\n return self._post(uri=\"/v1/orders/\" + str(order_id) + \"/process\", request_options=request_options) # pylint: disable=line-too-long\n\n def cancel(self, order_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/order/online-payments/cancel-order/post) # pylint: disable=line-too-long\n Args:\n order_id (str): Order ID\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to the REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param order_id must be a string\n\n Returns:\n dict: Order cancellation response\n \"\"\"\n if not isinstance(order_id, str):\n raise ValueError(\"Param order_id must be a string\")\n\n return self._post(uri=\"/v1/orders/\" + str(order_id) + \"/cancel\", request_options=request_options) # pylint: disable=line-too-long\n\n def capture(self, order_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/order/online-payments/capture/post) # pylint: disable=line-too-long\n Args:\n order_id (str): ID of the order to be captured. This value is returned in the response to the Create order request.\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to the REST call.\n Defaults to None.\n Raises:\n ValueError: Param order_id must be a string\n Returns:\n dict: Order returned in the response to the request made for its creation.\n \"\"\"\n\n if not isinstance(order_id, str):\n raise ValueError(\"Param order_id must be a string\")\n\n return self._post(uri=\"/v1/orders/\" + str(order_id) + \"/capture\", request_options=request_options) # pylint: disable=line-too-long\n\n def create_transaction(self, order_id, transaction_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/order/online-payments/add-transaction/post) # pylint: disable=line-too-long\n\n Args:\n order_id (str): The ID of the order to which the transaction will be added\n transaction_object (dict): Transaction to be added\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to the REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param transaction_object must be a Dictionary\n\n Returns:\n dict: Transaction created response\n \"\"\"\n if not isinstance(transaction_object, dict):\n raise ValueError(\"Param transaction_object must be a Dictionary\")\n\n response = self._post(uri=f\"/v1/orders/{order_id}/transactions\", data=transaction_object,\n request_options=request_options)\n if response.get(\"status\") != 201:\n raise Exception(f\"Failed to add transaction: {response}\") # pylint: disable=broad-exception-raised\n return response\n\n def update_transaction(self, order_id, transaction_id, transaction_object, request_options=None): # pylint: disable=line-too-long\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/order/online-payments/update-transaction/put) # pylint: disable=line-too-long\n\n Args:\n order_id (str): The ID of the order to which the transaction belongs\n transaction_id (str): The ID of the transaction to be updated\n transaction_object (dict): Transaction details to be updated\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to the REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param transaction_object must be a Dictionary\n\n Returns:\n dict: Transaction update response\n \"\"\"\n if not isinstance(transaction_object, dict):\n raise ValueError(\"Param transaction_object must be a Dictionary\")\n\n response = self._put(uri=f\"/v1/orders/{order_id}/transactions/{transaction_id}\",\n data=transaction_object, request_options=request_options)\n if response.get(\"status\") != 200:\n raise Exception(f\"Failed to update transaction: {response}\") # pylint: disable=broad-exception-raised\n return response\n\n def refund_transaction(self, order_id, transaction_object=None, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/order/online-payments/refund/post) # pylint: disable=line-too-long\n Args:\n order_id (str): The ID of the order to which the transaction belongs\n transaction_object (dict, optional): Transaction details to be updated\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to the REST call.\n Defaults to None.\n Raises:\n ValueError: Param transaction_object must be a Dictionary\n Returns:\n dict: Order refunded response\n \"\"\"\n if transaction_object is not None and not isinstance(transaction_object, dict):\n raise ValueError(\"Param transaction_object must be a Dictionary\")\n\n response = self._post(uri=f\"/v1/orders/{order_id}/refund\", data=transaction_object,\n request_options=request_options)\n if response.get(\"status\") != 201:\n raise Exception(f\"Failed to refund transaction: {response}\") # pylint: disable=broad-exception-raised\n return response\n\n def delete_transaction(self, order_id, transaction_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/order/online-payments/delete-transaction/delete) # pylint: disable=line-too-long\n Args:\n order_id (str): The ID of the order to which the transaction belongs\n transaction_id (str): The ID of the transaction to be deleted\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to the REST call.\n Defaults to None.\n Raises:\n ValueError: Params order_id and transaction_id must be strings\n Returns:\n Status 204 - No Content - if deleted successfully\n \"\"\"\n if not isinstance(order_id, str) or not isinstance(transaction_id, str):\n raise ValueError(\"Params order_id and transaction_id must be strings\")\n\n response = self._delete(uri=f\"/v1/orders/{order_id}/transactions/{transaction_id}\",\n request_options=request_options)\n\n if response.get(\"status\") != 204:\n raise Exception(f\"Failed to delete transaction: {response}\") # pylint: disable=broad-exception-raised\n return response\n" }, { "path": "mercadopago/resources/payment.py", "content": "\"\"\"\n Module: payment\n\"\"\"\nfrom mercadopago.core import MPBase\n\n\nclass Payment(MPBase):\n \"\"\"\n This class provides the methods to access the API that will allow you to create\n your own payment experience on your website.\n\n From basic to advanced configurations, you control the whole experience.\n\n [Click here for more info](https://www.mercadopago.com.br/developers/en/guides/online-payments/checkout-api/introduction/) # pylint: disable=line-too-long\n \"\"\"\n\n def search(self, filters=None, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments_search/get/) # pylint: disable=line-too-long\n\n Args:\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Payment find response\n \"\"\"\n return self._get(uri=\"/v1/payments/search\", filters=filters,\n request_options=request_options)\n\n def get(self, payment_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments_id/get/) # pylint: disable=line-too-long\n\n Args:\n payment_id (str): The Payment ID\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Payment find response\n \"\"\"\n return self._get(uri=\"/v1/payments/\" + str(payment_id), request_options=request_options)\n\n def create(self, payment_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/payments/_payments/post/) # pylint: disable=line-too-long\n\n Args:\n payment_object (dict): Payment to be created\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param payment_object must be a Dictionary\n\n Returns:\n dict: Payment creation response\n \"\"\"\n if not isinstance(payment_object, dict):\n raise ValueError(\"Param payment_object must be a Dictionary\")\n\n return self._post(uri=\"/v1/payments\", data=payment_object, request_options=request_options)\n\n def update(self, payment_id, payment_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/payments/_payments_id/put/) # pylint: disable=line-too-long\n\n Args:\n payment_id (str): The Payment ID\n payment_object (dict): Payment to be created\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param payment_object must be a Dictionary\n\n Returns:\n dict: Payment modification response\n \"\"\"\n if not isinstance(payment_object, dict):\n raise ValueError(\"Param payment_object must be a Dictionary\")\n\n return self._put(uri=\"/v1/payments/\" + str(payment_id), data=payment_object,\n request_options=request_options)\n" }, { "path": "mercadopago/resources/payment_methods.py", "content": "\"\"\"\n Module: payment_methods\n\"\"\"\nfrom mercadopago.core import MPBase\n\n\nclass PaymentMethods(MPBase):\n \"\"\"\n Access to Payment Methods\n \"\"\"\n\n def list_all(self, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/payment_methods/_payment_methods/get/) # pylint: disable=line-too-long\n\n Args:\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Payment Methods find response\n \"\"\"\n return self._get(uri=\"/v1/payment_methods\", request_options=request_options)\n\n @property\n def request_options(self):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return self.__request_options\n" }, { "path": "mercadopago/resources/plan.py", "content": "\"\"\"\n Module: plan\n\"\"\"\nfrom mercadopago.core import MPBase\n\n\nclass Plan(MPBase):\n \"\"\"\n This class provides the methods to access the API that will allow you to create, search, get and update Plans to be\n used as templates for Subscriptions.\n\n [Click here for more info](https://www.mercadopago.com.br/developers/en/docs/subscriptions/integration-configuration/subscriptions-associated-plan) # pylint: disable=line-too-long\n \"\"\"\n\n def search(self, filters=None, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.co/developers/en/reference/subscriptions/_preapproval_plan_search/get) # pylint: disable=line-too-long\n\n Args:\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Plans found\n \"\"\"\n return self._get(\n uri=\"/preapproval_plan/search\",\n filters=filters,\n request_options=request_options)\n\n def get(self, plan_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.co/developers/en/reference/subscriptions/_preapproval_plan_id/get) # pylint: disable=line-too-long\n\n Args:\n plan_id (str): The plan ID\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Plan found\n \"\"\"\n return self._get(\n uri=\"/preapproval_plan/\" + str(plan_id),\n request_options=request_options)\n\n def create(self, plan_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.co/developers/en/reference/subscriptions/_preapproval_plan/post) # pylint: disable=line-too-long\n\n Args:\n plan_object (dict): Plan to be created\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param plan_object must be a Dictionary\n\n Returns:\n dict: Plan creation response\n \"\"\"\n if not isinstance(plan_object, dict):\n raise ValueError(\"Param plan_object must be a Dictionary\")\n\n return self._post(\n uri=\"/preapproval_plan\",\n data=plan_object,\n request_options=request_options)\n\n def update(self, plan_id, plan_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.co/developers/en/reference/subscriptions/_preapproval_plan_id/put) # pylint: disable=line-too-long\n\n Args:\n plan_id (str): The plan ID to be updated\n plan_object (dict): Plan information to be updated\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param plan_object must be a Dictionary\n\n Returns:\n dict: Plan modification response\n \"\"\"\n if not isinstance(plan_object, dict):\n raise ValueError(\"Param plan_object must be a Dictionary\")\n\n return self._put(\n uri=\"/preapproval_plan/\" + str(plan_id),\n data=plan_object,\n request_options=request_options)\n" }, { "path": "mercadopago/resources/preapproval.py", "content": "\"\"\"\n Module: preapproval\n\"\"\"\nfrom mercadopago.core import MPBase\n\n\nclass PreApproval(MPBase):\n \"\"\"\n This class provides the methods to access the API that will allow you to create\n your own preapproval experience on your website.\n\n From basic to advanced configurations, you control the whole experience.\n\n [Click here for more info](https://www.mercadopago.com.br/developers/en/guides/online-payments/subscriptions/introduction) # pylint: disable=line-too-long\n \"\"\"\n\n def __init__(self, request_options, http_client):\n MPBase.__init__(self, request_options, http_client)\n\n def search(self, filters=None, request_options=None):\n \"\"\"Args:\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: PreApproval find response\n \"\"\"\n return self._get(uri=\"/preapproval/search\", filters=filters,\n request_options=request_options)\n\n def get(self, preapproval_id, request_options=None):\n \"\"\"Args:\n preapproval_id (str): The PreApproval ID\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: PreApproval find response\n \"\"\"\n return self._get(uri=\"/preapproval/\" + str(preapproval_id), request_options=request_options)\n\n def create(self, preapproval_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/subscriptions/_preapproval/post/) # pylint: disable=line-too-long\n\n Args:\n preapproval_object (dict): PreApproval to be created\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param preapproval_object must be a Dictionary\n\n Returns:\n dict: PreApproval creation response\n \"\"\"\n if not isinstance(preapproval_object, dict):\n raise ValueError(\"Param preapproval_object must be a Dictionary\")\n\n return self._post(uri=\"/preapproval\",\n data=preapproval_object, request_options=request_options)\n\n def update(self, preapproval_id, preapproval_object, request_options=None):\n \"\"\"Args:\n preapproval_id (str): The PreApproval ID\n preapproval_object (dict): PreApproval to be created\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param preapproval_object must be a Dictionary\n\n Returns:\n dict: PreApproval modification response\n \"\"\"\n if not isinstance(preapproval_object, dict):\n raise ValueError(\"Param preapproval_object must be a Dictionary\")\n\n return self._put(uri=\"/preapproval/\" + str(preapproval_id),\n data=preapproval_object, request_options=request_options)\n" }, { "path": "mercadopago/resources/preference.py", "content": "\"\"\"\n Module: preference\n\"\"\"\nfrom mercadopago.core import MPBase\n\n\nclass Preference(MPBase):\n \"\"\"\n This class will allow you to charge your customers through our web form\n from any device in a simple, fast and secure way.\n\n [Click here for more info](https://www.mercadopago.com.br/developers/en/guides/online-payments/checkout-pro/introduction) # pylint: disable=line-too-long\n \"\"\"\n\n def get(self, preference_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences_id/get/) # pylint: disable=line-too-long\n\n Args:\n preference_id (str): The Preference ID\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Preference find response\n \"\"\"\n return self._get(uri=\"/checkout/preferences/\" + str(preference_id),\n request_options=request_options)\n\n def update(self, preference_id, preference_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences_id/put/) # pylint: disable=line-too-long\n\n Args:\n preference_id (str): The Preference ID\n preference_object (dict): Values to be modified\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param preference_object must be a Dictionary\n\n Returns:\n dict: Preference modification response\n \"\"\"\n if not isinstance(preference_object, dict):\n raise ValueError(\"Param preference_object must be a Dictionary\")\n\n return self._put(uri=\"/checkout/preferences/\" + str(preference_id), data=preference_object,\n request_options=request_options)\n\n def create(self, preference_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com/developers/en/reference/preferences/_checkout_preferences/post/) # pylint: disable=line-too-long\n\n Args:\n preference_object (dict): Preference object to be created\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call. Defaults to None.\n\n Raises:\n ValueError: Param preference_object must be a Dictionary\n\n Returns:\n dict: Preference creation response\n \"\"\"\n if not isinstance(preference_object, dict):\n raise ValueError(\"Param preference_object must be a Dictionary\")\n\n return self._post(uri=\"/checkout/preferences\", data=preference_object,\n request_options=request_options)\n\n def search(self, filters=None, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.br/developers/en/reference/preferences/_checkout_preferences_search/get) # pylint: disable=line-too-long\n\n Args:\n filters (dict): The search filters parameters\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Preference find response\n \"\"\"\n\n return self._get(uri=\"/checkout/preferences/search\", filters=filters,\n request_options=request_options)\n" }, { "path": "mercadopago/resources/refund.py", "content": "\"\"\"\n Module: refund\n\"\"\"\nfrom mercadopago.core import MPBase\n\n\nclass Refund(MPBase):\n \"\"\"\n This class will allow you to refund payments created through the Payments class.\n\n You can refund a payment within 180 days after it was approved.\n\n You must have sufficient funds in your account in order to successfully refund\n the payment amount. Otherwise, you will get a 400 Bad Request error.\n\n [Click here for more info](https://www.mercadopago.com.br/developers/en/guides/manage-account/account/cancellations-and-refunds#bookmark_refunds) # pylint: disable=line-too-long\n \"\"\"\n\n def list_all(self, payment_id, request_options=None):\n \"\"\"Args:\n payment_id (str): The Payment ID\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: List all refunds of a payment\n \"\"\"\n return self._get(uri=\"/v1/payments/\" + str(payment_id) + \"/refunds\",\n request_options=request_options)\n\n def create(self, payment_id, refund_object=None, request_options=None):\n \"\"\"Args:\n payment_id (str): The Payment ID\n refund_object (dict): Refund to be created\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param refund_object must be a Dictionary\n\n Returns:\n dict: Refund creation response\n \"\"\"\n if refund_object is not None and not isinstance(refund_object, dict):\n raise ValueError(\"Param refund_object must be a Dictionary\")\n\n return self._post(uri=\"/v1/payments/\" + str(payment_id) + \"/refunds\",\n data=refund_object, request_options=request_options)\n" }, { "path": "mercadopago/resources/subscription.py", "content": "\"\"\"\n Module: subscriptions\n\"\"\"\nfrom mercadopago.core import MPBase\n\n\nclass Subscription(MPBase):\n \"\"\"\n This class provides the methods to access the API that will allow you to create, search, get and update\n Subscriptions.\n\n [Click here for more info](https://www.mercadopago.com.br/developers/en/docs/subscriptions/landing) # pylint: disable=line-too-long\n \"\"\"\n\n def search(self, filters=None, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.co/developers/en/reference/subscriptions/_preapproval_search/get) # pylint: disable=line-too-long\n\n Args:\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Subscriptions found\n \"\"\"\n return self._get(\n uri=\"/preapproval/search\",\n filters=filters,\n request_options=request_options)\n\n def get(self, subscription_id, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.co/developers/en/reference/subscriptions/_preapproval_id/get) # pylint: disable=line-too-long\n\n Args:\n subscription_id (str): The subscription ID\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: Subscription found\n \"\"\"\n return self._get(\n uri=\"/preapproval/\" + str(subscription_id),\n request_options=request_options)\n\n def create(self, subscription_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.co/developers/en/reference/subscriptions/_preapproval/post) # pylint: disable=line-too-long\n\n Args:\n subscription_object (dict): Subscription to be created\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param payment_object must be a Dictionary\n\n Returns:\n dict: Subscription creation response\n \"\"\"\n if not isinstance(subscription_object, dict):\n raise ValueError(\"Param subscription_object must be a Dictionary\")\n\n return self._post(\n uri=\"/preapproval\",\n data=subscription_object,\n request_options=request_options)\n\n def update(self, subscription_id, subscription_object, request_options=None):\n \"\"\"[Click here for more info](https://www.mercadopago.com.co/developers/en/reference/subscriptions/_preapproval_id/put) # pylint: disable=line-too-long\n\n Args:\n subscription_id (str): The subscription ID to be updated\n subscription_object (dict): Subscription information to be updated\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Raises:\n ValueError: Param subscription_object must be a Dictionary\n\n Returns:\n dict: Subscription modification response\n \"\"\"\n if not isinstance(subscription_object, dict):\n raise ValueError(\"Param subscription_object must be a Dictionary\")\n\n return self._put(\n uri=\"/preapproval/\" + str(subscription_id),\n data=subscription_object,\n request_options=request_options)\n" }, { "path": "mercadopago/resources/user.py", "content": "\"\"\"\n Module: user\n\"\"\"\nfrom mercadopago.core import MPBase\n\n\nclass User(MPBase):\n \"\"\"\n Access to Users\n \"\"\"\n\n def get(self, request_options=None):\n \"\"\"Args:\n request_options (mercadopago.config.request_options, optional): An instance of\n RequestOptions can be pass changing or adding custom options to ur REST call.\n Defaults to None.\n\n Returns:\n dict: User find response\n \"\"\"\n return self._get(uri=\"/users/me\", request_options=request_options)\n\n @property\n def request_options(self):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return self.__request_options\n" }, { "path": "mercadopago/sdk.py", "content": "\"\"\"\nModule: sdk\n\"\"\"\nfrom mercadopago.config import RequestOptions\nfrom mercadopago.http import HttpClient\nfrom mercadopago.resources import (\n AdvancedPayment,\n Card,\n CardToken,\n Chargeback,\n Customer,\n DisbursementRefund,\n IdentificationType,\n MerchantOrder,\n Order,\n Payment,\n PaymentMethods,\n Plan,\n PreApproval,\n Preference,\n Refund,\n Subscription,\n User,\n)\n\n\nclass SDK:\n \"\"\"Generate access to all API' modules, which are:\n\n 1. Advanced Payment\n 2. Card Token\n 3. Card\n 4. Customer\n 5. Disbursement Refund\n 6. Identification Type\n 7. Merchant Order\n 8. Order\n 9. Payment Methods\n 10. Payment\n 11. Preapproval\n 12. Preference\n 13. Refund\n 14. User\n 15. Chargeback\n 16. Subscription\n 17. Plan\n \"\"\"\n\n def __init__(\n self,\n access_token,\n http_client=None,\n request_options=None,\n ):\n \"\"\"Construct ur SDK Object to have access to all APIs modules.\n Args:\n [Click here for more info](https://www.mercadopago.com/mlb/account/credentials)\n http_client (mercadopago.http.http_client, optional): An implementation of\n HttpClient can be pass to be used to make the REST calls. Defaults to None.\n request_options (mercadopago.config.request_options, optional): An instance\n of RequestOptions can be pass changing or adding custom options to ur REST\n calls. Defaults to None.\n Raises:\n ValueError: Param request_options must be a RequestOptions Object\n \"\"\"\n\n self.http_client = http_client\n if http_client is None:\n self.http_client = HttpClient()\n\n self.request_options = request_options\n if request_options is None:\n self.request_options = RequestOptions()\n\n self.request_options.access_token = access_token\n\n def advanced_payment(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return AdvancedPayment(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n def card_token(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return CardToken(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n def card(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return Card(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n def customer(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return Customer(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n def disbursement_refund(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return DisbursementRefund(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n def identification_type(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return IdentificationType(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n def merchant_order(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return MerchantOrder(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n def order(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return Order(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n def payment(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return Payment(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n def payment_methods(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return PaymentMethods(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n def preapproval(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return PreApproval(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n def preference(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return Preference(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n def refund(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return Refund(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n def user(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return User(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n def chargeback(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return Chargeback(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n def subscription(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return Subscription(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n def plan(self, request_options=None):\n \"\"\"\n Returns the attribute value of the function\n \"\"\"\n return Plan(request_options is not None and request_options\n or self.request_options, self.http_client)\n\n @property\n def request_options(self):\n \"\"\"\n Sets the attribute value and validates request_options\n \"\"\"\n return self.__request_options\n\n @request_options.setter\n def request_options(self, value):\n if value is not None and not isinstance(value, RequestOptions):\n raise ValueError(\n \"Param request_options must be a RequestOptions Object\")\n self.__request_options = value\n\n @property\n def http_client(self):\n \"\"\"\n Sets the attribute value and validates http_client\n \"\"\"\n return self.__http_client\n\n @http_client.setter\n def http_client(self, value):\n if value is not None and not isinstance(value, HttpClient):\n raise ValueError(\"Param http_client must be a HttpClient Object\")\n self.__http_client = value\n" }, { "path": "pyproject.toml", "content": "[build-system]\nrequires = [\"setuptools >= 61.0\"]\nbuild-backend = \"setuptools.build_meta\"\n\n[project]\nname = \"mercadopago\"\nversion = \"2.4.0\"\nauthors = [\n {name = \"Mercado Pago\", email = \"mp_sdk@mercadopago.com\"}\n]\ndescription = \"Mercadopago SDK module for Payments integration\"\nreadme = \"README.md\"\nkeywords = [\"api\", \"mercadopago\", \"checkout\", \"payment in sdk integration\", \"lts\"]\nlicense = {file = \"LICENSE\"}\nrequires-python = \">=3.7\"\ndependencies = [\n \"requests\"\n]\nclassifiers = [\n \"License :: OSI Approved :: MIT License\",\n \"Operating System :: OS Independent\",\n \"Topic :: Software Development :: Libraries :: Python Modules\",\n \"Programming Language :: Python :: 3\",\n \"Programming Language :: Python :: 3.4\",\n \"Programming Language :: Python :: 3.5\",\n \"Programming Language :: Python :: 3.6\",\n \"Programming Language :: Python :: 3.7\",\n \"Programming Language :: Python :: 3.8\",\n \"Programming Language :: Python :: 3.9\",\n \"Programming Language :: Python :: 3.10\",\n \"Programming Language :: Python :: 3.11\",\n]\n\n[project.optional-dependencies]\ntesting = [\n \"unittest\"\n]\n\n[project.urls]\nHomepage = \"https://mercadopago.com\"\nRepository = \"https://github.com/mercadopago/sdk-python\"" }, { "path": "setup.cfg", "content": "[pylint.MASTER]\npy-version = 3.7\n\n[pylint.FORMAT]\nmax-line-length = 100\n\n[isort]\n# Vertical Hanging Indent\nmulti_line_output = 3\n# Formatting settings\nline_length = 120\ninclude_trailing_comma = 1\ncombine_as_imports = 1\nforce_grid_wrap = 2\nuse_parentheses = 1\nforce_sort_within_sections = 1\nlines_after_imports = 2\nskip_glob = *.git/*,*.env/*,*/docs/*,*/build/*,*/.eggs/*,*.egg-info/*\ndefault_section = THIRDPARTY\nsections = FUTURE,STDLIB,THIRDPARTY,CURRENT_PROJECT,LOCALFOLDER,TESTS\nno_lines_before = LOCALFOLDER\n\n# Section for specific project imports\nknown_current_project = mercadopago\nknown_tests = tests\n" }, { "path": "tests/.pylintrc", "content": "[FORMAT]\nmax-line-length = 100\n\n[MESSAGES CONTROL]\ndisable = missing-docstring,duplicate-code\n" }, { "path": "tests/__init__.py", "content": "" }, { "path": "tests/test_advanced_payment.py", "content": "\"\"\"\n Module: test_advanced_payment\n\"\"\"\nfrom datetime import (\n datetime,\n timedelta,\n)\nimport os\nimport unittest\nimport uuid\nimport mercadopago\n\n\nclass TestAdvancedPayment(unittest.TestCase):\n \"\"\"\n Test Module: Advanced Payment\n \"\"\"\n sdk = mercadopago.SDK(os.environ['ACCESS_TOKEN'])\n\n @unittest.skip(reason=\"Outdated API usage\")\n def test_all(self):\n \"\"\"\n Test Function: Advanced Payment\n \"\"\"\n card_token_object = {\n \"card_number\": \"4074090000000004\",\n \"security_code\": \"123\",\n \"expiration_year\": datetime.now().strftime(\"%Y\"),\n \"expiration_month\": \"12\",\n \"cardholder\": {\n \"name\": \"APRO\",\n \"identification\": {\n \"CPF\": \"19119119100\"\n }\n }\n }\n\n card_token_created = self.sdk.card_token().create(card_token_object)\n\n advanced_payment_object = {\n \"application_id\": \"59441713004005\",\n \"payments\": [{\n \"payment_method_id\": \"master\",\n \"payment_type_id\": \"credit_card\",\n \"token\": card_token_created[\"response\"][\"id\"],\n \"date_of_expiration\": (datetime.now() + timedelta(days=10))\n .strftime(\"%Y-%m-%d %H:%M:%S.%f\"),\n \"transaction_amount\": 100.0,\n \"installments\": 1,\n \"processing_mode\": \"aggregator\",\n \"description\": \"description\",\n \"external_reference\": str(uuid.uuid4().int),\n \"statement_descriptor\": \"ADVPAY\"\n }],\n \"disbursements\": [{\n \"collector_id\": \"488656838\",\n \"amount\": 60.0,\n \"external_reference\": \"Seller2\" + str(uuid.uuid4().int),\n \"application_fee\": 0.5\n }],\n \"payer\": {\n \"id\": \"649457098-FybpOkG6zH8QRm\",\n \"type\": \"customer\",\n \"email\": \"test_payer_9999988@testuser.com\",\n \"first_name\": \"Test\",\n \"last_name\": \"User\",\n \"address\": {\n \"zip_code\": \"06233200\",\n \"street_name\": \"Street\",\n \"street_number\": 123\n },\n \"identification\": {\n \"type\": \"CPF\",\n \"number\": \"19119119100\"\n }\n },\n \"external_reference\": \"Adv\" + str(uuid.uuid4().int),\n \"description\": \"description\",\n \"binary_mode\": False,\n \"capture\": False,\n \"additional_info\": {\n \"ip_address\": \"127.0.0.1\",\n \"payer\": {\n \"first_name\": \"Test\",\n \"last_name\": \"User\",\n \"registration_date\": (datetime.now() - timedelta(days=10))\n .strftime(\"%Y-%m-%d %H:%M:%S.%f\")\n },\n \"items\": [{\n \"id\": \"123\",\n \"title\": \"title\",\n \"picture_url\": \"https://www.mercadopago.com/logomp3.gif\",\n \"description\": \"description\",\n \"category_id\": \"category\",\n \"quantity\": 1,\n \"unit_price\": 100.0\n }],\n \"shipments\": {\n \"receiver_address\": {\n \"zip_code\": \"06233200\",\n \"street_name\": \"Street\",\n \"street_number\": 123\n }\n }\n }\n }\n\n advanced_payment_created = self.sdk.advanced_payment().create(advanced_payment_object)\n self.assertEqual(advanced_payment_created[\"status\"], 201)\n\n advanced_payment_found = self.sdk.advanced_payment().get(\n advanced_payment_created[\"response\"][\"id\"])\n self.assertEqual(advanced_payment_found[\"status\"], 200)\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" }, { "path": "tests/test_card.py", "content": "\"\"\"\n Module: test_card\n\"\"\"\nfrom datetime import datetime\nimport os\nimport random\nimport unittest\nimport mercadopago\n\n\nclass TestCard(unittest.TestCase):\n \"\"\"\n Test Module: Card\n \"\"\"\n\n _customer_id = None\n sdk = mercadopago.SDK(os.environ['ACCESS_TOKEN'])\n\n @classmethod\n def setUpClass(cls):\n customer_data = cls.create_customer()\n cls._customer_id = customer_data[\"response\"][\"id\"]\n\n @classmethod\n def tearDownClass(cls):\n cls.delete_customer()\n\n def test_all(self):\n \"\"\"\n Test Function: Card\n \"\"\"\n\n card_token_object = {\n \"card_number\": \"4074090000000004\",\n \"security_code\": \"123\",\n \"expiration_year\": datetime.now().strftime(\"%Y\"),\n \"expiration_month\": \"12\",\n \"cardholder\": {\n \"name\": \"APRO\",\n \"identification\": {\n \"CPF\": \"19119119100\"\n }\n }\n }\n\n card_token_created = self.sdk.card_token().create(card_token_object)\n\n card_object = {\n \"customer_id\": self._customer_id,\n \"token\": card_token_created[\"response\"][\"id\"]\n }\n\n card_created = self.sdk.card().create(self._customer_id, card_object)\n self.assertIn(card_created[\"status\"], [200, 201])\n self.assertEqual(self.sdk.card().get(\n self._customer_id, card_created[\"response\"][\"id\"])[\"status\"], 200)\n\n self.sdk.card().delete(self._customer_id, card_created[\"response\"][\"id\"])\n\n @classmethod\n def create_customer(cls):\n random_email_id = random.randint(100000, 999999)\n customer_object = {\n \"email\": f\"test_payer_{random_email_id}@testuser.com\",\n \"first_name\": \"Rafa\",\n \"last_name\": \"Williner\",\n \"phone\": {\n \"area_code\": \"03492\",\n \"number\": \"432334\"\n },\n \"identification\": {\n \"type\": \"DNI\",\n \"number\": \"29804555\"\n },\n \"description\": \"customer description\"\n }\n\n return cls.sdk.customer().create(customer_object)\n\n @classmethod\n def delete_customer(cls):\n cls.sdk.customer().delete(cls._customer_id)\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" }, { "path": "tests/test_card_token.py", "content": "\"\"\"\n Module: test_card_token\n\"\"\"\nfrom datetime import datetime\nimport os\nimport unittest\nimport mercadopago\n\n\nclass TestCardToken(unittest.TestCase):\n \"\"\"\n Test Module: Card Token\n \"\"\"\n sdk = mercadopago.SDK(os.environ['ACCESS_TOKEN'])\n\n def test_all(self):\n \"\"\"\n Test Function: Card Token\n \"\"\"\n card_token_object = {\n \"card_number\": \"4074090000000004\",\n \"security_code\": \"123\",\n \"expiration_year\": datetime.now().strftime(\"%Y\"),\n \"expiration_month\": \"12\",\n \"cardholder\": {\n \"name\": \"APRO\",\n \"identification\": {\n \"CPF\": \"19119119100\"\n }\n }\n }\n\n card_token_created = self.sdk.card_token().create(card_token_object)\n\n self.assertEqual(card_token_created[\"status\"], 201)\n self.assertEqual(self.sdk.card_token()\n .get(card_token_created[\"response\"][\"id\"])[\"status\"], 200)\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" }, { "path": "tests/test_chargeback.py", "content": "\"\"\"\n Module: test_chargeback\n\"\"\"\nimport os\nimport unittest\nimport mercadopago\n\n\nclass TestChargeback(unittest.TestCase):\n \"\"\"\n Test Module: Chargeback\n \"\"\"\n sdk = mercadopago.SDK(os.environ['ACCESS_TOKEN'])\n\n def test_search_chargeback(self):\n \"\"\"\n Test Function: Chargeback\n \"\"\"\n filters_chargeback = {\n \"payment_id\": \"12345\"\n }\n\n chargebacks = self.sdk.chargeback().search(filters=filters_chargeback)\n self.assertEqual(chargebacks[\"status\"], 200)\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" }, { "path": "tests/test_customer.py", "content": "\"\"\"\n Module: test_customer\n\"\"\"\nimport os\nimport random\nimport unittest\nimport mercadopago\n\n\nclass TestCustomer(unittest.TestCase):\n \"\"\"\n Test Module: Customer\n \"\"\"\n sdk = mercadopago.SDK(os.environ['ACCESS_TOKEN'])\n\n def test_all(self):\n \"\"\"\n Test Function: Customer\n \"\"\"\n random_email_id = random.randint(100000, 999999)\n customer_object = {\n \"email\": f\"test_payer_{random_email_id}@testuser.com\",\n \"first_name\": \"Katniss\",\n \"last_name\": \"Everdeen\",\n \"phone\": {\n \"area_code\": \"03492\",\n \"number\": \"432334\"\n },\n \"identification\": {\n \"type\": \"DNI\",\n \"number\": \"29804555\"\n },\n \"description\": \"customer description\"\n }\n\n customer_saved = self.sdk.customer().create(customer_object)\n self.assertEqual(201, customer_saved[\"status\"])\n\n customer_update = self.sdk.customer().update(\n customer_saved[\"response\"][\"id\"], {\"last_name\": \"Payer\"})\n self.assertEqual(200, customer_update[\"status\"])\n\n customer_updated = self.sdk.customer().get(customer_saved[\"response\"][\"id\"])\n self.assertEqual(customer_updated[\"response\"][\"last_name\"], \"Payer\")\n\n customer_deleted = self.sdk.customer().delete(customer_saved[\"response\"][\"id\"])\n self.assertEqual(200, customer_deleted[\"status\"])\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" }, { "path": "tests/test_identification_type.py", "content": "\"\"\"\n Module: test_identification_type\n\"\"\"\nimport os\nimport unittest\nimport mercadopago\n\n\nclass TestIdentificationType(unittest.TestCase):\n \"\"\"\n Test Module: Identification Type\n \"\"\"\n sdk = mercadopago.SDK(os.environ['ACCESS_TOKEN'])\n\n def test_find_all(self):\n \"\"\"\n Test Function: Identification Type\n \"\"\"\n identifications = self.sdk.identification_type().list_all()\n self.assertEqual(identifications[\"status\"], 200)\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" }, { "path": "tests/test_merchant_order.py", "content": "\"\"\"\n Module: test_merchant_order\n\"\"\"\nimport os\nimport unittest\nimport uuid\nimport mercadopago\n\n\nclass TestMerchantOrder(unittest.TestCase):\n \"\"\"\n Test Module: Merchant Order\n \"\"\"\n sdk = mercadopago.SDK(os.environ['ACCESS_TOKEN'])\n\n def test_all(self):\n \"\"\"\n Test Function: Merchant Order\n \"\"\"\n preference_object = {\n \"items\": [\n {\n \"description\": \"Test Update Success\",\n \"id\": \"5678\",\n \"picture_url\": \"http://product1.image.png\",\n \"quantity\": 1,\n \"title\": \"Item 1\",\n \"currency_id\": \"BRL\",\n \"unit_price\": 20.5\n }\n ]\n }\n\n preference_saved = self.sdk.preference().create(preference_object)\n merchant_order_object = {\n \"preference_id\": preference_saved[\"response\"][\"id\"],\n \"site_id\": \"MLB\",\n \"notification_url\": \"https://seller/notification\",\n \"additional_info\": \"Aditional info\",\n \"external_reference\": str(uuid.uuid4().int),\n \"marketplace\": \"NONE\",\n \"items\": [{\n \"description\": \"Test Update Success\",\n \"id\": \"5678\",\n \"picture_url\": \"http://product1.image.png\",\n \"quantity\": 1,\n \"title\": \"Item 1\",\n \"currency_id\": \"BRL\",\n \"unit_price\": 20.5\n }]\n }\n\n merchant_order_created = self.sdk.merchant_order().create(merchant_order_object)\n self.assertEqual(merchant_order_created[\"status\"], 201)\n\n merchant_order_updated = self.sdk.merchant_order().update(\n merchant_order_created[\"response\"][\"id\"], {\"additional_info\": \"Info 2\"})\n self.assertEqual(merchant_order_updated[\"status\"], 200)\n\n merchant_order_finded = self.sdk.merchant_order().get(\n merchant_order_created[\"response\"][\"id\"])\n self.assertEqual(merchant_order_finded[\"status\"], 200)\n self.assertEqual(\n merchant_order_finded[\"response\"][\"additional_info\"], \"Info 2\")\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" }, { "path": "tests/test_order.py", "content": "\"\"\"\n Module: test_order\n\"\"\"\nimport os\nimport time\nimport unittest\nimport random\nfrom time import sleep\n\nimport mercadopago\n\n\nclass TestOrder(unittest.TestCase):\n \"\"\"\n Test Module: Order\n \"\"\"\n sdk = mercadopago.SDK(os.environ['ACCESS_TOKEN'])\n\n def create_master_test_card(self, status=\"APRO\"):\n card_token_object = {\n \"card_number\": \"5031433215406351\",\n \"security_code\": \"123\",\n \"expiration_year\": \"2030\",\n \"expiration_month\": \"11\",\n \"cardholder\": {\"name\": status}\n }\n card_token_created = self.sdk.card_token().create(card_token_object)\n return card_token_created[\"response\"][\"id\"]\n\n def create_visa_test_card(self, status=\"APRO\"):\n card_token_object = {\n \"card_number\": \"4235647728025682\",\n \"security_code\": \"123\",\n \"expiration_year\": \"2030\",\n \"expiration_month\": \"11\",\n \"cardholder\": {\"name\": status}\n }\n card_token_created = self.sdk.card_token().create(card_token_object)\n return card_token_created[\"response\"][\"id\"]\n\n def create_order_canceled_or_captured(self, card_token_id):\n random_email_id = random.randint(100000, 999999)\n order_object_cc = {\n \"type\": \"online\",\n \"processing_mode\": \"automatic\",\n \"total_amount\": \"200.00\",\n \"external_reference\": \"ext_ref_1234\",\n \"payer\": {\n \"email\": f\"test_payer_{random_email_id}@testuser.com\"\n },\n \"capture_mode\": \"manual\",\n \"transactions\": {\n \"payments\": [\n {\n \"amount\": \"200.00\",\n \"payment_method\": {\n \"id\": \"master\",\n \"type\": \"credit_card\",\n \"token\": card_token_id,\n \"installments\": 1\n }\n }\n ]\n }\n }\n order_created = self.sdk.order().create(order_object_cc)\n if order_created.get(\"status\") != 201 or not order_created.get(\"response\"):\n self.fail(f\"Failed to create order: {order_created}\")\n return order_created[\"response\"][\"id\"]\n\n def create_order_builder_mode(self):\n random_email_id = random.randint(100000, 999999)\n order_object_cc = {\n \"type\": \"online\",\n \"processing_mode\": \"manual\",\n \"total_amount\": \"200.00\",\n \"external_reference\": \"ext_ref_1234\",\n \"payer\": {\n \"email\": f\"test_payer_{random_email_id}@testuser.com\"\n },\n }\n order_created = self.sdk.order().create(order_object_cc)\n if order_created.get(\"status\") != 201 or not order_created.get(\"response\"):\n self.fail(f\"Failed to create order: {order_created}\")\n return order_created[\"response\"][\"id\"]\n\n def create_order_oneshot_mode_complete(self, card_token_id):\n random_email_id = random.randint(100000, 999999)\n order_mode_oneshot_complete = {\n \"type\": \"online\",\n \"processing_mode\": \"automatic\",\n \"total_amount\": \"200.00\",\n \"external_reference\": \"ext_ref_1234\",\n \"transactions\": {\n \"payments\": [\n {\n \"amount\": \"200.00\",\n \"payment_method\": {\n \"id\": \"master\",\n \"type\": \"credit_card\",\n \"token\": card_token_id,\n \"installments\": 1\n }\n }\n ]\n },\n \"payer\": {\n \"email\": f\"test_payer_{random_email_id}@testuser.com\"\n }\n }\n\n order_created = self.sdk.order().create(order_mode_oneshot_complete)\n\n\n if order_created.get(\"status\") != 201 or not order_created.get(\"response\"):\n self.fail(f\"Failed to create order: {order_created}\")\n return order_created[\"response\"]\n\n def create_order_builder_mode_complete(self, card_token_id):\n random_email_id = random.randint(100000, 999999)\n order_mode_builder_complete = {\n \"type\": \"online\",\n \"processing_mode\": \"manual\",\n \"total_amount\": \"200.00\",\n \"external_reference\": \"ext_ref_1234\",\n \"transactions\": {\n \"payments\": [\n {\n \"amount\": \"200.00\",\n \"payment_method\": {\n \"id\": \"master\",\n \"type\": \"credit_card\",\n \"token\": card_token_id,\n \"installments\": 12\n }\n }\n ]\n },\n \"payer\": {\n \"email\": f\"test_payer_{random_email_id}@testuser.com\"\n }\n }\n\n order_created = self.sdk.order().create(order_mode_builder_complete)\n\n\n if order_created.get(\"status\") != 201 or not order_created.get(\"response\"):\n self.fail(f\"Failed to create order: {order_created}\")\n return order_created[\"response\"]\n\n def test_create_order_and_get_by_id(self):\n \"\"\"\n Test Function: Create an Order and Get an Order by ID\n \"\"\"\n card_token_id = self.create_master_test_card()\n random_email_id = random.randint(100000, 999999)\n order_object = {\n \"type\": \"online\",\n \"total_amount\": \"1000.00\",\n \"external_reference\": \"ext_ref_1234\",\n \"transactions\": {\n \"payments\": [\n {\n \"amount\": \"1000.00\",\n \"payment_method\": {\n \"id\": \"master\",\n \"type\": \"credit_card\",\n \"token\": card_token_id,\n \"installments\": 12\n }\n }\n ]\n },\n \"payer\": {\n \"email\": f\"test_payer_{random_email_id}@testuser.com\"\n }\n }\n\n order_created = self.sdk.order().create(order_object)\n self.assertEqual(order_created[\"status\"], 201)\n self.assertEqual(order_created[\"response\"][\"status\"], \"processed\")\n\n order_get = self.sdk.order().get(order_created[\"response\"][\"id\"])\n self.assertEqual(order_get[\"status\"], 200)\n\n def test_process_order(self):\n card_token_id = self.create_master_test_card()\n random_email_id = random.randint(100000, 999999)\n order_object = {\n \"type\": \"online\",\n \"processing_mode\": \"manual\",\n \"external_reference\": \"ext_ref_1234\",\n \"total_amount\": \"200.00\",\n \"transactions\": {\n \"payments\": [\n {\n \"amount\": \"200.00\",\n \"payment_method\": {\n \"id\": \"master\",\n \"type\": \"credit_card\",\n \"token\": card_token_id,\n \"installments\": 1\n }\n }\n ]\n },\n \"payer\": {\n \"email\": f\"test_payer_{random_email_id}@testuser.com\"\n }\n }\n\n order_created = self.sdk.order().create(order_object)\n order_id = order_created[\"response\"][\"id\"]\n process_response = self.sdk.order().process(order_id)\n if process_response.get(\"status\") != 200 or not process_response.get(\"response\"):\n self.fail(f\"Failed to create an order: {process_response}\")\n self.assertEqual(process_response[\"status\"], 200,\n \"Invalid HTTP status when processing the order\")\n\n def test_cancel_order(self):\n card_token_id = self.create_master_test_card()\n order_id = self.create_order_canceled_or_captured(card_token_id)\n time.sleep(4)\n order_canceled = self.sdk.order().cancel(order_id)\n self.assertEqual(order_canceled[\"status\"], 200)\n self.assertEqual(order_canceled[\"response\"][\"status\"], \"canceled\")\n\n def test_capture_order(self):\n card_token_id = self.create_master_test_card()\n order_id = self.create_order_canceled_or_captured(card_token_id)\n order_captured = self.sdk.order().capture(order_id)\n self.assertEqual(order_captured[\"status\"], 200)\n self.assertEqual(order_captured[\"response\"][\"status\"], \"processed\")\n\n def test_create_transaction(self):\n card_token_id = self.create_master_test_card()\n order_id = self.create_order_builder_mode()\n transaction_object = {\n \"payments\": [\n {\n \"amount\": \"200.00\",\n \"payment_method\": {\n \"id\": \"master\",\n \"type\": \"credit_card\",\n \"token\": card_token_id,\n \"installments\": 12\n }\n }\n ]\n }\n\n transaction_created = self.sdk.order().create_transaction(order_id, transaction_object)\n self.assertEqual(transaction_created[\"status\"], 201)\n\n def test_update_transaction(self):\n card_token_id = self.create_master_test_card()\n order_created = self.create_order_builder_mode_complete(card_token_id)\n order_id = order_created[\"id\"]\n transaction_id = order_created[\"transactions\"][\"payments\"][0][\"id\"]\n new_card_token_id = self.create_visa_test_card()\n\n transaction_update = {\n \"payment_method\": {\n \"id\": \"visa\",\n \"type\": \"credit_card\",\n \"token\": new_card_token_id,\n \"installments\": 5\n }\n }\n\n transaction_updated = self.sdk.order().update_transaction(order_id, transaction_id,\n transaction_update)\n self.assertEqual(transaction_updated[\"status\"], 200)\n\n def test_partial_refund_transaction(self):\n card_token_id = self.create_master_test_card()\n order_created = self.create_order_oneshot_mode_complete(card_token_id)\n order_id = order_created[\"id\"]\n transaction_id = order_created[\"transactions\"][\"payments\"][0][\"id\"]\n\n transaction_refund = {\n \"transactions\": [\n {\n \"id\": transaction_id,\n \"amount\": \"25.00\"\n }\n ]\n }\n\n sleep(3)\n\n transaction_refunded = self.sdk.order().refund_transaction(order_id, transaction_refund)\n self.assertIn(transaction_refunded[\"status\"], [ 201],\n f\"Unexpected status code for refund: {transaction_refunded['status']}.\"\n \" Response: {transaction_refunded}\")\n\n def test_refund_transaction(self):\n card_token_id = self.create_master_test_card()\n order_created = self.create_order_oneshot_mode_complete(card_token_id)\n order_id = order_created[\"id\"]\n sleep(3)\n transaction_refunded = self.sdk.order().refund_transaction(order_id)\n self.assertIn(transaction_refunded[\"status\"], [ 201],\n f\"Unexpected status code for refund: {transaction_refunded['status']}.\"\n \" Response: {transaction_refunded}\")\n\n def test_delete_transaction(self):\n card_token_id = self.create_master_test_card()\n order_created = self.create_order_builder_mode_complete(card_token_id)\n order_id = order_created[\"id\"]\n transaction_id = order_created[\"transactions\"][\"payments\"][0][\"id\"]\n sleep(3)\n\n transaction_deleted = self.sdk.order().delete_transaction(order_id, transaction_id)\n self.assertEqual(transaction_deleted[\"status\"], 204)\n\n def test_search_order(self):\n \"\"\"\n Test Function: Search Orders\n \"\"\"\n search_response = self.sdk.order().search(filters={\"limit\": 5, \"offset\": 0})\n self.assertEqual(search_response[\"status\"], 200)\n self.assertIn(\"data\", search_response[\"response\"])\n self.assertIn(\"paging\", search_response[\"response\"])\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" }, { "path": "tests/test_payment.py", "content": "\"\"\"\n Module: test_payment\n\"\"\"\nfrom datetime import datetime\nimport os\nimport unittest\nimport mercadopago\n\n\nclass TestPayment(unittest.TestCase):\n \"\"\"\n Test Module: Payment\n \"\"\"\n sdk = mercadopago.SDK(os.environ['ACCESS_TOKEN'])\n\n def test_create_and_find(self):\n \"\"\"\n Test Function: Payment\n \"\"\"\n card_token_object = {\n \"card_number\": \"4074090000000004\",\n \"security_code\": \"123\",\n \"expiration_year\": datetime.now().strftime(\"%Y\"),\n \"expiration_month\": \"12\",\n \"cardholder\": {\n \"name\": \"APRO\",\n \"identification\": {\n \"CPF\": \"19119119100\"\n }\n }\n }\n\n card_token_created = self.sdk.card_token().create(card_token_object)\n\n payment_object = {\n \"token\": card_token_created[\"response\"][\"id\"],\n \"installments\": 1,\n \"transaction_amount\": 58.80,\n \"description\": \"Point Mini a maquininha que dรก o dinheiro de suas vendas na hora\",\n \"payment_method_id\": \"visa\",\n \"payer\": {\n \"email\": \"test_user_123456@testuser.com\",\n \"identification\": {\n \"number\": \"19119119100\",\n \"type\": \"CPF\"\n }\n },\n \"notification_url\": \"https://www.suaurl.com/notificacoes/\",\n \"sponsor_id\": None,\n \"binary_mode\": False,\n \"external_reference\": \"MP0001\",\n \"statement_descriptor\": \"MercadoPago\",\n \"additional_info\": {\n \"items\": [\n {\n \"id\": \"PR0001\",\n \"title\": \"Point Mini\",\n \"description\": \"Producto Point para cobros con tarjetas mediante bluetooth\",\n \"picture_url\": \"https://http2.mlstatic.com/resources/frontend/statics/growth-sellers-landings/device-mlb-point-i_medium@2x.png\", # pylint: disable=line-too-long\n \"category_id\": \"electronics\",\n \"quantity\": 1,\n \"unit_price\": 58.80\n }\n ],\n \"payer\": {\n \"first_name\": \"Nome\",\n \"last_name\": \"Sobrenome\",\n \"address\": {\n \"zip_code\": \"06233-200\",\n \"street_name\": \"Av das Nacoes Unidas\",\n \"street_number\": 3003\n },\n \"registration_date\": \"2019-01-01T12:01:01.000-03:00\",\n \"phone\": {\n \"area_code\": \"011\",\n \"number\": \"987654321\"\n }\n },\n \"shipments\": {\n \"receiver_address\": {\n \"street_name\": \"Av das Nacoes Unidas\",\n \"street_number\": 3003,\n \"zip_code\": \"06233200\",\n \"city_name\": \"Buzios\",\n \"state_name\": \"Rio de Janeiro\"\n }\n }\n }\n }\n\n payment_created = self.sdk.payment().create(payment_object)\n self.assertEqual(payment_created[\"status\"], 201)\n\n payment_found = self.sdk.payment().get(\n payment_created[\"response\"][\"id\"])\n self.assertEqual(payment_found[\"status\"], 200)\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" }, { "path": "tests/test_payment_methods.py", "content": "\"\"\"\n Module: test_payment_methods\n\"\"\"\nimport os\nimport unittest\nimport mercadopago\n\n\nclass TestPaymentMethods(unittest.TestCase):\n \"\"\"\n Test Module: Payment Methods\n \"\"\"\n sdk = mercadopago.SDK(os.environ['ACCESS_TOKEN'])\n\n def test_find(self):\n \"\"\"\n Test Function: Payment Methods\n \"\"\"\n self.assertEqual(self.sdk.payment_methods().list_all()[\"status\"], 200)\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" }, { "path": "tests/test_plan.py", "content": "\"\"\"\n Module: test_plan\n\"\"\"\nimport os\nimport unittest\nimport random\nimport mercadopago\n\n\nclass TestPlan(unittest.TestCase):\n \"\"\"\n Test Module: Preference\n \"\"\"\n\n sdk = mercadopago.SDK(os.environ['ACCESS_TOKEN'])\n\n def test_all(self):\n \"\"\"\n Test Module: Plan\n \"\"\"\n random_reason_number = random.randint(100000, 999999)\n plan_object_all_options_payload = {\n \"auto_recurring\": {\n \"frequency\": 1,\n \"frequency_type\": \"months\",\n \"repetitions\": 12,\n \"billing_day\": 5,\n \"free_trial\": {\n \"frequency\": 2,\n \"frequency_type\": \"days\"\n },\n \"transaction_amount\": 60,\n \"currency_id\": \"BRL\",\n },\n \"back_url\": \"https://www.mercadopago.com.co/subscriptions\",\n \"reason\": f\"Test Plan #{random_reason_number}\",\n }\n plan_object_mandatory_options_payload = {\n \"auto_recurring\": {\n \"frequency\": 1,\n \"frequency_type\": \"months\",\n \"transaction_amount\": 60,\n \"currency_id\": \"BRL\",\n },\n \"back_url\": \"https://www.mercadopago.com.co/subscriptions\",\n \"reason\": f\"Test Plan (mandatory) #{random_reason_number}\",\n }\n\n plan_response = self.sdk.plan().create(plan_object_all_options_payload)\n if plan_response.get(\"status\") != 201:\n print(f\"Plan creation failed: {plan_response}\")\n self.assertEqual(plan_response[\"status\"], 201)\n\n plan_object = plan_response[\"response\"]\n self.assertEqual(plan_object[\"status\"], \"active\")\n\n # Validate it works with minimal required options\n plan_mandatory_options = self.sdk.plan().create(\n plan_object_mandatory_options_payload)\n self.assertEqual(plan_mandatory_options[\"status\"], 201)\n self.assertEqual(\n plan_mandatory_options[\"response\"][\"status\"], \"active\")\n\n plan_object[\"reason\"] = \"MercadoPago API Test\"\n update_response = self.sdk.plan().update(\n plan_object[\"id\"], plan_object)\n self.assertEqual(update_response[\"status\"], 200)\n update_object = update_response[\"response\"]\n self.assertEqual(update_object[\"reason\"], plan_object[\"reason\"])\n self.assertEqual(update_object[\"status\"], \"active\")\n\n get_response = self.sdk.plan().get(plan_object[\"id\"])\n self.assertEqual(get_response[\"status\"], 200)\n get_object = get_response[\"response\"]\n self.assertEqual(get_object[\"id\"], plan_object[\"id\"])\n\n search_response = self.sdk.plan().search()\n self.assertEqual(search_response[\"status\"], 200)\n search_object = search_response[\"response\"]\n self.assertTrue(\"results\" in search_object)\n self.assertTrue(isinstance(search_object[\"results\"], list))\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" }, { "path": "tests/test_preapproval.py", "content": "\"\"\"\n Module: test_preapproval\n\"\"\"\nimport os\nimport unittest\nimport mercadopago\n\n\nclass TestPreApproval(unittest.TestCase):\n \"\"\"\n Test Module: PreApproval\n \"\"\"\n sdk = mercadopago.SDK(os.environ['ACCESS_TOKEN'])\n\n def test_create(self):\n \"\"\"\n Function: xoxoxoxo\n \"\"\"\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" }, { "path": "tests/test_preference.py", "content": "\"\"\"\n Module: test_preference\n\"\"\"\nimport os\nimport unittest\nimport time\nimport mercadopago\n\n\nclass TestPreference(unittest.TestCase):\n \"\"\"\n Test Module: Preference\n \"\"\"\n sdk = mercadopago.SDK(os.environ['ACCESS_TOKEN'])\n\n def test_all(self):\n \"\"\"\n Test Module: Preference\n \"\"\"\n preference_object = {\n \"items\": [\n {\n \"description\": \"Test Update Success\",\n \"id\": \"456\",\n \"picture_url\": \"http://product1.image.png\",\n \"quantity\": 1,\n \"title\": \"Item 1\",\n \"currency_id\": \"BRL\",\n \"unit_price\": 20.5\n }\n ]\n }\n preference_saved = self.sdk.preference().create(preference_object)\n self.assertEqual(preference_saved[\"status\"], 201)\n time.sleep(3)\n\n preference_object[\"items\"][0][\"title\"] = \"Testando 1 2 3\"\n\n preference_id = preference_saved[\"response\"][\"id\"]\n preference_update = self.sdk.preference().update(preference_id, preference_object)\n self.assertEqual(preference_update[\"status\"], 200)\n\n time.sleep(3)\n preference_saved = self.sdk.preference().get(preference_id)\n self.assertEqual(preference_saved[\"status\"], 200)\n self.assertEqual(preference_saved[\"response\"][\"items\"][0][\"title\"],\n preference_object[\"items\"][0][\"title\"])\n\n time.sleep(3)\n preference_search = self.sdk.preference().search()\n self.assertEqual(preference_search[\"status\"], 200)\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" }, { "path": "tests/test_subscription.py", "content": "\"\"\"\n Module: test_plan\n\"\"\"\nfrom datetime import datetime\nimport os\nimport unittest\nimport random\nimport mercadopago\n\n\nclass TestSubscription(unittest.TestCase):\n \"\"\"\n Test Module: Preference\n \"\"\"\n _customer_id = None\n _customer_email = None\n _plan_id = None\n sdk = mercadopago.SDK(os.environ['ACCESS_TOKEN'])\n\n @classmethod\n def setUpClass(cls):\n customer_data = cls.create_customer()\n cls._customer_id = customer_data[\"response\"][\"id\"]\n cls._customer_email = customer_data[\"response\"][\"email\"]\n plan_data = cls.create_plan()\n if plan_data.get(\"status\") != 201 or \"id\" not in plan_data.get(\"response\", {}):\n raise RuntimeError(f\"Failed to create plan: {plan_data}\")\n cls._plan_id = plan_data[\"response\"][\"id\"]\n\n @classmethod\n def tearDownClass(cls):\n cls.delete_customer()\n\n def test_all(self):\n \"\"\"\n Test Module: Subscription\n \"\"\"\n card_token = self.create_card_token()\n card_token_id = card_token['response']['id']\n\n random_reason_number = random.randint(100000, 999999)\n subscription_payload = {\n \"back_url\": \"https://www.mercadopago.com.co/subscriptions\",\n \"reason\": f\"MercadoPago API Subscription #{random_reason_number}\",\n \"external_reference\": \"CustomIdentifier\",\n \"payer_email\": self._customer_email,\n \"preapproval_plan_id\": self._plan_id,\n \"card_token_id\": card_token_id,\n \"status\": \"authorized\",\n \"auto_recurring\": {\n \"frequency\": 1,\n \"frequency_type\": \"months\",\n \"transaction_amount\": 60,\n \"currency_id\": \"ARS\"\n }\n }\n\n subscription_response = self.sdk.subscription().create(subscription_payload)\n self.assertEqual(subscription_response[\"status\"], 201)\n\n subscription_object = subscription_response['response']\n self.assertIn('init_point', subscription_object)\n self.assertEqual(\n subscription_object[\"external_reference\"], subscription_payload[\"external_reference\"])\n self.assertEqual(subscription_object[\"status\"], \"authorized\")\n\n update_payload = {\n \"reason\": f\"MercadoPago API Subscription A #{random_reason_number}\",\n }\n update_response = self.sdk.subscription().update(\n subscription_object[\"id\"], update_payload)\n self.assertEqual(update_response[\"status\"], 200)\n update_object = update_response[\"response\"]\n self.assertEqual(update_object[\"reason\"], update_payload[\"reason\"])\n\n get_response = self.sdk.subscription().get(subscription_object[\"id\"])\n self.assertEqual(get_response[\"status\"], 200)\n get_object = get_response[\"response\"]\n self.assertEqual(get_object[\"id\"], subscription_object[\"id\"])\n\n search_response = self.sdk.subscription().search()\n self.assertEqual(search_response[\"status\"], 200)\n search_object = search_response[\"response\"]\n self.assertTrue(\"results\" in search_object)\n self.assertTrue(isinstance(search_object[\"results\"], list))\n\n def test_create_subscriptions_without_a_plan(self):\n \"\"\"\n Test Module: Subscription\n\n Test subscription creation without a plan\n \"\"\"\n card_token = self.create_card_token()\n card_token_id = card_token['response']['id']\n\n random_reason_number = random.randint(100000, 999999)\n subscription_payload = {\n \"back_url\": \"https://www.mercadopago.com.co/subscriptions\",\n \"reason\": f\"MercadoPago API Subscription B #{random_reason_number}\",\n \"external_reference\": \"CustomIdentifier\",\n \"payer_email\": self._customer_email,\n \"card_token_id\": card_token_id,\n \"auto_recurring\": {\n \"frequency\": 1,\n \"frequency_type\": \"months\",\n \"transaction_amount\": 60,\n \"currency_id\": \"BRL\",\n },\n \"status\": \"authorized\"\n }\n\n subscription_response = self.sdk.subscription().create(subscription_payload)\n if subscription_response.get(\"status\") != 201:\n raise RuntimeError(f\"Failed to to create subscription: {subscription_response}\")\n self.assertEqual(subscription_response[\"status\"], 201)\n\n subscription_object = subscription_response['response']\n self.assertIn('init_point', subscription_object)\n self.assertEqual(\n subscription_object[\"external_reference\"], subscription_payload[\"external_reference\"])\n self.assertEqual(subscription_object[\"status\"], \"authorized\")\n\n @classmethod\n def create_card_token(cls):\n card_token_object = {\n \"card_number\": \"5031433215406351\",\n \"security_code\": \"123\",\n \"expiration_year\": datetime.now().strftime(\"%Y\"),\n \"expiration_month\": \"12\",\n \"cardholder\": {\n \"name\": \"APRO\",\n \"identification\": {\n \"CPF\": \"19119119100\"\n }\n }\n }\n return cls.sdk.card_token().create(card_token_object)\n\n @classmethod\n def create_customer(cls):\n random_email_id = random.randint(100000, 999999)\n customer_object = {\n \"email\": f\"test_payer_{random_email_id}@testuser.com\",\n \"first_name\": \"Python\",\n \"last_name\": \"Mercado\",\n \"phone\": {\n \"area_code\": \"03492\",\n \"number\": \"432334\"\n },\n \"identification\": {\n \"type\": \"DNI\",\n \"number\": \"29804555\"\n },\n \"description\": \"customer description\"\n }\n\n return cls.sdk.customer().create(customer_object)\n\n @classmethod\n def delete_customer(cls):\n cls.sdk.customer().delete(cls._customer_id)\n\n @classmethod\n def create_plan(cls):\n plan_object = {\n \"auto_recurring\": {\n \"frequency\": 1,\n \"frequency_type\": \"months\",\n \"transaction_amount\": 60,\n \"currency_id\": \"BRL\",\n },\n \"back_url\": \"https://www.mercadopago.com.co/subscriptions\",\n \"reason\": f\"Test Plan #{random.randint(100000, 999999)}\",\n }\n return cls.sdk.plan().create(plan_object)\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" }, { "path": "tests/test_user.py", "content": "\"\"\"\n Module: test_user\n\"\"\"\nimport os\nimport unittest\nimport mercadopago\n\n\nclass TestUser(unittest.TestCase):\n sdk = mercadopago.SDK(os.environ['ACCESS_TOKEN'])\n\n def test_find_user(self):\n self.assertEqual(self.sdk.user().get()[\"status\"], 200)\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" } ]