diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index f01a182..0000000 --- a/.editorconfig +++ /dev/null @@ -1,13 +0,0 @@ -# EditorConfig is awesome: https://EditorConfig.org - -root = true - -[*] -end_of_line = lf -insert_final_newline = true -indent_style = space -indent_size = 4 -charset = utf-8 - -[Makefile] -indent_style = tab diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml deleted file mode 100644 index a8b6a17..0000000 --- a/.github/workflows/main.yml +++ /dev/null @@ -1,60 +0,0 @@ -## -# A GitHub Action to run Tox - -name: Tox - -# Controls when the action will run. -on: - # Triggers the workflow on push or pull request events but only for the master branch - pull_request: - branches: - - master - push: - branches: - - master - - tox-action - - # Allows you to run this workflow manually from the Actions tab - workflow_dispatch: - -# A workflow run is made up of one or more jobs that can run sequentially or in parallel -jobs: - # This workflow contains a single job called "build" - py310: - runs-on: ubuntu-latest - container: python:3.10-alpine - - # Steps represent a sequence of tasks that will be executed as part of the job - steps: - # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - - uses: actions/checkout@v2 - - # Runs a single command using the runners shell - - name: Install Tox - run: pip install --user --upgrade tox - - - name: Run Tox - env: - TOXENV: py310 - run: | - "$HOME/.local/bin/tox" - - py27: - runs-on: ubuntu-latest - container: python:2.7-alpine - - # Steps represent a sequence of tasks that will be executed as part of the job - steps: - # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - - uses: actions/checkout@v2 - - # Runs a single command using the runners shell - - name: Install Tox - run: pip install --user --upgrade tox - - - name: Run Tox - env: - TOXENV: py27 - run: | - "$HOME/.local/bin/tox" - diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml deleted file mode 100644 index 4e1ef42..0000000 --- a/.github/workflows/python-publish.yml +++ /dev/null @@ -1,31 +0,0 @@ -# This workflows will upload a Python Package using Twine when a release is created -# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries - -name: Upload Python Package - -on: - release: - types: [created] - -jobs: - deploy: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - name: Set up Python - uses: actions/setup-python@v2 - with: - python-version: '3.x' - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install setuptools wheel twine - - name: Build and publish - env: - TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }} - TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }} - run: | - python setup.py sdist bdist_wheel - twine upload dist/* diff --git a/.gitignore b/.gitignore index ced8450..93959ac 100644 --- a/.gitignore +++ b/.gitignore @@ -1,38 +1,5 @@ -*.py[cod] - -# C extensions -*.so - -# Packages -*.egg -*.egg-info -dist -build -eggs -parts -bin -var -sdist -develop-eggs -.installed.cfg -lib -lib64 - -# Installer logs -pip-log.txt - -# Unit test / coverage reports -.venv/ -.coverage -.tox -nosetests.xml - -# Translations -*.mo - -# Mr Developer -.mr.developer.cfg -.project -.pydevproject -.idea -.cache +.vscode +.history +certs +env_itauapipix.py +__pycache__ \ No newline at end of file diff --git a/.python-version b/.python-version new file mode 100644 index 0000000..d46a420 --- /dev/null +++ b/.python-version @@ -0,0 +1 @@ +itauapipix_3920 diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 8327ded..0000000 --- a/.travis.yml +++ /dev/null @@ -1,7 +0,0 @@ -sudo: false -language: python -python: - - "2.7" - - "3.6" -install: pip install tox-travis -script: tox diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 62e2163..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,158 +0,0 @@ -Changelog -========= - -3.7 (2023-01-09) ----------------- - -- Fix `Csv` cast hanging with `default=None`, now returning an empty list. (#149) - -3.6 (2022-02-02) ----------------- - -- Add support for Docker secrets. -- Fix deprecation warning on Python 3.10 - -3.5 (2021-09-30) ----------------- - -- Fix: fix syntax warnings due to comparison of literals using `is` -- Fix: avoid DeprecationError on ConfigParser.readfp() -- Add Tox Github Action -- Documentation fixups -- Security: bump Pygments version to >=2.7.4 -- Fix .env -file quote stripping -- Changelog catchups for 3.2 and 3.3 - - -3.4 (2021-01-05) ----------------- - -- Add choices helper -- Documentation fixups - - -3.3 (2019-11-13) ----------------- - -- Enforce search order in settings files -- Switch to using strtobool (#71) - - -3.2 (2019-11-13) ----------------- - -- Fixed typos in documentation -- Add editorconfig file -- Fix handling for configuration values that end in single or double quotes (#78) -- Add support for encoding env files in other encodings (#62) (#64) -- Improve csv documentation (#59) -- Add Changelog #44 -- Fixed typo. [Vik] -- Fix the code blocks inline in the documentation, adding two quotes. [Manaia Junior] -- Fixed argument in Csv documentation. [Manaia Junior] - - -3.1 (2017-08-07) ----------------- -- Improve README -- Improve tests -- Add support for Csv to be able to return tuple format. Closes #38. [Henrique Bastos] -- Move Csv doc to proper section. [Henrique Bastos] -- Add a post_process argument do Csv. [Henrique Bastos] -- Add support for Csv to be able to return in tuple format. [Manaia Junior] -- Closes #24. [Henrique Bastos] -- Added empty string as False value. [Rafael Sierra] -- Use context manager when opening files. [Jon Banafato] -- Explicitly name summary section. [Henrique Bastos] -- Simplify Repository hierarchy. [Henrique Bastos] -- Fix code quality. [Henrique Bastos] -- Fix case where Option exists on ENV, but not on repository. [Henrique Bastos] #27 -- Allow to override initial search path in AutoConfig class. [Rolando Espinoza] -- Update dependencies. [Henrique Bastos] -- Fixes bug while looking for config file in parent dirs. [Flavio Amieiro] -- Add section explaining environment variable override. [Henrique Bastos] - - -3.0 (2015-09-15) ----------------- -- Update README for 3.0. [Henrique Bastos] -- Force os.environ to override Ini and Env. [Henrique Bastos] - - -2.4 (2015-09-15) ----------------- -- Update requirements. [Henrique Bastos] -- Check if filepath is really a file, not a directory. [Thiago Garcia] -- Fix LIST_OF_INTEGERS CSV example on README. [KS Chan] -- Fix headline marks. [Henrique Bastos] -- Explicitly mention how to comment a line. [Henrique Bastos] -- Typo: A(tt)ention. [Thomas Güttler] - - -2.3 (2015-03-19) ----------------- -- Readme fix adding syntax highlight for python console. [Henrique Bastos] -- Add Csv Helper. [Henrique Bastos] -- Update development dependencies’ versions. [Henrique Bastos] -- Update tox to use python 3.4. [Henrique Bastos] -- Fix annoying error when env lines have non relevant whitespace. [Henrique Bastos] -- Test empty key on ini. [Henrique Bastos] -- Fix #3: return empty string when envvar is empty. [Osvaldo Santana Neto] - - -2.2 (2015-03-19) ----------------- -- Improve README -- Add notice on fail fast policy. [Henrique Bastos] -- Fix boolean conversion of default value. [Henrique Bastos] -- Update setup.py. [Henrique Bastos] -- Add docutils and pygments to development's requirements.txt. [Henrique Bastos] -- Upgrade development dependencies. [Henrique Bastos] -- Fix more landscape reports. [Henrique Bastos] -- Fixing landscape reported issues. [Henrique Bastos] -- Refactor tests to use fixtures. [Henrique Bastos] -- Fix tests to use Repositories. [Henrique Bastos] -- Adapt AutoConfig to use Repositories with Config. [Henrique Bastos] -- Fix RepositoryEnv logic. [Henrique Bastos] -- Unify Config classes into one. [Henrique Bastos] -- Add comments. [Henrique Bastos] -- Remove unused variables. [Henrique Bastos] -- Add Repository classes. [Henrique Bastos] -- Change ConfigEnv behavior to raise when option or default are undefined. [Henrique Bastos] - - -2.1 (2015-03-19) ----------------- -- Test we have access to envvar when we have no file. [Henrique Bastos] -- Deal with access errors. [Henrique Bastos] -- Fix stupid bug on Heroku. [Henrique Bastos] -- Fix inline style on README. [Henrique Bastos] -- Improve explanation about how decouple works. [Henrique Bastos] -- Add build status image. [Henrique Bastos] -- Configure travis-ci. [Henrique Bastos] -- Add tox. [Henrique Bastos] -- Add support for Python3. [Henrique Bastos] -- Implement fallback to os.environ. [Henrique Bastos] -- Remove load method. [Henrique Bastos] -- Isolate logic for reading .env. [Henrique Bastos] - - -2.0 (2015-03-19) ----------------- -- Improve README. [Henrique Bastos] -- Move exception to a better context. [Henrique Bastos] -- Replace cwd with current module's path. [Henrique Bastos] -- Add a requirements.txt for developers. [Henrique Bastos] -- Implement AutoConfig. [Henrique Bastos] -- Extract the basic API to a base class. [Henrique Bastos] -- Implement ConfigEnv. [Henrique Bastos] -- Add tests to ConfigIni. [Henrique Bastos] -- Make sure to initialize instance attributes. [Henrique Bastos] -- Ignore PyCharm project dir. [Henrique Bastos] - - -1.0 (2015-03-19) ----------------- -- Improve API replacing type with cast. [Henrique Bastos] -- Import code. [Henrique Bastos] -- Add license, readme and setup. [Henrique Bastos] diff --git a/LICENSE b/LICENSE deleted file mode 100644 index f7e78fe..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License - -Copyright (c) 2013 Henrique Bastos - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index 1aba38f..0000000 --- a/MANIFEST.in +++ /dev/null @@ -1 +0,0 @@ -include LICENSE diff --git a/tests/autoconfig/env/project/empty.txt b/README.md similarity index 100% rename from tests/autoconfig/env/project/empty.txt rename to README.md diff --git a/README.rst b/README.rst deleted file mode 100644 index 4184536..0000000 --- a/README.rst +++ /dev/null @@ -1,513 +0,0 @@ -======================================================== -Python Decouple: Strict separation of settings from code -======================================================== - -*Decouple* helps you to organize your settings so that you can -change parameters without having to redeploy your app. - -It also makes it easy for you to: - -#. store parameters in *ini* or *.env* files; -#. define comprehensive default values; -#. properly convert values to the correct data type; -#. have **only one** configuration module to rule all your instances. - -It was originally designed for Django, but became an independent generic tool -for separating settings from code. - -.. image:: https://img.shields.io/travis/henriquebastos/python-decouple.svg - :target: https://travis-ci.org/henriquebastos/python-decouple - :alt: Build Status - -.. image:: https://img.shields.io/pypi/v/python-decouple.svg - :target: https://pypi.python.org/pypi/python-decouple/ - :alt: Latest PyPI version - -.. contents:: Summary - - -Why? -==== - -The settings files in web frameworks store many different kinds of parameters: - -* Locale and i18n; -* Middlewares and Installed Apps; -* Resource handles to the database, Memcached, and other backing services; -* Credentials to external services such as Amazon S3 or Twitter; -* Per-deploy values such as the canonical hostname for the instance. - -The first 2 are *project settings* and the last 3 are *instance settings*. - -You should be able to change *instance settings* without redeploying your app. - - -Why not just use environment variables? ---------------------------------------- - -*Envvars* works, but since ``os.environ`` only returns strings, it's tricky. - -Let's say you have an *envvar* ``DEBUG=False``. If you run: - -.. code-block:: python - - if os.environ['DEBUG']: - print True - else: - print False - -It will print **True**, because ``os.environ['DEBUG']`` returns the **string** ``"False"``. -Since it's a non-empty string, it will be evaluated as True. - -*Decouple* provides a solution that doesn't look like a workaround: ``config('DEBUG', cast=bool)``. - - -Usage -===== - -Install: - -.. code-block:: console - - pip install python-decouple - - -Then use it on your ``settings.py``. - -#. Import the ``config`` object: - - .. code-block:: python - - from decouple import config - -#. Retrieve the configuration parameters: - - .. code-block:: python - - SECRET_KEY = config('SECRET_KEY') - DEBUG = config('DEBUG', default=False, cast=bool) - EMAIL_HOST = config('EMAIL_HOST', default='localhost') - EMAIL_PORT = config('EMAIL_PORT', default=25, cast=int) - - -Encodings ---------- - -Decouple's default encoding is `UTF-8`. - -But you can specify your preferred encoding. - -Since `config` is lazy and only opens the configuration file when it's first needed, you have the chance to change -its encoding right after import. - -.. code-block:: python - - from decouple import config - config.encoding = 'cp1251' - SECRET_KEY = config('SECRET_KEY') - -If you wish to fall back to your system's default encoding use: - -.. code-block:: python - - import locale - from decouple import config - config.encoding = locale.getpreferredencoding(False) - SECRET_KEY = config('SECRET_KEY') - - -Where is the settings data stored? ----------------------------------- - -*Decouple* supports both *.ini* and *.env* files. - - -Ini file -~~~~~~~~ - -Simply create a ``settings.ini`` next to your configuration module in the form: - -.. code-block:: ini - - [settings] - DEBUG=True - TEMPLATE_DEBUG=%(DEBUG)s - SECRET_KEY=ARANDOMSECRETKEY - DATABASE_URL=mysql://myuser:mypassword@myhost/mydatabase - PERCENTILE=90%% - #COMMENTED=42 - -*Note*: Since ``ConfigParser`` supports *string interpolation*, to represent the character ``%`` you need to escape it as ``%%``. - - -Env file -~~~~~~~~ - -Simply create a ``.env`` text file in your repository's root directory in the form: - -.. code-block:: console - - DEBUG=True - TEMPLATE_DEBUG=True - SECRET_KEY=ARANDOMSECRETKEY - DATABASE_URL=mysql://myuser:mypassword@myhost/mydatabase - PERCENTILE=90% - #COMMENTED=42 - - -Example: How do I use it with Django? -------------------------------------- - -Given that I have a ``.env`` file in my repository's root directory, here is a snippet of my ``settings.py``. - -I also recommend using `pathlib `_ -and `dj-database-url `_. - -.. code-block:: python - - # coding: utf-8 - from decouple import config - from unipath import Path - from dj_database_url import parse as db_url - - - BASE_DIR = Path(__file__).parent - - DEBUG = config('DEBUG', default=False, cast=bool) - TEMPLATE_DEBUG = DEBUG - - DATABASES = { - 'default': config( - 'DATABASE_URL', - default='sqlite:///' + BASE_DIR.child('db.sqlite3'), - cast=db_url - ) - } - - TIME_ZONE = 'America/Sao_Paulo' - USE_L10N = True - USE_TZ = True - - SECRET_KEY = config('SECRET_KEY') - - EMAIL_HOST = config('EMAIL_HOST', default='localhost') - EMAIL_PORT = config('EMAIL_PORT', default=25, cast=int) - EMAIL_HOST_PASSWORD = config('EMAIL_HOST_PASSWORD', default='') - EMAIL_HOST_USER = config('EMAIL_HOST_USER', default='') - EMAIL_USE_TLS = config('EMAIL_USE_TLS', default=False, cast=bool) - - # ... - - -Attention with *undefined* parameters -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -In the above example, all configuration parameters except ``SECRET_KEY = config('SECRET_KEY')`` -have a default value in case it does not exist in the ``.env`` file. - -If ``SECRET_KEY`` is not present in the ``.env``, *decouple* will raise an ``UndefinedValueError``. - -This *fail fast* policy helps you avoid chasing misbehaviours when you eventually forget a parameter. - - -Overriding config files with environment variables -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Sometimes you may want to change a parameter value without having to edit the ``.ini`` or ``.env`` files. - -Since version 3.0, *decouple* respects the *unix way*. -Therefore environment variables have precedence over config files. - -To override a config parameter you can simply do: - -.. code-block:: console - - DEBUG=True python manage.py - - -How does it work? -================= - -*Decouple* always searches for *Options* in this order: - -#. Environment variables; -#. Repository: ini or .env file; -#. Default argument passed to config. - -There are 4 classes doing the magic: - - -- ``Config`` - - Coordinates all the configuration retrieval. - -- ``RepositoryIni`` - - Can read values from ``os.environ`` and ini files, in that order. - - **Note:** Since version 3.0 *decouple* respects unix precedence of environment variables *over* config files. - -- ``RepositoryEnv`` - - Can read values from ``os.environ`` and ``.env`` files. - - **Note:** Since version 3.0 *decouple* respects unix precedence of environment variables *over* config files. - -- ``AutoConfig`` - - This is a *lazy* ``Config`` factory that detects which configuration repository you're using. - - It recursively searches up your configuration module path looking for a - ``settings.ini`` or a ``.env`` file. - - Optionally, it accepts ``search_path`` argument to explicitly define - where the search starts. - -The **config** object is an instance of ``AutoConfig`` that instantiates a ``Config`` with the proper ``Repository`` -on the first time it is used. - - -Understanding the CAST argument -------------------------------- - -By default, all values returned by ``decouple`` are ``strings``, after all they are -read from ``text files`` or the ``envvars``. - -However, your Python code may expect some other value type, for example: - -* Django's ``DEBUG`` expects a boolean ``True`` or ``False``. -* Django's ``EMAIL_PORT`` expects an ``integer``. -* Django's ``ALLOWED_HOSTS`` expects a ``list`` of hostnames. -* Django's ``SECURE_PROXY_SSL_HEADER`` expects a ``tuple`` with two elements, the name of the header to look for and the required value. - -To meet this need, the ``config`` function accepts a ``cast`` argument which -receives any *callable*, that will be used to *transform* the string value -into something else. - -Let's see some examples for the above mentioned cases: - -.. code-block:: python - - >>> os.environ['DEBUG'] = 'False' - >>> config('DEBUG', cast=bool) - False - - >>> os.environ['EMAIL_PORT'] = '42' - >>> config('EMAIL_PORT', cast=int) - 42 - - >>> os.environ['ALLOWED_HOSTS'] = '.localhost, .herokuapp.com' - >>> config('ALLOWED_HOSTS', cast=lambda v: [s.strip() for s in v.split(',')]) - ['.localhost', '.herokuapp.com'] - - >>> os.environ['SECURE_PROXY_SSL_HEADER'] = 'HTTP_X_FORWARDED_PROTO, https' - >>> config('SECURE_PROXY_SSL_HEADER', cast=Csv(post_process=tuple)) - ('HTTP_X_FORWARDED_PROTO', 'https') - -As you can see, ``cast`` is very flexible. But the last example got a bit complex. - - -Built in Csv Helper -~~~~~~~~~~~~~~~~~~~ - -To address the complexity of the last example, *Decouple* comes with an extensible *Csv helper*. - -Let's improve the last example: - -.. code-block:: python - - >>> from decouple import Csv - >>> os.environ['ALLOWED_HOSTS'] = '.localhost, .herokuapp.com' - >>> config('ALLOWED_HOSTS', cast=Csv()) - ['.localhost', '.herokuapp.com'] - -You can also have a `default` value that must be a string to be processed by `Csv`. - -.. code-block:: python - - >>> from decouple import Csv - >>> config('ALLOWED_HOSTS', default='127.0.0.1', cast=Csv()) - ['127.0.0.1'] - -You can also parametrize the *Csv Helper* to return other types of data. - -.. code-block:: python - - >>> os.environ['LIST_OF_INTEGERS'] = '1,2,3,4,5' - >>> config('LIST_OF_INTEGERS', cast=Csv(int)) - [1, 2, 3, 4, 5] - - >>> os.environ['COMPLEX_STRING'] = '%virtual_env%\t *important stuff*\t trailing spaces ' - >>> csv = Csv(cast=lambda s: s.upper(), delimiter='\t', strip=' %*') - >>> csv(os.environ['COMPLEX_STRING']) - ['VIRTUAL_ENV', 'IMPORTANT STUFF', 'TRAILING SPACES'] - -By default *Csv* returns a ``list``, but you can get a ``tuple`` or whatever you want using the ``post_process`` argument: - -.. code-block:: python - - >>> os.environ['SECURE_PROXY_SSL_HEADER'] = 'HTTP_X_FORWARDED_PROTO, https' - >>> config('SECURE_PROXY_SSL_HEADER', cast=Csv(post_process=tuple)) - ('HTTP_X_FORWARDED_PROTO', 'https') - - -Built in Choices helper -~~~~~~~~~~~~~~~~~~~~~~~ - -Allows for cast and validation based on a list of choices. For example: - -.. code-block:: python - - >>> from decouple import config, Choices - >>> os.environ['CONNECTION_TYPE'] = 'usb' - >>> config('CONNECTION_TYPE', cast=Choices(['eth', 'usb', 'bluetooth'])) - 'usb' - - >>> os.environ['CONNECTION_TYPE'] = 'serial' - >>> config('CONNECTION_TYPE', cast=Choices(['eth', 'usb', 'bluetooth'])) - Traceback (most recent call last): - ... - ValueError: Value not in list: 'serial'; valid values are ['eth', 'usb', 'bluetooth'] - -You can also parametrize *Choices helper* to cast to another type: - -.. code-block:: python - - >>> os.environ['SOME_NUMBER'] = '42' - >>> config('SOME_NUMBER', cast=Choices([7, 14, 42], cast=int)) - 42 - -You can also use a Django-like choices tuple: - -.. code-block:: python - - >>> USB = 'usb' - >>> ETH = 'eth' - >>> BLUETOOTH = 'bluetooth' - >>> - >>> CONNECTION_OPTIONS = ( - ... (USB, 'USB'), - ... (ETH, 'Ethernet'), - ... (BLUETOOTH, 'Bluetooth'),) - ... - >>> os.environ['CONNECTION_TYPE'] = BLUETOOTH - >>> config('CONNECTION_TYPE', cast=Choices(choices=CONNECTION_OPTIONS)) - 'bluetooth' - - -Frequently Asked Questions -========================== - - -1) How to specify the `.env` path? ----------------------------------- - -.. code-block:: python - - import os - from decouple import Config, RepositoryEnv - - - config = Config(RepositoryEnv("path/to/.env")) - - -2) How to use python-decouple with Jupyter? -------------------------------------------- - -.. code-block:: python - - import os - from decouple import Config, RepositoryEnv - - - config = Config(RepositoryEnv("path/to/.env")) - - -3) How to specify a file with another name instead of `.env`? ----------------------------------------------------------------- - -.. code-block:: python - - import os - from decouple import Config, RepositoryEnv - - - config = Config(RepositoryEnv("path/to/somefile-like-env")) - - -4) How to define the path to my env file on a env var? --------------------------------------------------------- - -.. code-block:: python - - import os - from decouple import Config, RepositoryEnv - - - DOTENV_FILE = os.environ.get("DOTENV_FILE", ".env") # only place using os.environ - config = Config(RepositoryEnv(DOTENV_FILE)) - - -5) How can I have multiple *env* files working together? --------------------------------------------------------- - -.. code-block:: python - - from collections import ChainMap - from decouple import Config, RepositoryEnv - - - config = Config(ChainMap(RepositoryEnv(".private.env"), RepositoryEnv(".env"))) - - -Contribute -========== - -Your contribution is welcome. - -Setup your development environment: - -.. code-block:: console - - git clone git@github.com:henriquebastos/python-decouple.git - cd python-decouple - python -m venv .venv - source .venv/bin/activate - pip install -r requirements.txt - tox - -*Decouple* supports both Python 2.7 and 3.6. Make sure you have both installed. - -I use `pyenv `_ to -manage multiple Python versions and I described my workspace setup on this article: -`The definitive guide to setup my Python workspace -`_ - -You can submit pull requests and issues for discussion. However I only -consider merging tested code. - - -License -======= - -The MIT License (MIT) - -Copyright (c) 2017 Henrique Bastos - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/decouple.py b/decouple.py deleted file mode 100644 index 9873fc9..0000000 --- a/decouple.py +++ /dev/null @@ -1,316 +0,0 @@ -# coding: utf-8 -import os -import sys -import string -from shlex import shlex -from io import open -from collections import OrderedDict - -# Useful for very coarse version differentiation. -PYVERSION = sys.version_info - - -if PYVERSION >= (3, 0, 0): - from configparser import ConfigParser, NoOptionError - text_type = str -else: - from ConfigParser import SafeConfigParser as ConfigParser, NoOptionError - text_type = unicode - -if PYVERSION >= (3, 2, 0): - read_config = lambda parser, file: parser.read_file(file) -else: - read_config = lambda parser, file: parser.readfp(file) - - -DEFAULT_ENCODING = 'UTF-8' - - -# Python 3.10 don't have strtobool anymore. So we move it here. -TRUE_VALUES = {"y", "yes", "t", "true", "on", "1"} -FALSE_VALUES = {"n", "no", "f", "false", "off", "0"} - -def strtobool(value): - if isinstance(value, bool): - return value - value = value.lower() - - if value in TRUE_VALUES: - return True - elif value in FALSE_VALUES: - return False - - raise ValueError("Invalid truth value: " + value) - - -class UndefinedValueError(Exception): - pass - - -class Undefined(object): - """ - Class to represent undefined type. - """ - pass - - -# Reference instance to represent undefined values -undefined = Undefined() - - -class Config(object): - """ - Handle .env file format used by Foreman. - """ - - def __init__(self, repository): - self.repository = repository - - def _cast_boolean(self, value): - """ - Helper to convert config values to boolean as ConfigParser do. - """ - value = str(value) - return bool(value) if value == '' else bool(strtobool(value)) - - @staticmethod - def _cast_do_nothing(value): - return value - - def get(self, option, default=undefined, cast=undefined): - """ - Return the value for option or default if defined. - """ - - # We can't avoid __contains__ because value may be empty. - if option in os.environ: - value = os.environ[option] - elif option in self.repository: - value = self.repository[option] - else: - if isinstance(default, Undefined): - raise UndefinedValueError('{} not found. Declare it as envvar or define a default value.'.format(option)) - - value = default - - if isinstance(cast, Undefined): - cast = self._cast_do_nothing - elif cast is bool: - cast = self._cast_boolean - - return cast(value) - - def __call__(self, *args, **kwargs): - """ - Convenient shortcut to get. - """ - return self.get(*args, **kwargs) - - -class RepositoryEmpty(object): - def __init__(self, source='', encoding=DEFAULT_ENCODING): - pass - - def __contains__(self, key): - return False - - def __getitem__(self, key): - return None - - -class RepositoryIni(RepositoryEmpty): - """ - Retrieves option keys from .ini files. - """ - SECTION = 'settings' - - def __init__(self, source, encoding=DEFAULT_ENCODING): - self.parser = ConfigParser() - with open(source, encoding=encoding) as file_: - read_config(self.parser, file_) - - def __contains__(self, key): - return (key in os.environ or - self.parser.has_option(self.SECTION, key)) - - def __getitem__(self, key): - try: - return self.parser.get(self.SECTION, key) - except NoOptionError: - raise KeyError(key) - - -class RepositoryEnv(RepositoryEmpty): - """ - Retrieves option keys from .env files with fall back to os.environ. - """ - def __init__(self, source, encoding=DEFAULT_ENCODING): - self.data = {} - - with open(source, encoding=encoding) as file_: - for line in file_: - line = line.strip() - if not line or line.startswith('#') or '=' not in line: - continue - k, v = line.split('=', 1) - k = k.strip() - v = v.strip() - if len(v) >= 2 and ((v[0] == "'" and v[-1] == "'") or (v[0] == '"' and v[-1] == '"')): - v = v[1:-1] - self.data[k] = v - - def __contains__(self, key): - return key in os.environ or key in self.data - - def __getitem__(self, key): - return self.data[key] - - -class RepositorySecret(RepositoryEmpty): - """ - Retrieves option keys from files, - where title of file is a key, content of file is a value - e.g. Docker swarm secrets - """ - - def __init__(self, source='/run/secrets/'): - self.data = {} - - ls = os.listdir(source) - for file in ls: - with open(os.path.join(source, file), 'r') as f: - self.data[file] = f.read() - - def __contains__(self, key): - return key in os.environ or key in self.data - - def __getitem__(self, key): - return self.data[key] - - -class AutoConfig(object): - """ - Autodetects the config file and type. - - Parameters - ---------- - search_path : str, optional - Initial search path. If empty, the default search path is the - caller's path. - - """ - SUPPORTED = OrderedDict([ - ('settings.ini', RepositoryIni), - ('.env', RepositoryEnv), - ]) - - encoding = DEFAULT_ENCODING - - def __init__(self, search_path=None): - self.search_path = search_path - self.config = None - - def _find_file(self, path): - # look for all files in the current path - for configfile in self.SUPPORTED: - filename = os.path.join(path, configfile) - if os.path.isfile(filename): - return filename - - # search the parent - parent = os.path.dirname(path) - if parent and os.path.normcase(parent) != os.path.normcase(os.path.abspath(os.sep)): - return self._find_file(parent) - - # reached root without finding any files. - return '' - - def _load(self, path): - # Avoid unintended permission errors - try: - filename = self._find_file(os.path.abspath(path)) - except Exception: - filename = '' - Repository = self.SUPPORTED.get(os.path.basename(filename), RepositoryEmpty) - - self.config = Config(Repository(filename, encoding=self.encoding)) - - def _caller_path(self): - # MAGIC! Get the caller's module path. - frame = sys._getframe() - path = os.path.dirname(frame.f_back.f_back.f_code.co_filename) - return path - - def __call__(self, *args, **kwargs): - if not self.config: - self._load(self.search_path or self._caller_path()) - - return self.config(*args, **kwargs) - - -# A pré-instantiated AutoConfig to improve decouple's usability -# now just import config and start using with no configuration. -config = AutoConfig() - -# Helpers - -class Csv(object): - """ - Produces a csv parser that return a list of transformed elements. - """ - - def __init__(self, cast=text_type, delimiter=',', strip=string.whitespace, post_process=list): - """ - Parameters: - cast -- callable that transforms the item just before it's added to the list. - delimiter -- string of delimiters chars passed to shlex. - strip -- string of non-relevant characters to be passed to str.strip after the split. - post_process -- callable to post process all casted values. Default is `list`. - """ - self.cast = cast - self.delimiter = delimiter - self.strip = strip - self.post_process = post_process - - def __call__(self, value): - """The actual transformation""" - if value is None: - return self.post_process() - - transform = lambda s: self.cast(s.strip(self.strip)) - - splitter = shlex(value, posix=True) - splitter.whitespace = self.delimiter - splitter.whitespace_split = True - - return self.post_process(transform(s) for s in splitter) - - -class Choices(object): - """ - Allows for cast and validation based on a list of choices. - """ - - def __init__(self, flat=None, cast=text_type, choices=None): - """ - Parameters: - flat -- a flat list of valid choices. - cast -- callable that transforms value before validation. - choices -- tuple of Django-like choices. - """ - self.flat = flat or [] - self.cast = cast - self.choices = choices or [] - - self._valid_values = [] - self._valid_values.extend(self.flat) - self._valid_values.extend([value for value, _ in self.choices]) - - def __call__(self, value): - transform = self.cast(value) - if transform not in self._valid_values: - raise ValueError(( - 'Value not in list: {!r}; valid values are {!r}' - ).format(value, self._valid_values)) - else: - return transform diff --git a/docs/API - QRcode.postman_collection (1).json b/docs/API - QRcode.postman_collection (1).json new file mode 100644 index 0000000..4baf01c --- /dev/null +++ b/docs/API - QRcode.postman_collection (1).json @@ -0,0 +1,3477 @@ +{ + "info": { + "_postman_id": "471f85b1-e3b2-4d09-a63f-7566d048d0e0", + "name": "API - QRcode", + "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json", + "_exporter_id": "15739169" + }, + "item": [ + { + "name": "Envio CSR e Atualização CRT", + "item": [ + { + "name": "Envio de arquivo CSR", + "request": { + "auth": { + "type": "bearer", + "bearer": {} + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "text/plain", + "type": "text" + }, + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI5ZjgwNTliMS0xZWJmLTQzNzUtODIxNC1iNDFhYjVmN2Y1MDEiLCJhdXQiOiIiLCJ2ZXIiOiJ2MS4wIiwiaXNzIjoiaHR0cHM6XC9cL29wZW5pZC5pdGF1LmNvbS5iclwvYXBpXC9vYXV0aFwvdG9rZW4iLCJBY2Nlc3NfVG9rZW4iOiJzTG93NG9PN2l5bUs3amI2bk1FTU5XR3JLcjVuWkZaUnMyck5mTkNjaWtwRTFEbGdycWFqMzgiLCJzb3VyY2UiOiJFWFQiLCJlbnYiOiJQIiwic2l0ZSI6ImN0bW0xIiwidXNyIjoibnVsbCIsIm1iaSI6InRydWUiLCJzY29wZSI6InJlc291cmNlLlJFQUQiLCJleHAiOjE1NzY2OTk2ODQsImlhdCI6MTU3NjYxMzI4NCwiZmxvdyI6IkNDIn0.qRRjzfeImc6Us0KrFCsn2aKIqgZH0eJhkAj6C8eKBX8", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "-----BEGIN CERTIFICATE REQUEST-----\nMIICrTCCAZUCAQAwaDEtMCsGA1UEAwwkOWY4MDU5YjEtMWViZi00Mzc1LTgyMTQt\nYjQxYWI1ZjdmNTAxMQ0wCwYDVQQLDARET1VHMQ4wDAYDVQQHDAVTQU1QQTELMAkG\nA1UECAwCU1AxCzAJBgNVBAYTAkJSMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAuwFf/MQM2q7oPTiW4anhsnpPfc+2VnHF9/eQxyn492w35l4s0RpKGu3l\nD1smR8aXQAtRPptTg02/gQbHPRHXJXVYcCAgOTO4RN0zmTG14javzOoUtU4lzMM8\n7FbLmrXjgv37n+GCO8JaQwFW2ZzVDdBxKwOxa21FiJUxgWap2MM4Mw2qQnvo/OiB\nSCb9DfacKwATp4uNeKTpykvuko6BXDsUdK56hDroZhkEiZll2t6gYxi3mnPsXskl\nb5uZHgf5H4XwIH5mO1+W8vSwPa+f7MElb4vQLdEUX+fPF+dQsmO3XxnSr+85+fSw\nY961GLOxilV1MxUycxL00GO2o1WLDQIDAQABoAAwDQYJKoZIhvcNAQENBQADggEB\nAGLR/vHHBmgpuF4kxOSxhu2mOZn4N1rLIBdXTvt4EOQ+9MJB0pTJPBpkbqXUR0ih\nC6yYknut1UnMzbmjAO4A4L4pCGd7fP40zQ74MCO7b8SPFMOefvNzWcFqc4HZRnkD\nxWZmLzy3QYT9KEysuIJxRLcffsJckfp1yltiQji17PbYFNuNdWqEwUmoYC6rX66Z\nkZ1V8GPd5ArqCy3Vv0MoItgERWOlRbBC30K9lGTLWb4/ki87h94Xyf77w1SMM2bW\nEotEtqVWHNZoWhikCuI3Vh6wiYZXzEzN8imIZCHBg5Z61+TyIfvFwxSC+9OwpIKI\nvFteQFnhXAZpwvbzLHPRjw8=\n-----END CERTIFICATE REQUEST-----" + }, + "url": "https://sts.itau.com.br/seguranca/v1/certificado/solicitacao" + }, + "response": [] + } + ], + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + } + ] + }, + { + "name": "Obtenção Access Token", + "item": [ + { + "name": "Obtenção do access_token", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "name": "Content-Type", + "type": "text", + "value": "application/x-www-form-urlencoded" + }, + { + "key": "x-itau-flowID", + "type": "text", + "value": "1" + }, + { + "key": "x-itau-correlationID", + "type": "text", + "value": "2" + } + ], + "body": { + "mode": "urlencoded", + "urlencoded": [ + { + "key": "grant_type", + "value": "client_credentials", + "type": "text" + }, + { + "key": "client_id", + "value": "{{CLIENT_ID}}", + "type": "text" + }, + { + "key": "client_secret", + "value": "{{SECRET}}", + "type": "text" + } + ] + }, + "url": "https://sts.itau.com.br/api/oauth/token" + }, + "response": [] + } + ], + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + } + ] + }, + { + "name": "Emissão de QrCode", + "item": [ + { + "name": "QRcode Cob c/ TXID", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "var jsonData = JSON.parse(responseBody);\r", + "postman.setEnvironmentVariable(\"access_token\", jsonData.access_token);" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "bearer", + "bearer": { + "token": "{{access_token}}" + } + }, + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "type": "text", + "value": "application/json" + }, + { + "key": "x-correlationID", + "type": "text", + "value": "{{$guid}}" + }, + { + "key": "x-simulation", + "type": "text", + "value": "false" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"calendario\": {\r\n \"expiracao\": \"3600\"\r\n },\r\n \"devedor\": {\r\n \"cnpj\": \"12345678000195\",\r\n \"nome\": \"Empresa de Serviços SA\"\r\n },\r\n \"valor\": {\r\n \"original\": \"123.45\"\r\n },\r\n \"chave\": \"60701190000104\",\r\n \"solicitacaoPagador\": \"Informar cartão fidelidade\",\r\n \"infoAdicionais\": [\r\n {\r\n \"nome\": \"Campo 1\",\r\n \"valor\": \"Informação Adicional1\"\r\n },\r\n {\r\n \"nome\": \"Campo 2\",\r\n \"valor\": \"Informação Adicional2 \"\r\n }\r\n ]\r\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "https://secure.api.itau/pix_recebimentos/v2/cob/TXID" + }, + "response": [] + }, + { + "name": "Emissão do QrCode Cob", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "var jsonData = JSON.parse(responseBody);\r", + "postman.setEnvironmentVariable(\"access_token\", jsonData.access_token);" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "bearer", + "bearer": {} + }, + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI5ZjgwNTliMS0xZWJmLTQzNzUtODIxNC1iNDFhYjVmN2Y1MDEiLCJhdXQiOiIiLCJ2ZXIiOiJ2MS4wIiwiaXNzIjoiaHR0cHM6XC9cL29wZW5pZC5pdGF1LmNvbS5iclwvYXBpXC9vYXV0aFwvdG9rZW4iLCJBY2Nlc3NfVG9rZW4iOiJodU4xQ3VxTDdCTzZTNHh6NlRZWDVPell2ZnBLN2s5VDhkek1QOEdxZ3hCYjdQc1BTODJCOXUiLCJzb3VyY2UiOiJFWFQiLCJlbnYiOiJQIiwic2l0ZSI6ImN0bW0xIiwidXNyIjoibnVsbCIsIm1iaSI6InRydWUiLCJzY29wZSI6InJlc291cmNlLlJFQUQiLCJleHAiOjE1NzY3NTg1NjYsImlhdCI6MTU3Njc1ODI2NiwiZmxvdyI6IkNDIn0.RhL4wlCXmLN_fLUrCrrTAQm58hl1wBiby31AQQFUQ1I", + "type": "text" + }, + { + "key": "Content-Type", + "name": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "x-itau-apikey", + "value": "{{CLIENT_ID}}", + "type": "text" + }, + { + "key": "x-itau-correlationID", + "value": "a1e64241-7fdb-4d05-a7f6-c44febcdd8d9", + "type": "text" + }, + { + "key": "x-itau-flowID", + "value": "1", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"valor\": {\r\n \"original\": \"123.45\"\r\n },\r\n \"chave\": \"60701190000104\"\r\n}" + }, + "url": "https://secure.api.itau/pix_recebimentos/v2/cob" + }, + "response": [] + }, + { + "name": "ConsultaCOB", + "request": { + "auth": { + "type": "noauth" + }, + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI5ZjgwNTliMS0xZWJmLTQzNzUtODIxNC1iNDFhYjVmN2Y1MDEiLCJhdXQiOiIiLCJ2ZXIiOiJ2MS4wIiwiaXNzIjoiaHR0cHM6XC9cL29wZW5pZC5pdGF1LmNvbS5iclwvYXBpXC9vYXV0aFwvdG9rZW4iLCJBY2Nlc3NfVG9rZW4iOiJodU4xQ3VxTDdCTzZTNHh6NlRZWDVPell2ZnBLN2s5VDhkek1QOEdxZ3hCYjdQc1BTODJCOXUiLCJzb3VyY2UiOiJFWFQiLCJlbnYiOiJQIiwic2l0ZSI6ImN0bW0xIiwidXNyIjoibnVsbCIsIm1iaSI6InRydWUiLCJzY29wZSI6InJlc291cmNlLlJFQUQiLCJleHAiOjE1NzY3NTg1NjYsImlhdCI6MTU3Njc1ODI2NiwiZmxvdyI6IkNDIn0.RhL4wlCXmLN_fLUrCrrTAQm58hl1wBiby31AQQFUQ1I", + "type": "text" + }, + { + "key": "Content-Type", + "name": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "x-itau-apikey", + "value": "{{CLIENT_ID}}", + "type": "text" + }, + { + "key": "x-itau-correlationID", + "value": "a1e64241-7fdb-4d05-a7f6-c44febcdd8d9", + "type": "text" + }, + { + "key": "x-itau-flowID", + "value": "1", + "type": "text" + } + ], + "url": { + "raw": "https://secure.api.itau/pix_recebimentos/v1/cob?inicio=2020-04-01T00:00:00Z&fim=2020-04-02T10:00:00Z", + "protocol": "https", + "host": [ + "secure", + "api", + "itau" + ], + "path": [ + "pix_recebimentos", + "v1", + "cob" + ], + "query": [ + { + "key": "inicio", + "value": "2020-04-01T00:00:00Z" + }, + { + "key": "fim", + "value": "2020-04-02T10:00:00Z" + } + ] + } + }, + "response": [] + }, + { + "name": "Consulta COB - TIXD", + "request": { + "auth": { + "type": "noauth" + }, + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI5ZjgwNTliMS0xZWJmLTQzNzUtODIxNC1iNDFhYjVmN2Y1MDEiLCJhdXQiOiIiLCJ2ZXIiOiJ2MS4wIiwiaXNzIjoiaHR0cHM6XC9cL29wZW5pZC5pdGF1LmNvbS5iclwvYXBpXC9vYXV0aFwvdG9rZW4iLCJBY2Nlc3NfVG9rZW4iOiJodU4xQ3VxTDdCTzZTNHh6NlRZWDVPell2ZnBLN2s5VDhkek1QOEdxZ3hCYjdQc1BTODJCOXUiLCJzb3VyY2UiOiJFWFQiLCJlbnYiOiJQIiwic2l0ZSI6ImN0bW0xIiwidXNyIjoibnVsbCIsIm1iaSI6InRydWUiLCJzY29wZSI6InJlc291cmNlLlJFQUQiLCJleHAiOjE1NzY3NTg1NjYsImlhdCI6MTU3Njc1ODI2NiwiZmxvdyI6IkNDIn0.RhL4wlCXmLN_fLUrCrrTAQm58hl1wBiby31AQQFUQ1I", + "type": "text" + }, + { + "key": "Content-Type", + "name": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "x-itau-apikey", + "value": "{{CLIENT_ID}}", + "type": "text" + }, + { + "key": "x-itau-correlationID", + "value": "a1e64241-7fdb-4d05-a7f6-c44febcdd8d9", + "type": "text" + }, + { + "key": "x-itau-flowID", + "value": "1", + "type": "text" + } + ], + "url": "https://secure.api.itau/pix_recebimentos/v2/cob/TXID" + }, + "response": [] + }, + { + "name": "Consulta COB - Base 64", + "request": { + "auth": { + "type": "noauth" + }, + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI5ZjgwNTliMS0xZWJmLTQzNzUtODIxNC1iNDFhYjVmN2Y1MDEiLCJhdXQiOiIiLCJ2ZXIiOiJ2MS4wIiwiaXNzIjoiaHR0cHM6XC9cL29wZW5pZC5pdGF1LmNvbS5iclwvYXBpXC9vYXV0aFwvdG9rZW4iLCJBY2Nlc3NfVG9rZW4iOiJodU4xQ3VxTDdCTzZTNHh6NlRZWDVPell2ZnBLN2s5VDhkek1QOEdxZ3hCYjdQc1BTODJCOXUiLCJzb3VyY2UiOiJFWFQiLCJlbnYiOiJQIiwic2l0ZSI6ImN0bW0xIiwidXNyIjoibnVsbCIsIm1iaSI6InRydWUiLCJzY29wZSI6InJlc291cmNlLlJFQUQiLCJleHAiOjE1NzY3NTg1NjYsImlhdCI6MTU3Njc1ODI2NiwiZmxvdyI6IkNDIn0.RhL4wlCXmLN_fLUrCrrTAQm58hl1wBiby31AQQFUQ1I", + "type": "text" + }, + { + "key": "Content-Type", + "name": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "x-itau-apikey", + "value": "{{CLIENT_ID}}", + "type": "text" + }, + { + "key": "x-itau-correlationID", + "value": "a1e64241-7fdb-4d05-a7f6-c44febcdd8d9", + "type": "text" + }, + { + "key": "x-itau-flowID", + "value": "1", + "type": "text" + } + ], + "url": "https://secure.api.itau/pix_recebimentos/v2/cob/TXID/qrcode" + }, + "response": [] + }, + { + "name": "Emissão do COBV Com TXID", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "var jsonData = JSON.parse(responseBody);\r", + "postman.setEnvironmentVariable(\"access_token\", jsonData.access_token);" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "bearer", + "bearer": {} + }, + "method": "POST", + "header": [ + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI5ZjgwNTliMS0xZWJmLTQzNzUtODIxNC1iNDFhYjVmN2Y1MDEiLCJhdXQiOiIiLCJ2ZXIiOiJ2MS4wIiwiaXNzIjoiaHR0cHM6XC9cL29wZW5pZC5pdGF1LmNvbS5iclwvYXBpXC9vYXV0aFwvdG9rZW4iLCJBY2Nlc3NfVG9rZW4iOiJodU4xQ3VxTDdCTzZTNHh6NlRZWDVPell2ZnBLN2s5VDhkek1QOEdxZ3hCYjdQc1BTODJCOXUiLCJzb3VyY2UiOiJFWFQiLCJlbnYiOiJQIiwic2l0ZSI6ImN0bW0xIiwidXNyIjoibnVsbCIsIm1iaSI6InRydWUiLCJzY29wZSI6InJlc291cmNlLlJFQUQiLCJleHAiOjE1NzY3NTg1NjYsImlhdCI6MTU3Njc1ODI2NiwiZmxvdyI6IkNDIn0.RhL4wlCXmLN_fLUrCrrTAQm58hl1wBiby31AQQFUQ1I", + "type": "text" + }, + { + "key": "Content-Type", + "name": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "x-itau-apikey", + "value": "{{CLIENT_ID}}", + "type": "text" + }, + { + "key": "x-itau-correlationID", + "value": "a1e64241-7fdb-4d05-a7f6-c44febcdd8d9", + "type": "text" + }, + { + "key": "x-itau-flowID", + "value": "1", + "type": "text" + } + ], + "body": { + "mode": "raw", + "raw": "{\r\n \"calendario\": {\r\n // \"expiracao\": \"3600\",\r\n \"dataDeVencimento\": \"2023-12-31\"\r\n },\r\n \"devedor\": {\r\n // \"cnpj\": \"12345678000195\",\r\n \"cpf\": \"12345678909\",\r\n \"nome\": \"Empresa de Serviços SA\"\r\n },\r\n \"valor\": {\r\n \"original\": \"1.00\"\r\n },\r\n \"chave\": \"Chave PIX recebedor\",\r\n \"solicitacaoPagador\": \"Informar cartão fidelidade\",\r\n \"infoAdicionais\": [\r\n {\r\n \"nome\": \"Campo 1\",\r\n \"valor\": \"Informação Adicional1\"\r\n },\r\n {\r\n \"nome\": \"Campo 2\",\r\n \"valor\": \"Informação Adicional2 \"\r\n }\r\n ]\r\n}" + }, + "url": "https://secure.api.itau/pix_recebimentos/v2/cobv/txid" + }, + "response": [] + }, + { + "name": "Consulta COBV", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "var jsonData = JSON.parse(responseBody);\r", + "postman.setEnvironmentVariable(\"access_token\", jsonData.access_token);" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "noauth" + }, + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI5ZjgwNTliMS0xZWJmLTQzNzUtODIxNC1iNDFhYjVmN2Y1MDEiLCJhdXQiOiIiLCJ2ZXIiOiJ2MS4wIiwiaXNzIjoiaHR0cHM6XC9cL29wZW5pZC5pdGF1LmNvbS5iclwvYXBpXC9vYXV0aFwvdG9rZW4iLCJBY2Nlc3NfVG9rZW4iOiJodU4xQ3VxTDdCTzZTNHh6NlRZWDVPell2ZnBLN2s5VDhkek1QOEdxZ3hCYjdQc1BTODJCOXUiLCJzb3VyY2UiOiJFWFQiLCJlbnYiOiJQIiwic2l0ZSI6ImN0bW0xIiwidXNyIjoibnVsbCIsIm1iaSI6InRydWUiLCJzY29wZSI6InJlc291cmNlLlJFQUQiLCJleHAiOjE1NzY3NTg1NjYsImlhdCI6MTU3Njc1ODI2NiwiZmxvdyI6IkNDIn0.RhL4wlCXmLN_fLUrCrrTAQm58hl1wBiby31AQQFUQ1I", + "type": "text" + }, + { + "key": "Content-Type", + "name": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "x-itau-apikey", + "value": "{{CLIENT_ID}}", + "type": "text" + }, + { + "key": "x-itau-correlationID", + "value": "a1e64241-7fdb-4d05-a7f6-c44febcdd8d9", + "type": "text" + }, + { + "key": "x-itau-flowID", + "value": "1", + "type": "text" + } + ], + "url": { + "raw": "https://secure.api.itau/pix_recebimentos/v2/cobv?inicio=2020-04-01T00:00:00Z&fim=2020-04-02T10:00:00Z", + "protocol": "https", + "host": [ + "secure", + "api", + "itau" + ], + "path": [ + "pix_recebimentos", + "v2", + "cobv" + ], + "query": [ + { + "key": "inicio", + "value": "2020-04-01T00:00:00Z" + }, + { + "key": "fim", + "value": "2020-04-02T10:00:00Z" + } + ] + } + }, + "response": [] + }, + { + "name": "Consulta COBV - Base 64 Copy", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "var jsonData = JSON.parse(responseBody);\r", + "postman.setEnvironmentVariable(\"access_token\", jsonData.access_token);" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "noauth" + }, + "method": "GET", + "header": [ + { + "key": "Authorization", + "value": "Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI5ZjgwNTliMS0xZWJmLTQzNzUtODIxNC1iNDFhYjVmN2Y1MDEiLCJhdXQiOiIiLCJ2ZXIiOiJ2MS4wIiwiaXNzIjoiaHR0cHM6XC9cL29wZW5pZC5pdGF1LmNvbS5iclwvYXBpXC9vYXV0aFwvdG9rZW4iLCJBY2Nlc3NfVG9rZW4iOiJodU4xQ3VxTDdCTzZTNHh6NlRZWDVPell2ZnBLN2s5VDhkek1QOEdxZ3hCYjdQc1BTODJCOXUiLCJzb3VyY2UiOiJFWFQiLCJlbnYiOiJQIiwic2l0ZSI6ImN0bW0xIiwidXNyIjoibnVsbCIsIm1iaSI6InRydWUiLCJzY29wZSI6InJlc291cmNlLlJFQUQiLCJleHAiOjE1NzY3NTg1NjYsImlhdCI6MTU3Njc1ODI2NiwiZmxvdyI6IkNDIn0.RhL4wlCXmLN_fLUrCrrTAQm58hl1wBiby31AQQFUQ1I", + "type": "text" + }, + { + "key": "Content-Type", + "name": "Content-Type", + "value": "application/json", + "type": "text" + }, + { + "key": "x-itau-apikey", + "value": "{{CLIENT_ID}}", + "type": "text" + }, + { + "key": "x-itau-correlationID", + "value": "a1e64241-7fdb-4d05-a7f6-c44febcdd8d9", + "type": "text" + }, + { + "key": "x-itau-flowID", + "value": "1", + "type": "text" + } + ], + "url": "https://secure.api.itau/pix_recebimentos/v2/cobv/TXID/qrcode" + }, + "response": [] + } + ], + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + } + ] + }, + { + "name": "webhook", + "item": [ + { + "name": "{chave} informações adicionais", + "item": [ + { + "name": "put/webhook/{chave}", + "request": { + "auth": { + "type": "basic", + "basic": { + "username": "", + "password": "" + } + }, + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "https://secure.api.itau/pix_recebimentos/v2/webhook/{chave}", + "description": "Operação responsável por cadastrar webhook para aviso de recebimentos pix por chave" + }, + "response": [ + { + "name": "OK", + "originalRequest": { + "method": "PUT", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Location", + "value": "aute proi", + "description": "URI correspondente ao item atualziado." + }, + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Se não exsitir o recurso, neste caso, o recurso foi criado.\n", + "originalRequest": { + "method": "PUT", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Location", + "value": "aute proi", + "description": "URI correspondente ao item criado." + }, + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "A execução foi bem-sucedida, o recurso é atualizado / criado de acordo com as mudanças enviadas de forma assíncrona.\nO retorno deverá ser um recurso de taferas.\n", + "originalRequest": { + "method": "PUT", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Location", + "value": "aute proi", + "description": "URI correspondente a consulta do status do processamento assíncrono." + }, + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Solicitação processada com sucesso, mas não está retornando nenhum conteúdo.\n", + "originalRequest": { + "method": "PUT", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Location", + "value": "aute proi", + "description": "URI correspondente ao elemento atualizado." + }, + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Requisição com formato inválido.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/CobOperacaoInvalida\",\n \"title\": \"Cobrança inválida.\",\n \"status\": 400,\n \"detail\": \"A requisição que busca alterar ou criar uma cobrança para pagamento imediato não respeita o schema ou está semanticamente errada.\",\n \"correlationId\": \"0756d096-c900-4d4b-a0b1-d9c13004f29d\",\n \"violacoes\": [\n {\n \"razao\": \"O objeto cobv.devedor não respeita o schema.\",\n \"propriedade\": \"cob.valor.original\",\n \"valor\": \"tempor\"\n },\n {\n \"razao\": \"O objeto cobv.devedor não respeita o schema.\",\n \"propriedade\": \"cob.valor.original\",\n \"valor\": \"sed deserunt dolore\"\n }\n ]\n}" + }, + { + "name": "Não autorizado. Verifique se os parâmetros de acesso estão válidos (certificado, expiração do token, configuração da credencial, secret ou jwt). Se o problema persistir, entre em contato com o suporte Itaú.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Requisição de participante autenticado que viola alguma regra de autorização.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"title\": \"Acesso Negado\",\n \"status\": 403,\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização.\",\n \"correlationId\": \"0756d096-c900-4d4b-a0b1-d9c13004f29d\",\n \"violacoes\": [\n {\n \"razao\": \"incididunt qui quis\",\n \"propriedade\": \"Ut ad culpa aute\",\n \"valor\": \"ex fugiat do magna Duis\"\n },\n {\n \"razao\": \"eiusmod\",\n \"propriedade\": \"commodo nulla dolore i\",\n \"valor\": \"id pariatur nulla\"\n }\n ]\n}" + }, + { + "name": "Recurso solicitado não foi encontrado.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado\",\n \"title\": \"Não Encontrado\",\n \"status\": 404,\n \"detail\": \"Entidade não encontrada.\",\n \"correlationId\": \"0756d096-c900-4d4b-a0b1-d9c13004f29d\",\n \"violacoes\": [\n {\n \"razao\": \"irure sit ullamco id r\",\n \"propriedade\": \"ullamco eu laborum tempor\",\n \"valor\": \"eiusmod eu Excepteur\"\n },\n {\n \"razao\": \"cupidatat in exercitation tempor\",\n \"propriedade\": \"deserunt Lorem nostrud\",\n \"valor\": \"in laboris nisi dolore\"\n }\n ]\n}" + }, + { + "name": "Método não permitido", + "originalRequest": { + "method": "PUT", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Erro semântico", + "originalRequest": { + "method": "PUT", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Solicitação requer pré requisito ou condição que não foi enviada", + "originalRequest": { + "method": "PUT", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Precondition Required", + "code": 428, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Erro Inesperado. Entre em contato com o suporte Itaú.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Não implementado. Entre em contato com o suporte Itaú.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Not Implemented", + "code": 501, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"title\": \"Serviço Indisponível\",\n \"status\": 503,\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.\",\n \"correlationId\": \"A cobrança em questão não foi encontrada para a location requisitada.\",\n \"violacoes\": [\n {\n \"razao\": \"consequat amet\",\n \"propriedade\": \"elit ip\",\n \"valor\": \"in voluptate\"\n },\n {\n \"razao\": \"ut e\",\n \"propriedade\": \"sint qui dolor minim Duis\",\n \"valor\": \"proident incididunt nisi\"\n }\n ]\n}" + } + ] + }, + { + "name": "get/webhook/{chave}", + "request": { + "auth": { + "type": "basic", + "basic": { + "username": "", + "password": "" + } + }, + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": "https://secure.api.itau/pix_recebimentos/v2/webhook/{chave}", + "description": "Operação responsável por resgatar webhook de aviso de recebimentos pix por chave" + }, + "response": [ + { + "name": "OK", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Location", + "value": "aute proi", + "description": "URI correspondente a pesquisa corrente" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"value\": {\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\",\n \"chave\": \"40a0932d-1918-4eee-845d-35a2da1690dc\",\n \"criacao\": \"2020-11-11T10:15:00.358Z\"\n },\n \"description\": \"\"\n}" + }, + { + "name": "Solicitação processada com sucesso, mas não está retornando nenhum conteúdo.\n", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Location", + "value": "aute proi", + "description": "URI correspondente a pesquisa corrente" + }, + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "See Other - Resposta à solicitação da consulta será redirecionada (pode ser encontrada em outro URI/localização), usando o método GET. Quando recebido em resposta a um POST (ou PUT / DELETE), o cliente deve presumir que o servidor recebeu os dados e deve ", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "See Other", + "code": 303, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Location", + "value": "aute proi", + "description": "URI correspondente a consulta do status do processamento assíncrono." + }, + { + "key": "Location", + "value": "aute proi", + "description": "URI correspondente a consulta do elemento já processado assíncronamente." + }, + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Parâmetros incorretos (os dados de entradas estão incorretos ou ausentes).", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Não autorizado. Verifique se os parâmetros de acesso estão válidos (como certificado, expiração do token, configuração da credencial e secret ou jwt). Se o problema persistir, entre em contato com o suporte Itaú.", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Requisição de participante autenticado que viola alguma regra de autorização.", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"title\": \"Acesso Negado\",\n \"status\": 403,\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização.\",\n \"correlationId\": \"0756d096-c900-4d4b-a0b1-d9c13004f29d\",\n \"violacoes\": [\n {\n \"razao\": \"incididunt qui quis\",\n \"propriedade\": \"Ut ad culpa aute\",\n \"valor\": \"ex fugiat do magna Duis\"\n },\n {\n \"razao\": \"eiusmod\",\n \"propriedade\": \"commodo nulla dolore i\",\n \"valor\": \"id pariatur nulla\"\n }\n ]\n}" + }, + { + "name": "Recurso solicitado não foi encontrado.", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado\",\n \"title\": \"Não Encontrado\",\n \"status\": 404,\n \"detail\": \"Entidade não encontrada.\",\n \"correlationId\": \"0756d096-c900-4d4b-a0b1-d9c13004f29d\",\n \"violacoes\": [\n {\n \"razao\": \"irure sit ullamco id r\",\n \"propriedade\": \"ullamco eu laborum tempor\",\n \"valor\": \"eiusmod eu Excepteur\"\n },\n {\n \"razao\": \"cupidatat in exercitation tempor\",\n \"propriedade\": \"deserunt Lorem nostrud\",\n \"valor\": \"in laboris nisi dolore\"\n }\n ]\n}" + }, + { + "name": "Método não permitido", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Erro semântico", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Solicitação requer pré requisito ou condição que não foi enviada", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Precondition Required", + "code": 428, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Erro Inesperado. Entre em contato com o suporte Itaú.", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Não implementado. Entre em contato com o suporte Itaú.", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Not Implemented", + "code": 501, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"title\": \"Serviço Indisponível\",\n \"status\": 503,\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.\",\n \"correlationId\": \"A cobrança em questão não foi encontrada para a location requisitada.\",\n \"violacoes\": [\n {\n \"razao\": \"consequat amet\",\n \"propriedade\": \"elit ip\",\n \"valor\": \"in voluptate\"\n },\n {\n \"razao\": \"ut e\",\n \"propriedade\": \"sint qui dolor minim Duis\",\n \"valor\": \"proident incididunt nisi\"\n }\n ]\n}" + }, + { + "name": "Gateway Timeout. Entre em contato com o suporte Itaú.", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + }, + { + "name": "delete/webhook/{chave}", + "request": { + "auth": { + "type": "basic", + "basic": { + "username": "", + "password": "" + } + }, + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + }, + "description": "Operação responsável por deletar webhook para aviso de recebimentos pix por chave" + }, + "response": [ + { + "name": "A execução foi bem-sucedida, o recurso foi removido corretamente de forma síncrona.\n", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "A execução foi bem-sucedida, o recurso será excluído de forma assíncrona.\nO retorno deste pedido deve ser um recurso de tarefas.\n", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Location", + "value": "aute proi", + "description": "URI correspondente a consulta do status do processamento assíncrono." + }, + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "OK", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Requisição com formato inválido.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/CobOperacaoInvalida\",\n \"title\": \"Cobrança inválida.\",\n \"status\": 400,\n \"detail\": \"A requisição que busca alterar ou criar uma cobrança para pagamento imediato não respeita o schema ou está semanticamente errada.\",\n \"correlationId\": \"0756d096-c900-4d4b-a0b1-d9c13004f29d\",\n \"violacoes\": [\n {\n \"razao\": \"O objeto cobv.devedor não respeita o schema.\",\n \"propriedade\": \"cob.valor.original\",\n \"valor\": \"tempor\"\n },\n {\n \"razao\": \"O objeto cobv.devedor não respeita o schema.\",\n \"propriedade\": \"cob.valor.original\",\n \"valor\": \"sed deserunt dolore\"\n }\n ]\n}" + }, + { + "name": "Não autorizado. Verifique se os parâmetros de acesso estão válidos (certificado, expiração do token, configuração da credencial, secret ou jwt). Se o problema persistir, entre em contato com o suporte Itaú.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Requisição de participante autenticado que viola alguma regra de autorização.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"title\": \"Acesso Negado\",\n \"status\": 403,\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização.\",\n \"correlationId\": \"0756d096-c900-4d4b-a0b1-d9c13004f29d\",\n \"violacoes\": [\n {\n \"razao\": \"incididunt qui quis\",\n \"propriedade\": \"Ut ad culpa aute\",\n \"valor\": \"ex fugiat do magna Duis\"\n },\n {\n \"razao\": \"eiusmod\",\n \"propriedade\": \"commodo nulla dolore i\",\n \"valor\": \"id pariatur nulla\"\n }\n ]\n}" + }, + { + "name": "Recurso solicitado não foi encontrado.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado\",\n \"title\": \"Não Encontrado\",\n \"status\": 404,\n \"detail\": \"Entidade não encontrada.\",\n \"correlationId\": \"0756d096-c900-4d4b-a0b1-d9c13004f29d\",\n \"violacoes\": [\n {\n \"razao\": \"irure sit ullamco id r\",\n \"propriedade\": \"ullamco eu laborum tempor\",\n \"valor\": \"eiusmod eu Excepteur\"\n },\n {\n \"razao\": \"cupidatat in exercitation tempor\",\n \"propriedade\": \"deserunt Lorem nostrud\",\n \"valor\": \"in laboris nisi dolore\"\n }\n ]\n}" + }, + { + "name": "Método não permitido", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Erro semântico", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Solicitação requer pré requisito ou condição que não foi enviada", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Precondition Required", + "code": 428, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Erro Inesperado. Entre em contato com o suporte Itaú.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Não implementado. Entre em contato com o suporte Itaú.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Not Implemented", + "code": 501, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"title\": \"Serviço Indisponível\",\n \"status\": 503,\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.\",\n \"correlationId\": \"A cobrança em questão não foi encontrada para a location requisitada.\",\n \"violacoes\": [\n {\n \"razao\": \"consequat amet\",\n \"propriedade\": \"elit ip\",\n \"valor\": \"in voluptate\"\n },\n {\n \"razao\": \"ut e\",\n \"propriedade\": \"sint qui dolor minim Duis\",\n \"valor\": \"proident incididunt nisi\"\n }\n ]\n}" + }, + { + "name": "Gateway Timeout. Entre em contato com o suporte Itaú.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + } + ], + "url": { + "raw": "{{baseUrl}}/webhook/:chave", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook", + ":chave" + ], + "variable": [ + { + "key": "chave", + "value": "aute proi", + "description": "(Required) Chave de endereçamento do recebedor" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + } + ], + "description": "### Informação disponivel no DevPortal em: Produtos/PIX/Recebimentos PIX / informações adicionais.\n\nLink: [https://devportal.itau.com.br/nossas-apis/itau-ep9-gtw-pix-recebimentos-ext-v2](https://devportal.itau.com.br/nossas-apis/itau-ep9-gtw-pix-recebimentos-ext-v2)\n\nAPI para cadastrar/atualizar o serviço de notificações via webhook dos QR Codes recebidos e das transferências Pix recebidas via chave Pix. \nAs transferências Pix recebidas com inserção manual (agência e conta) não serão notificadas e as devoluções emitidas são opcionais, sendo necessário a solicitação de um outro cadastro no Itaú.\n\nAs notificações de recebimento serão enviadas na URL cadastrada acrescentando o sufixo \"/pix\". Sendo assim, no momento do cadastro, não é necessário enviar a URL com o sufixo \"/pix\".\n\nExemplos:\n\n- URL enviada: webhook_itau\n \n- URL cadastrada: webhook_itau/pix\n \n\n### \\[Webhook\\] Notificação de Recebimento PIX (POST)\n\n### \\[POST\\] {url cadastrada pelo cliente}\n\n**Segurança:**\n\nO Itaú irá realizar a chamada para a API de callback através de uma URL exposta na web, protegida por uma camada de autenticação mTLS (HTTPS).\n\nEm uma conexão mTLS, o servidor de Webhook do Itaú e a API de callback do parceiro trocam certificados entre si a partir de um CA que ambos confiam. Em troca de certificados serve para comprovar a identidade de um servidor ao outro.\n\nPara ativar o fluxo de autenticação via mTLS primeiramente é necessário baixar a CA (chave pública) do Itaú no seguinte link:\n\n[ca-cert.zip](https://devportal.itau.com.br/assets/ca_cert_952123c440.zip)\n\nApós o download, essa CA deverá ser importada no API Gateway, servidor proxy ou aplicação que irá receber a requisição de Webhook do Itaú.\n\n**API call-back**\n\nDeve ser desenvolvida pelo cliente API que será responsável por efetuar a recepção da notificação de pagamento instantâneo.\n\nO itaú envia as notificações de recebimentos imediatamente a cada pagamento (um a um). Já para as notificações de devolução emitida, o envio é opcional. Caso queria receber este tipo de notificação, é necessário solicitar o cadastro de um parâmetro ao Itaú. Em casos de devoluções parciais, não serão acumulados dentro do array devoluções passadas.\n\nVale ressaltar que o processo de devolução do Itaú é síncrono e no endpoint \\[PUT\\] /pix_recebimentos/v2/pix/{e2eid}/devolucao/{id} já é retornado o status final da devolução e, por isso, o envio de notificação de devolução pelo Webhook é opcional." + }, + { + "name": "get/webhook", + "request": { + "auth": { + "type": "basic", + "basic": { + "username": "", + "password": "" + } + }, + "method": "GET", + "header": [ + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-correlationID", + "value": "aute proi" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "https://secure.api.itau/pix_recebimentos/v2/webhook?inicio=aute proi&fim=aute proi&paginacao.paginaAtual=16140691&paginacao.itensPorPagina=16140691", + "protocol": "https", + "host": [ + "secure", + "api", + "itau" + ], + "path": [ + "pix_recebimentos", + "v2", + "webhook" + ], + "query": [ + { + "key": "inicio", + "value": "aute proi", + "description": "Data de inicio da pesquisa de webhooks, no formato de acordo com RFC3339" + }, + { + "key": "fim", + "value": "aute proi", + "description": "Data fim da pesquisa de webhooks, no formato de acordo com RFC3339" + }, + { + "key": "paginacao.paginaAtual", + "value": "16140691", + "description": "Numero da Página que deseja realizar o acesso, valor considerado por default 0" + }, + { + "key": "paginacao.itensPorPagina", + "value": "16140691", + "description": "Quantidade de ocorrência retornadas por pagina, valor por default 100" + } + ] + }, + "description": "Operação responsável por resgatar webhooks de aviso de recebimentos pix para um parceiro" + }, + "response": [ + { + "name": "OK", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-correlationID", + "value": "aute proi" + } + ], + "url": { + "raw": "{{baseUrl}}/webhook?inicio=aute proi&fim=aute proi&paginacao.paginaAtual=16140691&paginacao.itensPorPagina=16140691", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook" + ], + "query": [ + { + "key": "inicio", + "value": "aute proi" + }, + { + "key": "fim", + "value": "aute proi" + }, + { + "key": "paginacao.paginaAtual", + "value": "16140691" + }, + { + "key": "paginacao.itensPorPagina", + "value": "16140691" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Location", + "value": "aute proi", + "description": "URI correspondente a pesquisa corrente" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"value\": {\n \"parametros\": {\n \"inicio\": \"2020-04-01T00:00:00Z\",\n \"fim\": \"2020-04-01T23:59:59Z\",\n \"paginacao\": {\n \"paginaAtual\": 0,\n \"itensPorPagina\": 100,\n \"quantidadeDePaginas\": 1,\n \"quantidadeTotalDeItens\": 1\n }\n },\n \"webhooks\": [\n {\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\",\n \"chave\": \"email@email.com\",\n \"criacao\": \"2020-11-11T10:15:00.358Z\"\n }\n ]\n },\n \"description\": \"\"\n}" + }, + { + "name": "Solicitação processada com sucesso, mas não está retornando nenhum conteúdo.\n", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-correlationID", + "value": "aute proi" + } + ], + "url": { + "raw": "{{baseUrl}}/webhook?inicio=aute proi&fim=aute proi&paginacao.paginaAtual=16140691&paginacao.itensPorPagina=16140691", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook" + ], + "query": [ + { + "key": "inicio", + "value": "aute proi" + }, + { + "key": "fim", + "value": "aute proi" + }, + { + "key": "paginacao.paginaAtual", + "value": "16140691" + }, + { + "key": "paginacao.itensPorPagina", + "value": "16140691" + } + ] + } + }, + "status": "No Content", + "code": 204, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Location", + "value": "aute proi", + "description": "URI correspondente a pesquisa corrente" + }, + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "See Other - Resposta à solicitação da consulta será redirecionada (pode ser encontrada em outro URI/localização), usando o método GET. Quando recebido em resposta a um POST (ou PUT / DELETE), o cliente deve presumir que o servidor recebeu os dados e deve ", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-correlationID", + "value": "aute proi" + } + ], + "url": { + "raw": "{{baseUrl}}/webhook?inicio=aute proi&fim=aute proi&paginacao.paginaAtual=16140691&paginacao.itensPorPagina=16140691", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook" + ], + "query": [ + { + "key": "inicio", + "value": "aute proi" + }, + { + "key": "fim", + "value": "aute proi" + }, + { + "key": "paginacao.paginaAtual", + "value": "16140691" + }, + { + "key": "paginacao.itensPorPagina", + "value": "16140691" + } + ] + } + }, + "status": "See Other", + "code": 303, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Location", + "value": "aute proi", + "description": "URI correspondente a consulta do status do processamento assíncrono." + }, + { + "key": "Location", + "value": "aute proi", + "description": "URI correspondente a consulta do elemento já processado assíncronamente." + }, + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Parâmetros incorretos (os dados de entradas estão incorretos ou ausentes).", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-correlationID", + "value": "aute proi" + } + ], + "url": { + "raw": "{{baseUrl}}/webhook?inicio=aute proi&fim=aute proi&paginacao.paginaAtual=16140691&paginacao.itensPorPagina=16140691", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook" + ], + "query": [ + { + "key": "inicio", + "value": "aute proi" + }, + { + "key": "fim", + "value": "aute proi" + }, + { + "key": "paginacao.paginaAtual", + "value": "16140691" + }, + { + "key": "paginacao.itensPorPagina", + "value": "16140691" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Não autorizado. Verifique se os parâmetros de acesso estão válidos (como certificado, expiração do token, configuração da credencial e secret ou jwt). Se o problema persistir, entre em contato com o suporte Itaú.", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-correlationID", + "value": "aute proi" + } + ], + "url": { + "raw": "{{baseUrl}}/webhook?inicio=aute proi&fim=aute proi&paginacao.paginaAtual=16140691&paginacao.itensPorPagina=16140691", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook" + ], + "query": [ + { + "key": "inicio", + "value": "aute proi" + }, + { + "key": "fim", + "value": "aute proi" + }, + { + "key": "paginacao.paginaAtual", + "value": "16140691" + }, + { + "key": "paginacao.itensPorPagina", + "value": "16140691" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Requisição de participante autenticado que viola alguma regra de autorização.", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-correlationID", + "value": "aute proi" + } + ], + "url": { + "raw": "{{baseUrl}}/webhook?inicio=aute proi&fim=aute proi&paginacao.paginaAtual=16140691&paginacao.itensPorPagina=16140691", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook" + ], + "query": [ + { + "key": "inicio", + "value": "aute proi" + }, + { + "key": "fim", + "value": "aute proi" + }, + { + "key": "paginacao.paginaAtual", + "value": "16140691" + }, + { + "key": "paginacao.itensPorPagina", + "value": "16140691" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"title\": \"Acesso Negado\",\n \"status\": 403,\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização.\",\n \"correlationId\": \"0756d096-c900-4d4b-a0b1-d9c13004f29d\",\n \"violacoes\": [\n {\n \"razao\": \"incididunt qui quis\",\n \"propriedade\": \"Ut ad culpa aute\",\n \"valor\": \"ex fugiat do magna Duis\"\n },\n {\n \"razao\": \"eiusmod\",\n \"propriedade\": \"commodo nulla dolore i\",\n \"valor\": \"id pariatur nulla\"\n }\n ]\n}" + }, + { + "name": "Recurso Inexistente (não encontrado)", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-correlationID", + "value": "aute proi" + } + ], + "url": { + "raw": "{{baseUrl}}/webhook?inicio=aute proi&fim=aute proi&paginacao.paginaAtual=16140691&paginacao.itensPorPagina=16140691", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook" + ], + "query": [ + { + "key": "inicio", + "value": "aute proi" + }, + { + "key": "fim", + "value": "aute proi" + }, + { + "key": "paginacao.paginaAtual", + "value": "16140691" + }, + { + "key": "paginacao.itensPorPagina", + "value": "16140691" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Método não permitido", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-correlationID", + "value": "aute proi" + } + ], + "url": { + "raw": "{{baseUrl}}/webhook?inicio=aute proi&fim=aute proi&paginacao.paginaAtual=16140691&paginacao.itensPorPagina=16140691", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook" + ], + "query": [ + { + "key": "inicio", + "value": "aute proi" + }, + { + "key": "fim", + "value": "aute proi" + }, + { + "key": "paginacao.paginaAtual", + "value": "16140691" + }, + { + "key": "paginacao.itensPorPagina", + "value": "16140691" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Erro semântico", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-correlationID", + "value": "aute proi" + } + ], + "url": { + "raw": "{{baseUrl}}/webhook?inicio=aute proi&fim=aute proi&paginacao.paginaAtual=16140691&paginacao.itensPorPagina=16140691", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook" + ], + "query": [ + { + "key": "inicio", + "value": "aute proi" + }, + { + "key": "fim", + "value": "aute proi" + }, + { + "key": "paginacao.paginaAtual", + "value": "16140691" + }, + { + "key": "paginacao.itensPorPagina", + "value": "16140691" + } + ] + } + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Solicitação requer pré requisito ou condição que não foi enviada", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-correlationID", + "value": "aute proi" + } + ], + "url": { + "raw": "{{baseUrl}}/webhook?inicio=aute proi&fim=aute proi&paginacao.paginaAtual=16140691&paginacao.itensPorPagina=16140691", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook" + ], + "query": [ + { + "key": "inicio", + "value": "aute proi" + }, + { + "key": "fim", + "value": "aute proi" + }, + { + "key": "paginacao.paginaAtual", + "value": "16140691" + }, + { + "key": "paginacao.itensPorPagina", + "value": "16140691" + } + ] + } + }, + "status": "Precondition Required", + "code": 428, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Erro Inesperado. Entre em contato com o suporte Itaú.", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-correlationID", + "value": "aute proi" + } + ], + "url": { + "raw": "{{baseUrl}}/webhook?inicio=aute proi&fim=aute proi&paginacao.paginaAtual=16140691&paginacao.itensPorPagina=16140691", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook" + ], + "query": [ + { + "key": "inicio", + "value": "aute proi" + }, + { + "key": "fim", + "value": "aute proi" + }, + { + "key": "paginacao.paginaAtual", + "value": "16140691" + }, + { + "key": "paginacao.itensPorPagina", + "value": "16140691" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Não implementado. Entre em contato com o suporte Itaú.", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-correlationID", + "value": "aute proi" + } + ], + "url": { + "raw": "{{baseUrl}}/webhook?inicio=aute proi&fim=aute proi&paginacao.paginaAtual=16140691&paginacao.itensPorPagina=16140691", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook" + ], + "query": [ + { + "key": "inicio", + "value": "aute proi" + }, + { + "key": "fim", + "value": "aute proi" + }, + { + "key": "paginacao.paginaAtual", + "value": "16140691" + }, + { + "key": "paginacao.itensPorPagina", + "value": "16140691" + } + ] + } + }, + "status": "Not Implemented", + "code": 501, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-correlationID", + "value": "aute proi" + } + ], + "url": { + "raw": "{{baseUrl}}/webhook?inicio=aute proi&fim=aute proi&paginacao.paginaAtual=16140691&paginacao.itensPorPagina=16140691", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook" + ], + "query": [ + { + "key": "inicio", + "value": "aute proi" + }, + { + "key": "fim", + "value": "aute proi" + }, + { + "key": "paginacao.paginaAtual", + "value": "16140691" + }, + { + "key": "paginacao.itensPorPagina", + "value": "16140691" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"title\": \"Serviço Indisponível\",\n \"status\": 503,\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.\",\n \"correlationId\": \"A cobrança em questão não foi encontrada para a location requisitada.\",\n \"violacoes\": [\n {\n \"razao\": \"consequat amet\",\n \"propriedade\": \"elit ip\",\n \"valor\": \"in voluptate\"\n },\n {\n \"razao\": \"ut e\",\n \"propriedade\": \"sint qui dolor minim Duis\",\n \"valor\": \"proident incididunt nisi\"\n }\n ]\n}" + }, + { + "name": "Gateway Timeout. Entre em contato com o suporte Itaú.", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: basic", + "key": "Authorization", + "value": "Basic " + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-correlationID", + "value": "aute proi" + } + ], + "url": { + "raw": "{{baseUrl}}/webhook?inicio=aute proi&fim=aute proi&paginacao.paginaAtual=16140691&paginacao.itensPorPagina=16140691", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "webhook" + ], + "query": [ + { + "key": "inicio", + "value": "aute proi" + }, + { + "key": "fim", + "value": "aute proi" + }, + { + "key": "paginacao.paginaAtual", + "value": "16140691" + }, + { + "key": "paginacao.itensPorPagina", + "value": "16140691" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + } + ] + } + ] + } + ], + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + } + ] +} \ No newline at end of file diff --git a/docs/API Pagamentos PIX.postman_collection (1).json b/docs/API Pagamentos PIX.postman_collection (1).json new file mode 100644 index 0000000..087bc88 --- /dev/null +++ b/docs/API Pagamentos PIX.postman_collection (1).json @@ -0,0 +1,979 @@ +{ + "info": { + "_postman_id": "b1cc1ce8-77ff-48d1-b7bc-2a7a7b5831c4", + "name": "API Pagamentos PIX", + "description": "Aqui você visualiza as APIs do SISPAG, que possibilita a gestão dos pagamentos da sua empresa de forma segura e ainda mais rápida. A inclusão é exclusiva para Pix e as consultas estão disponíveis todas as formas de pagamento.", + "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json", + "_exporter_id": "15739169" + }, + "item": [ + { + "name": "pagamentos sispag", + "item": [ + { + "name": "post/transferencias chave pix", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "var jsonData = JSON.parse(responseBody);\r", + "postman.setEnvironmentVariable(\"access_token\", jsonData.access_token);" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "bearer", + "bearer": {} + }, + "method": "POST", + "header": [ + { + "description": "(Required) Chave da API utilizado para autorizar o consumo de uma aplicação requisitante", + "key": "x-itau-apikey", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador da funcionalidade de negócio sendo executada na aplicação", + "key": "x-itau-flowID", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-itau-correlationID", + "value": "labore enim commodo est adipisicing" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"valor_pagamento\": \"1.00\",\n \"data_pagamento\": \"2022-03-21T15:03:56.000Z\",\n \"chave\": \"4004901d-bd85-4769-8e52-cb4c42c506dc\",\n \"referencia_empresa\": \"Prestação 0123456789\",\n \"identificacao_comprovante\": \"Prestação de serviço - empresa A\",\n \"informacoes_entre_usuarios\": \"Pagamento para prestação de serviço para empresa A\",\n \"pagador\": {\n \"tipo_conta\": \"CC\",\n \"agencia\": 1500,\n \"conta\": \"00592660\",\n \"tipo_pessoa\": \"J\",\n \"documento\": 63237648000104,\n \"modulo_sispag\": \"Fornecedores\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "{{baseUrl}}/transferencias", + "description": "API responsável por inserir transferências de Pix e pagamentos de Pix QR Code na plataforma SISPAG do Banco Itaú." + }, + "response": [ + { + "name": "Pagamento incluído com sucesso", + "originalRequest": { + "method": "POST", + "header": [ + { + "description": "Added as a part of security scheme: oauth2", + "key": "Authorization", + "value": "" + }, + { + "description": "(Required) Chave da API utilizado para autorizar o consumo de uma aplicação requisitante", + "key": "x-itau-apikey", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador da funcionalidade de negócio sendo executada na aplicação", + "key": "x-itau-flowID", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-itau-correlationID", + "value": "labore enim commodo est adipisicing" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"valor_pagamento\": \"1.00\",\n \"data_pagamento\": \"2022-03-21T15:03:56.000Z\",\n \"chave\": \"4004901d-bd85-4769-8e52-cb4c42c506dc\",\n \"referencia_empresa\": \"Prestação 0123456789\",\n \"identificacao_comprovante\": \"Prestação de serviço - empresa A\",\n \"informacoes_entre_usuarios\": \"Pagamento para prestação de serviço para empresa A\",\n \"pagador\": {\n \"tipo_conta\": \"CC\",\n \"agencia\": 1500,\n \"conta\": \"00592660\",\n \"tipo_pessoa\": \"J\",\n \"documento\": 63237648000104,\n \"modulo_sispag\": \"Fornecedores\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "{{baseUrl}}/transferencias" + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status_pagamento\": \"Sucesso\",\n \"cod_pagamento\": \"3ff2df99-704a-496e-a699-8b75dc522d10\",\n \"numero_lote\": 500001394,\n \"numero_lancamento\": 22683,\n \"tipo_pagamento\": \"PIX\",\n \"data_pagamento\": \"2022-03-21T15:03:56.000Z\",\n \"valor_pagamento\": 1,\n \"referencia_empresa\": \"Prestação 0123456789\",\n \"identificacao_comprovante\": \"Prestação de serviço - empresa A\",\n \"informacoes_entre_usuarios\": \"Pagamento para prestação de serviço para empresa A\",\n \"pagador\": {\n \"tipo_conta\": \"Conta Corrente\",\n \"agencia\": 1500,\n \"conta\": \"00052012\",\n \"tipo_pessoa\": \"J\",\n \"documento\": \"00000000000191\",\n \"modulo_sispag\": \"Fornecedores\"\n },\n \"recebedor\": {\n \"ispb\": 99999008,\n \"documento\": 11111111000191,\n \"nome\": \"TESTE DE INTEROPERABILIDADE\",\n \"tipo_conta\": \"Conta Corrente\",\n \"tipo_pessoa\": \"J\",\n \"identificacao_chave\": \"4004901d-bd85-4769-8e52-cb4c42c506dc\"\n },\n \"motivo_recusa\": []\n}" + }, + { + "name": "Solicitação de inclusão do Pagamento com erro", + "originalRequest": { + "method": "POST", + "header": [ + { + "description": "Added as a part of security scheme: oauth2", + "key": "Authorization", + "value": "" + }, + { + "description": "(Required) Chave da API utilizado para autorizar o consumo de uma aplicação requisitante", + "key": "x-itau-apikey", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador da funcionalidade de negócio sendo executada na aplicação", + "key": "x-itau-flowID", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-itau-correlationID", + "value": "labore enim commodo est adipisicing" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"valor_pagamento\": \"1.00\",\n \"data_pagamento\": \"2022-03-21T15:03:56.000Z\",\n \"chave\": \"4004901d-bd85-4769-8e52-cb4c42c506dc\",\n \"referencia_empresa\": \"Prestação 0123456789\",\n \"identificacao_comprovante\": \"Prestação de serviço - empresa A\",\n \"informacoes_entre_usuarios\": \"Pagamento para prestação de serviço para empresa A\",\n \"pagador\": {\n \"tipo_conta\": \"CC\",\n \"agencia\": 1500,\n \"conta\": \"00592660\",\n \"tipo_pessoa\": \"J\",\n \"documento\": 63237648000104,\n \"modulo_sispag\": \"Fornecedores\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "{{baseUrl}}/transferencias" + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"codigo\": 400,\n \"mensagem\": \"CNPJ inválido\"\n}" + }, + { + "name": "Inclusão do Pagamento rejeitado", + "originalRequest": { + "method": "POST", + "header": [ + { + "description": "Added as a part of security scheme: oauth2", + "key": "Authorization", + "value": "" + }, + { + "description": "(Required) Chave da API utilizado para autorizar o consumo de uma aplicação requisitante", + "key": "x-itau-apikey", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador da funcionalidade de negócio sendo executada na aplicação", + "key": "x-itau-flowID", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-itau-correlationID", + "value": "labore enim commodo est adipisicing" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"valor_pagamento\": \"1.00\",\n \"data_pagamento\": \"2022-03-21T15:03:56.000Z\",\n \"chave\": \"4004901d-bd85-4769-8e52-cb4c42c506dc\",\n \"referencia_empresa\": \"Prestação 0123456789\",\n \"identificacao_comprovante\": \"Prestação de serviço - empresa A\",\n \"informacoes_entre_usuarios\": \"Pagamento para prestação de serviço para empresa A\",\n \"pagador\": {\n \"tipo_conta\": \"CC\",\n \"agencia\": 1500,\n \"conta\": \"00592660\",\n \"tipo_pessoa\": \"J\",\n \"documento\": 63237648000104,\n \"modulo_sispag\": \"Fornecedores\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "{{baseUrl}}/transferencias" + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status_pagamento\": \"Rejeitado\",\n \"tipo_pagamento\": \"QRCODE\",\n \"data_pagamento\": \"2022-03-22T13:01:02.000Z\",\n \"valor_pagamento\": 1,\n \"referencia_empresa\": \"Prestação 0123456789\",\n \"identificacao_comprovante\": \"Prestação de serviço - empresa A\",\n \"informacoes_entre_usuarios\": \"Pagamento para prestação de serviço para empresa A\",\n \"pagador\": {\n \"tipo_conta\": \"Conta Corrente\",\n \"agencia\": 1500,\n \"conta\": \"00594138\",\n \"tipo_pessoa\": \"J\",\n \"documento\": 63237648000104,\n \"modulo_sispag\": \"CONTAS\"\n },\n \"recebedor\": {\n \"banco\": \"ITAÚ UNIBANCO S.A.\",\n \"ispb\": 60701190,\n \"documento\": 60701190000104,\n \"nome\": \"CASTELO E ASSOCIADOS\",\n \"tipo_conta\": \"Conta Corrente\",\n \"tipo_pessoa\": \"J\",\n \"identificacao_chave\": 60701190000104\n },\n \"motivo_recusa\": [\n {\n \"codigo\": 908,\n \"nome\": \"Valor do pagamento divergente do valor do qrcode.\"\n }\n ]\n}" + } + ] + }, + { + "name": "post/transferencias dados bancário", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "var jsonData = JSON.parse(responseBody);\r", + "postman.setEnvironmentVariable(\"access_token\", jsonData.access_token);" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "bearer", + "bearer": {} + }, + "method": "POST", + "header": [ + { + "description": "(Required) Chave da API utilizado para autorizar o consumo de uma aplicação requisitante", + "key": "x-itau-apikey", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador da funcionalidade de negócio sendo executada na aplicação", + "key": "x-itau-flowID", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-itau-correlationID", + "value": "labore enim commodo est adipisicing" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"valor_pagamento\": \"123.40\",\n \"data_pagamento\": \"2024-03-13\",\n \"ispb\": \"60701190\",\n \"tipo_identificacao_conta\": \"CC\",\n \"agencia_recebedor\": \"1500\",\n \"conta_recebedor\": \"00052012\",\n \"tipo_de_identificacao_do_recebedor\": \"F\",\n \"identificacao_recebedor\": \"61389299260\",\n \"informacoes_entre_usuarios\": \"transferencia para o João - referente a manutencao\",\n \"referencia_empresa\": \"154785966666666\",\n \"identificacao_comprovante\": \"transferencia para o João - referente a manutencao\",\n \"txid\": \"bqJJjaVAThmtnUeVLNnSXQ\",\n \"pagador\": {\n \"tipo_conta\": \"CC\",\n \"agencia\": \"1500\",\n \"conta\": \"00800550\",\n \"tipo_pessoa\": \"J\",\n \"documento\": \"06830622000123\",\n \"modulo_sispag\": \"Fornecedores\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "{{baseUrl}}/transferencias", + "description": "API responsável por inserir transferências de Pix e pagamentos de Pix QR Code na plataforma SISPAG do Banco Itaú." + }, + "response": [ + { + "name": "Pagamento incluído com sucesso", + "originalRequest": { + "method": "POST", + "header": [ + { + "description": "Added as a part of security scheme: oauth2", + "key": "Authorization", + "value": "" + }, + { + "description": "(Required) Chave da API utilizado para autorizar o consumo de uma aplicação requisitante", + "key": "x-itau-apikey", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador da funcionalidade de negócio sendo executada na aplicação", + "key": "x-itau-flowID", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-itau-correlationID", + "value": "labore enim commodo est adipisicing" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"valor_pagamento\": \"1.00\",\n \"data_pagamento\": \"2022-03-21T15:03:56.000Z\",\n \"chave\": \"4004901d-bd85-4769-8e52-cb4c42c506dc\",\n \"referencia_empresa\": \"Prestação 0123456789\",\n \"identificacao_comprovante\": \"Prestação de serviço - empresa A\",\n \"informacoes_entre_usuarios\": \"Pagamento para prestação de serviço para empresa A\",\n \"pagador\": {\n \"tipo_conta\": \"CC\",\n \"agencia\": 1500,\n \"conta\": \"00592660\",\n \"tipo_pessoa\": \"J\",\n \"documento\": 63237648000104,\n \"modulo_sispag\": \"Fornecedores\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "{{baseUrl}}/transferencias" + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status_pagamento\": \"Sucesso\",\n \"cod_pagamento\": \"3ff2df99-704a-496e-a699-8b75dc522d10\",\n \"numero_lote\": 500001394,\n \"numero_lancamento\": 22683,\n \"tipo_pagamento\": \"PIX\",\n \"data_pagamento\": \"2022-03-21T15:03:56.000Z\",\n \"valor_pagamento\": 1,\n \"referencia_empresa\": \"Prestação 0123456789\",\n \"identificacao_comprovante\": \"Prestação de serviço - empresa A\",\n \"informacoes_entre_usuarios\": \"Pagamento para prestação de serviço para empresa A\",\n \"pagador\": {\n \"tipo_conta\": \"Conta Corrente\",\n \"agencia\": 1500,\n \"conta\": \"00052012\",\n \"tipo_pessoa\": \"J\",\n \"documento\": \"00000000000191\",\n \"modulo_sispag\": \"Fornecedores\"\n },\n \"recebedor\": {\n \"ispb\": 99999008,\n \"documento\": 11111111000191,\n \"nome\": \"TESTE DE INTEROPERABILIDADE\",\n \"tipo_conta\": \"Conta Corrente\",\n \"tipo_pessoa\": \"J\",\n \"identificacao_chave\": \"4004901d-bd85-4769-8e52-cb4c42c506dc\"\n },\n \"motivo_recusa\": []\n}" + }, + { + "name": "Solicitação de inclusão do Pagamento com erro", + "originalRequest": { + "method": "POST", + "header": [ + { + "description": "Added as a part of security scheme: oauth2", + "key": "Authorization", + "value": "" + }, + { + "description": "(Required) Chave da API utilizado para autorizar o consumo de uma aplicação requisitante", + "key": "x-itau-apikey", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador da funcionalidade de negócio sendo executada na aplicação", + "key": "x-itau-flowID", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-itau-correlationID", + "value": "labore enim commodo est adipisicing" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"valor_pagamento\": \"1.00\",\n \"data_pagamento\": \"2022-03-21T15:03:56.000Z\",\n \"chave\": \"4004901d-bd85-4769-8e52-cb4c42c506dc\",\n \"referencia_empresa\": \"Prestação 0123456789\",\n \"identificacao_comprovante\": \"Prestação de serviço - empresa A\",\n \"informacoes_entre_usuarios\": \"Pagamento para prestação de serviço para empresa A\",\n \"pagador\": {\n \"tipo_conta\": \"CC\",\n \"agencia\": 1500,\n \"conta\": \"00592660\",\n \"tipo_pessoa\": \"J\",\n \"documento\": 63237648000104,\n \"modulo_sispag\": \"Fornecedores\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "{{baseUrl}}/transferencias" + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"codigo\": 400,\n \"mensagem\": \"CNPJ inválido\"\n}" + }, + { + "name": "Inclusão do Pagamento rejeitado", + "originalRequest": { + "method": "POST", + "header": [ + { + "description": "Added as a part of security scheme: oauth2", + "key": "Authorization", + "value": "" + }, + { + "description": "(Required) Chave da API utilizado para autorizar o consumo de uma aplicação requisitante", + "key": "x-itau-apikey", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador da funcionalidade de negócio sendo executada na aplicação", + "key": "x-itau-flowID", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-itau-correlationID", + "value": "labore enim commodo est adipisicing" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"valor_pagamento\": \"1.00\",\n \"data_pagamento\": \"2022-03-21T15:03:56.000Z\",\n \"chave\": \"4004901d-bd85-4769-8e52-cb4c42c506dc\",\n \"referencia_empresa\": \"Prestação 0123456789\",\n \"identificacao_comprovante\": \"Prestação de serviço - empresa A\",\n \"informacoes_entre_usuarios\": \"Pagamento para prestação de serviço para empresa A\",\n \"pagador\": {\n \"tipo_conta\": \"CC\",\n \"agencia\": 1500,\n \"conta\": \"00592660\",\n \"tipo_pessoa\": \"J\",\n \"documento\": 63237648000104,\n \"modulo_sispag\": \"Fornecedores\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "{{baseUrl}}/transferencias" + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status_pagamento\": \"Rejeitado\",\n \"tipo_pagamento\": \"QRCODE\",\n \"data_pagamento\": \"2022-03-22T13:01:02.000Z\",\n \"valor_pagamento\": 1,\n \"referencia_empresa\": \"Prestação 0123456789\",\n \"identificacao_comprovante\": \"Prestação de serviço - empresa A\",\n \"informacoes_entre_usuarios\": \"Pagamento para prestação de serviço para empresa A\",\n \"pagador\": {\n \"tipo_conta\": \"Conta Corrente\",\n \"agencia\": 1500,\n \"conta\": \"00594138\",\n \"tipo_pessoa\": \"J\",\n \"documento\": 63237648000104,\n \"modulo_sispag\": \"CONTAS\"\n },\n \"recebedor\": {\n \"banco\": \"ITAÚ UNIBANCO S.A.\",\n \"ispb\": 60701190,\n \"documento\": 60701190000104,\n \"nome\": \"CASTELO E ASSOCIADOS\",\n \"tipo_conta\": \"Conta Corrente\",\n \"tipo_pessoa\": \"J\",\n \"identificacao_chave\": 60701190000104\n },\n \"motivo_recusa\": [\n {\n \"codigo\": 908,\n \"nome\": \"Valor do pagamento divergente do valor do qrcode.\"\n }\n ]\n}" + } + ] + }, + { + "name": "Post/QrCode copia e cola", + "request": { + "auth": { + "type": "bearer", + "bearer": {} + }, + "method": "POST", + "header": [ + { + "description": "(Required) Chave da API utilizado para autorizar o consumo de uma aplicação requisitante", + "key": "x-itau-apikey", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador da funcionalidade de negócio sendo executada na aplicação", + "key": "x-itau-flowID", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-itau-correlationID", + "value": "labore enim commodo est adipisicing" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"emv\": \"00020101021126950014BR.GOV.BCB.PIX2573spi.dev.cloud.itau.com.br/documentos/eb189f7a-1536-4f16-8951-1056a773685052040000530398654079999.005802BR5925ITAU PORTABILIDADE REIVIN6009SAO PAULO626005221Y4XMrEBhry4ao3no56nrC50300017BR.GOV.BCB.BRCODE01051.0.063046A8D\",\n \"valor_pagamento\": \"100.00\",\n \"data_pagamento\": \"2020-09-18\",\n \"pagador\": {\n \"tipo_conta\": \"CC\",\n \"agencia\": \"1500\",\n \"conta\": \"00052012\",\n \"tipo_pessoa\": \"J\",\n \"documento\": \"00000000000191\",\n \"modulo_sispag\": \"Fornecedores\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "{{baseUrl}}/transferencias", + "description": "API responsável por inserir transferências de Pix e pagamentos de Pix QR Code na plataforma SISPAG do Banco Itaú." + }, + "response": [ + { + "name": "Pagamento incluído com sucesso", + "originalRequest": { + "method": "POST", + "header": [ + { + "description": "Added as a part of security scheme: oauth2", + "key": "Authorization", + "value": "" + }, + { + "description": "(Required) Chave da API utilizado para autorizar o consumo de uma aplicação requisitante", + "key": "x-itau-apikey", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador da funcionalidade de negócio sendo executada na aplicação", + "key": "x-itau-flowID", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-itau-correlationID", + "value": "labore enim commodo est adipisicing" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"valor_pagamento\": \"1.00\",\n \"data_pagamento\": \"2022-03-21T15:03:56.000Z\",\n \"chave\": \"4004901d-bd85-4769-8e52-cb4c42c506dc\",\n \"referencia_empresa\": \"Prestação 0123456789\",\n \"identificacao_comprovante\": \"Prestação de serviço - empresa A\",\n \"informacoes_entre_usuarios\": \"Pagamento para prestação de serviço para empresa A\",\n \"pagador\": {\n \"tipo_conta\": \"CC\",\n \"agencia\": 1500,\n \"conta\": \"00592660\",\n \"tipo_pessoa\": \"J\",\n \"documento\": 63237648000104,\n \"modulo_sispag\": \"Fornecedores\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "{{baseUrl}}/transferencias" + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status_pagamento\": \"Sucesso\",\n \"cod_pagamento\": \"3ff2df99-704a-496e-a699-8b75dc522d10\",\n \"numero_lote\": 500001394,\n \"numero_lancamento\": 22683,\n \"tipo_pagamento\": \"PIX\",\n \"data_pagamento\": \"2022-03-21T15:03:56.000Z\",\n \"valor_pagamento\": 1,\n \"referencia_empresa\": \"Prestação 0123456789\",\n \"identificacao_comprovante\": \"Prestação de serviço - empresa A\",\n \"informacoes_entre_usuarios\": \"Pagamento para prestação de serviço para empresa A\",\n \"pagador\": {\n \"tipo_conta\": \"Conta Corrente\",\n \"agencia\": 1500,\n \"conta\": \"00052012\",\n \"tipo_pessoa\": \"J\",\n \"documento\": \"00000000000191\",\n \"modulo_sispag\": \"Fornecedores\"\n },\n \"recebedor\": {\n \"ispb\": 99999008,\n \"documento\": 11111111000191,\n \"nome\": \"TESTE DE INTEROPERABILIDADE\",\n \"tipo_conta\": \"Conta Corrente\",\n \"tipo_pessoa\": \"J\",\n \"identificacao_chave\": \"4004901d-bd85-4769-8e52-cb4c42c506dc\"\n },\n \"motivo_recusa\": []\n}" + }, + { + "name": "Solicitação de inclusão do Pagamento com erro", + "originalRequest": { + "method": "POST", + "header": [ + { + "description": "Added as a part of security scheme: oauth2", + "key": "Authorization", + "value": "" + }, + { + "description": "(Required) Chave da API utilizado para autorizar o consumo de uma aplicação requisitante", + "key": "x-itau-apikey", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador da funcionalidade de negócio sendo executada na aplicação", + "key": "x-itau-flowID", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-itau-correlationID", + "value": "labore enim commodo est adipisicing" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"valor_pagamento\": \"1.00\",\n \"data_pagamento\": \"2022-03-21T15:03:56.000Z\",\n \"chave\": \"4004901d-bd85-4769-8e52-cb4c42c506dc\",\n \"referencia_empresa\": \"Prestação 0123456789\",\n \"identificacao_comprovante\": \"Prestação de serviço - empresa A\",\n \"informacoes_entre_usuarios\": \"Pagamento para prestação de serviço para empresa A\",\n \"pagador\": {\n \"tipo_conta\": \"CC\",\n \"agencia\": 1500,\n \"conta\": \"00592660\",\n \"tipo_pessoa\": \"J\",\n \"documento\": 63237648000104,\n \"modulo_sispag\": \"Fornecedores\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "{{baseUrl}}/transferencias" + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"codigo\": 400,\n \"mensagem\": \"CNPJ inválido\"\n}" + }, + { + "name": "Inclusão do Pagamento rejeitado", + "originalRequest": { + "method": "POST", + "header": [ + { + "description": "Added as a part of security scheme: oauth2", + "key": "Authorization", + "value": "" + }, + { + "description": "(Required) Chave da API utilizado para autorizar o consumo de uma aplicação requisitante", + "key": "x-itau-apikey", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador da funcionalidade de negócio sendo executada na aplicação", + "key": "x-itau-flowID", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-itau-correlationID", + "value": "labore enim commodo est adipisicing" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"valor_pagamento\": \"1.00\",\n \"data_pagamento\": \"2022-03-21T15:03:56.000Z\",\n \"chave\": \"4004901d-bd85-4769-8e52-cb4c42c506dc\",\n \"referencia_empresa\": \"Prestação 0123456789\",\n \"identificacao_comprovante\": \"Prestação de serviço - empresa A\",\n \"informacoes_entre_usuarios\": \"Pagamento para prestação de serviço para empresa A\",\n \"pagador\": {\n \"tipo_conta\": \"CC\",\n \"agencia\": 1500,\n \"conta\": \"00592660\",\n \"tipo_pessoa\": \"J\",\n \"documento\": 63237648000104,\n \"modulo_sispag\": \"Fornecedores\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "{{baseUrl}}/transferencias" + }, + "status": "Unprocessable Entity (WebDAV) (RFC 4918)", + "code": 422, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status_pagamento\": \"Rejeitado\",\n \"tipo_pagamento\": \"QRCODE\",\n \"data_pagamento\": \"2022-03-22T13:01:02.000Z\",\n \"valor_pagamento\": 1,\n \"referencia_empresa\": \"Prestação 0123456789\",\n \"identificacao_comprovante\": \"Prestação de serviço - empresa A\",\n \"informacoes_entre_usuarios\": \"Pagamento para prestação de serviço para empresa A\",\n \"pagador\": {\n \"tipo_conta\": \"Conta Corrente\",\n \"agencia\": 1500,\n \"conta\": \"00594138\",\n \"tipo_pessoa\": \"J\",\n \"documento\": 63237648000104,\n \"modulo_sispag\": \"CONTAS\"\n },\n \"recebedor\": {\n \"banco\": \"ITAÚ UNIBANCO S.A.\",\n \"ispb\": 60701190,\n \"documento\": 60701190000104,\n \"nome\": \"CASTELO E ASSOCIADOS\",\n \"tipo_conta\": \"Conta Corrente\",\n \"tipo_pessoa\": \"J\",\n \"identificacao_chave\": 60701190000104\n },\n \"motivo_recusa\": [\n {\n \"codigo\": 908,\n \"nome\": \"Valor do pagamento divergente do valor do qrcode.\"\n }\n ]\n}" + } + ] + }, + { + "name": "get/pagamentos sispag", + "request": { + "method": "GET", + "header": [ + { + "description": "(Required) Chave da API utilizado para autorizar o consumo de uma aplicação requisitante", + "key": "x-itau-apikey", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador da funcionalidade de negócio sendo executada na aplicação", + "key": "x-itau-flowID", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-itau-correlationID", + "value": "labore enim commodo est adipisicing" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/pagamentos_sispag?agencia_operacao=1500&conta_operacao=00005201&cnpj_empresa=53929133&numero_lote=7448046265&valor_minimo=55461956.03618726&valor_maximo=7631891.306239873&referencia_empresa=Prestação 0123456789&nome_beneficiario=José da Silva&data_inicial=2020-06-01&data_final=2020-07-01&tipo_lista=Detalhada&modalidade_fornecedores=false&modalidade_impostos=true&modalidade_salario=true&status=AE&tipo_pagamento=01&order_by=labore enim commodo est adipisicing&order=asc", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "pagamentos_sispag" + ], + "query": [ + { + "key": "agencia_operacao", + "value": "1500", + "description": "(Required) Agência da operação" + }, + { + "key": "conta_operacao", + "value": "00005201", + "description": "(Required) Conta bancária da operação" + }, + { + "key": "cnpj_empresa", + "value": "53929133", + "description": "(Required) Documento do Pagador" + }, + { + "key": "numero_lote", + "value": "7448046265", + "description": "Número de lote SISPAG" + }, + { + "key": "valor_minimo", + "value": "55461956.03618726", + "description": "Valor mínimo do pagamento" + }, + { + "key": "valor_maximo", + "value": "7631891.306239873", + "description": "Valor máximo do pagamento" + }, + { + "key": "referencia_empresa", + "value": "Prestação 0123456789", + "description": "Referência da empresa" + }, + { + "key": "nome_beneficiario", + "value": "José da Silva", + "description": "Nome do Beneficiário" + }, + { + "key": "data_inicial", + "value": "2020-06-01", + "description": "Data de pagamento/transferência inicial para consulta" + }, + { + "key": "data_final", + "value": "2020-07-01", + "description": "Data de pagamento/transferência final para consulta" + }, + { + "key": "tipo_lista", + "value": "Detalhada", + "description": "(Required) Tipo da lista" + }, + { + "key": "modalidade_fornecedores", + "value": "false", + "description": "Filtro do tipo de modalidade de pagamento para fornecedores" + }, + { + "key": "modalidade_impostos", + "value": "true", + "description": "Filtro do tipo de modalidade de pagamento para impostos e tributos" + }, + { + "key": "modalidade_salario", + "value": "true", + "description": "Filtro do tipo de modalidade de pagamento para salário" + }, + { + "key": "status", + "value": "AE", + "description": "Filtro do código do tipo do status
\n * `AE` - A Efetuar\n * `EF` - Efetuados\n * `TD` - Todos\n * `NE` - Não Efetuados" + }, + { + "key": "tipo_pagamento", + "value": "01", + "description": "Filtro do tipo de transação bancária
\n * `01` - Conta Corrente\n * `02` - Cheque pagamento\n * `03` - DOC\n * `04` - OP (duas vias)\n * `05` - Conta Poupança\n * `06` - Conta Corrente Mesma Titularidade\n * `07` - DOC D mesma titularidade\n * `10` - OP (uma via)\n * `11` - OP (acerto)\n * `13` - Concessionária\n * `16` - DARF normal\n * `17` - GPS\n * `18` - DARF simples\n * `19` - IPTU/ISS e outros tributos\n * `22` - GARE ICMS-SP\n * `23` - GARE ICMS-SP Importação\n * `25` - Banco Múltiplo\n * `27` - DPVAT\n * `30` - Boleto Itaú\n * `31` - Boleto outros bancos\n * `32` - Nota fiscal eletrônica\n * `35` - FGTS\n * `38` - Boleto outros bancos online\n * `41` - TED outro titular\n * `43` - TED mesmo titular\n * `51` - Licenciamento\n * `53` - Multa\n * `63` - Concessionária com moeda variável\n * `91` - Tributos com código de barras\n * `92` - DARF código de barras\n * `93` - DAS código barras\n * `94` - GNRE ICMS-SP Importação\n * `95` - IPVA\n * `45` - PIX Transferências\n * `47` - PIX Qr Code\n * `60` - Cartão Salário " + }, + { + "key": "order_by", + "value": "labore enim commodo est adipisicing", + "description": "Opção para ordenação." + }, + { + "key": "order", + "value": "asc", + "description": "Opção de ordenação ascendente ou descendente." + } + ] + }, + "description": "Detalhe da consulta de pagamentos e transferências" + }, + "response": [ + { + "name": "OK", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: oauth2", + "key": "Authorization", + "value": "" + }, + { + "description": "(Required) Chave da API utilizado para autorizar o consumo de uma aplicação requisitante", + "key": "x-itau-apikey", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador da funcionalidade de negócio sendo executada na aplicação", + "key": "x-itau-flowID", + "value": "labore enim commodo est adipisicing" + }, + { + "description": "Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail", + "key": "x-itau-correlationID", + "value": "labore enim commodo est adipisicing" + } + ], + "url": { + "raw": "{{baseUrl}}/pagamentos_sispag?agencia_operacao=1500&conta_operacao=00005201&cnpj_empresa=53929133&numero_lote=7448046265&valor_minimo=55461956.03618726&valor_maximo=7631891.306239873&referencia_empresa=Prestação 0123456789&nome_beneficiario=José da Silva&data_inicial=2020-06-01&data_final=2020-07-01&tipo_lista=Detalhada&modalidade_fornecedores=true&modalidade_impostos=true&modalidade_salario=true&status=AE&tipo_pagamento=01&order_by=labore enim commodo est adipisicing&order=asc", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "pagamentos_sispag" + ], + "query": [ + { + "key": "agencia_operacao", + "value": "1500" + }, + { + "key": "conta_operacao", + "value": "00005201" + }, + { + "key": "cnpj_empresa", + "value": "53929133" + }, + { + "key": "numero_lote", + "value": "7448046265" + }, + { + "key": "valor_minimo", + "value": "55461956.03618726" + }, + { + "key": "valor_maximo", + "value": "7631891.306239873" + }, + { + "key": "referencia_empresa", + "value": "Prestação 0123456789" + }, + { + "key": "nome_beneficiario", + "value": "José da Silva" + }, + { + "key": "data_inicial", + "value": "2020-06-01" + }, + { + "key": "data_final", + "value": "2020-07-01" + }, + { + "key": "tipo_lista", + "value": "Detalhada" + }, + { + "key": "modalidade_fornecedores", + "value": "true" + }, + { + "key": "modalidade_impostos", + "value": "true" + }, + { + "key": "modalidade_salario", + "value": "true" + }, + { + "key": "status", + "value": "AE" + }, + { + "key": "tipo_pagamento", + "value": "01" + }, + { + "key": "order_by", + "value": "labore enim commodo est adipisicing" + }, + { + "key": "order", + "value": "asc" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"value\": {\n \"data\": {\n \"itens\": [\n {\n \"nome_favorecido\": \"Teste nome favorecido 1\",\n \"id_pagamento\": \"3a2a32d3-37c3-4bf9-b526-b8e3a17592b9\",\n \"cpf_cnpj\": \"89057409011\",\n \"cod_banco\": \"123\",\n \"numero_agencia\": \"1500\",\n \"numero_conta\": \"2011500\",\n \"numero_lancamento\": \"123456789\",\n \"referencia_empresa\": \" \",\n \"data_pagamento\": \"2020-07-01\",\n \"valor_pagamento\": \"100.00\",\n \"status\": \"Efetuados\",\n \"comprovante\": \"link\",\n \"motivo\": \"\",\n \"tipo_pagamento\": \"TED\"\n },\n {\n \"nome_favorecido\": \"Teste nome favorecido 1\",\n \"id_pagamento\": \"3a2a32d3-37c3-4bf9-b526-b8e3a17592b8\",\n \"cpf_cnpj\": \"89057409011\",\n \"cod_banco\": \"123\",\n \"numero_agencia\": \"1500\",\n \"numero_conta\": \"2011500\",\n \"numero_lancamento\": \"123456789\",\n \"referencia_empresa\": \" \",\n \"data_pagamento\": \"2020-07-01\",\n \"valor_pagamento\": \"100.00\",\n \"status\": \"Efetuados\",\n \"comprovante\": \"link\",\n \"motivo\": \"\",\n \"tipo_pagamento\": \"TED\"\n }\n ],\n \"total\": \"200.00\"\n },\n \"pagination\": {\n \"links\": {\n \"first\": \"https://des-apigateway-int.mbi.cloud.ihf/cash_management/v1/lista_detalhada_pagamentos/\",\n \"last\": \"https://des-apigateway-int.mbi.cloud.ihf/cash_management/v1/lista_detalhada_pagamentos/?page=2\",\n \"previous\": \"\",\n \"next\": \"https://des-apigateway-int.mbi.cloud.ihf/cash_management/v1/lista_detalhada_pagamentos/?page=1\"\n },\n \"page\": 0,\n \"total_pages\": 3,\n \"total_elements\": 6,\n \"page_size\": 2\n }\n },\n \"description\": \"\"\n}" + } + ] + }, + { + "name": "get/pagamentos sispag/{id pagamento sispag}", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "var jsonData = JSON.parse(responseBody);\r", + "postman.setEnvironmentVariable(\"access_token\", jsonData.access_token);" + ], + "type": "text/javascript" + } + } + ], + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/pagamentos_sispag/:id_pagamento_sispag", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "pagamentos_sispag", + ":id_pagamento_sispag" + ], + "variable": [ + { + "key": "id_pagamento_sispag", + "value": "3ff2df99-704a-496e-a699-8b75dc522d10", + "description": "(Required) Identificador único do Pagamento" + } + ] + }, + "description": "Operação responsável por recuperar o detalhamento do pagamento" + }, + "response": [ + { + "name": "OK", + "originalRequest": { + "method": "GET", + "header": [ + { + "description": "Added as a part of security scheme: oauth2", + "key": "Authorization", + "value": "" + } + ], + "url": { + "raw": "{{baseUrl}}/pagamentos_sispag/:id_pagamento_sispag", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "pagamentos_sispag", + ":id_pagamento_sispag" + ], + "variable": [ + { + "key": "id_pagamento_sispag", + "value": "3ff2df99-704a-496e-a699-8b75dc522d10", + "description": "(Required) Identificador único do Pagamento" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Location", + "value": "labore enim commodo est adipisicing", + "description": "URI correspondente a pesquisa corrente" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"value\": {\n \"data\": {\n \"dados_debito\": {\n \"numero_agencia_debito\": \"1500\",\n \"numero_conta_debito\": \"052020\",\n \"nome_empresa_debito\": \"NOME RDZD\",\n \"cnpj_debito\": \"34727090000139\"\n },\n \"dados_pagamento\": {\n \"id_pagamento\": \"3a2a32d3-37c3-4bf9-b526-b8e3a17592b9\",\n \"cod_tipo_pessoa\": \"\",\n \"cpf_cnpj_favorecido\": \"\",\n \"cod_banco_favorecido\": \"341\",\n \"nome_banco_favorecido\": \"BANCO ITAU S/A\",\n \"numero_agencia_favorecido\": \"1500\",\n \"numero_conta_favorecido\": \"2011500\",\n \"nome_favorecido\": \"TESTE\",\n \"valor_pagamento\": \"1000.00\",\n \"numero_lote\": \"123\",\n \"numero_lancamento\": \"456\",\n \"referencia_empresa\": \"0197 256771\",\n \"data_pagamento\": \"2020-06-15\",\n \"status\": \"Efetuado\",\n \"descricao_pagamento\": \"\",\n \"identificacao_comprovante\": \"Teste Identificação\",\n \"codigo_isbp\": \"00360305\",\n \"descricao_finalidade\": \"\",\n \"modalidade_pagto\": \"\",\n \"tipo_pagamento\": \"\",\n \"indicador_motivo\": \"\",\n \"dados_ted\": {\n \"complemento_finalidade_ted\": \"\",\n \"numero_ted\": \"140950\"\n },\n \"dados_doc\": null,\n \"dados_darf\": null,\n \"dados_cheque\": null,\n \"dados_op\": null,\n \"dados_gps\": null,\n \"dados_iptu_inss\": null,\n \"dados_gare_icms_sp\": null,\n \"dados_gare_icms_sp_importacao\": null,\n \"dados_gnre_icms_sp_importacao\": null,\n \"dados_ipva\": null,\n \"dados_fgts\": null,\n \"dados_dpvat\": null,\n \"dados_licenciamento\": null,\n \"dados_multa\": null,\n \"dados_trib_cod_barras\": null,\n \"motivo_rejeicao\": [\n {\n \"descricao_motivo\": \"Teste Motivo rejeicao 1\"\n },\n {\n \"descricao_motivo\": \"Teste Motivo rejeicao 2\"\n }\n ]\n },\n \"historico_pagamento\": [\n {\n \"status\": \"Efetivação\",\n \"data\": \"2020-01-01\",\n \"nome_operador\": \"Oper Ex\",\n \"cod_operador\": \"999999999\",\n \"cpf_operador\": \"\"\n },\n {\n \"status\": \"Autorização\",\n \"data\": \"2020-01-01\",\n \"nome_operador\": \"Oper Ex\",\n \"cod_operador\": \"999999999\",\n \"cpf_operador\": \"\"\n },\n {\n \"status\": \"Inclusão Online\",\n \"data\": \"2020-01-01\",\n \"nome_operador\": \"Oper Ex\",\n \"cod_operador\": \"999999999\",\n \"cpf_operador\": \"\"\n }\n ]\n }\n },\n \"description\": \"\"\n}" + } + ] + } + ] + } + ], + "auth": { + "type": "oauth2", + "oauth2": {} + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://api.itau.com.br/sispag/v1", + "type": "string" + } + ] +} \ No newline at end of file diff --git a/docs/itau_ep9_gtw_pix_recebimentos_ext_v2_d76f11dc9d.json b/docs/itau_ep9_gtw_pix_recebimentos_ext_v2_d76f11dc9d.json new file mode 100644 index 0000000..ed37b30 --- /dev/null +++ b/docs/itau_ep9_gtw_pix_recebimentos_ext_v2_d76f11dc9d.json @@ -0,0 +1 @@ +{"openapi":"3.0.0","info":{"title":"APIs Regulatórias Pix Recebimentos","version":"2.69.28","description":"API Emissão/Alteração, Devolução, Location, Lote e Devolução de QRCodes PIX para Participantes Diretos\n","sandbox-url":"https://devportal.itau.com.br/sandboxapi/itau-ep9-gtw-pix-recebimentos-ext-v2/v2"},"servers":[{"url":"https://secure.api.itau/pix_recebimentos/v2"}],"paths":{"/cob/{txid}":{"put":{"tags":["QR Code imediato (COB)"],"operationId":"put/cob/{txid}","description":"API para emitir um QR Code imediato.","parameters":[{"$ref":"#/components/parameters/x-itau-apikey"},{"$ref":"#/components/parameters/x-itau-correlationID"},{"$ref":"#/components/parameters/txid"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediataPutRequest"},"examples":{"emissão de cobranca imediata com campos mínimos obrigatórios":{"$ref":"#/components/examples/request_put_cobranca_imediata_campos_obrigatorios"},"emissão de cobrança imediata com todos os campos":{"$ref":"#/components/examples/request_put_cobranca_imediata_completo"},"emissão de saque pix com campos mínimos obrigatórios":{"$ref":"#/components/examples/request_post_cobranca_imediata_saque_campos_obrigatorios"},"emissão de saque pix com todos os campos":{"$ref":"#/components/examples/request_post_cobranca_imediata_saque_completo"},"emissão de troco pix com campos mínimos obrigatórios":{"$ref":"#/components/examples/request_post_cobranca_imediata_troco_campos_obrigatorios"},"emissão de troco pix com todos os campos":{"$ref":"#/components/examples/request_post_cobranca_imediata_troco_completo"}}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediataPutResponse"},"examples":{"cobrança imediata emitida com sucesso":{"$ref":"#/components/examples/200_cobranca_imediata_txid"},"cobrança com saque pix emitida com sucesso":{"$ref":"#/components/examples/201_cobranca_imediata_saque"},"cobrança com troco pix emitida com sucesso":{"$ref":"#/components/examples/201_cobranca_imediata_troco"}}}},"description":"Cobrança imediata criada"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediata_400"}}},"description":"Requisição com formato inválido."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediata_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediata_404"}}},"description":"Recurso solicitado não foi encontrado."},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediata_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."}},"security":[{"APIGatewaySTSAuthorizer":[]}]},"patch":{"tags":["QR Code imediato (COB)"],"operationId":"patch/cob/{txid}","description":"API para alterar ou cancelar um QR Code imediato.","parameters":[{"$ref":"#/components/parameters/x-itau-apikey"},{"$ref":"#/components/parameters/x-itau-correlationID"},{"$ref":"#/components/parameters/txid"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediataPatchRequest"},"examples":{"alteração de cobrança imediata com todos os campos":{"$ref":"#/components/examples/request_patch_cobranca_imediata_completo"},"alteração de valor original":{"$ref":"#/components/examples/request_patch_cobranca_imediata_valor_original"},"alteração de modalidade de alteração":{"$ref":"#/components/examples/request_patch_cobranca_imediata_modalidade_alteracao"},"alteração de devedor":{"$ref":"#/components/examples/request_patch_cobranca_imediata_devedor"},"alteração de identificador de location":{"$ref":"#/components/examples/request_patch_cobranca_imediata_loc_id"},"alteração de expiração":{"$ref":"#/components/examples/request_patch_cobranca_imediata_calendario_expiracao"},"alteração de chave pix":{"$ref":"#/components/examples/request_patch_cobranca_imediata_chave"},"alteração de solicitação pagador":{"$ref":"#/components/examples/request_patch_cobranca_imediata_solicitacao_pagador"},"alteração de informações adicionais":{"$ref":"#/components/examples/request_patch_cobranca_imediata_informacoes_adicionais"},"cancelamento da cobrança":{"$ref":"#/components/examples/request_patch_cobranca_imediata_status"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediataPatchResponse"},"examples":{"cobrança imediata alterada com sucesso":{"$ref":"#/components/examples/201_cobranca_imediata_txid"}}}},"description":"Cobrança imediata revisada. A revisão deve ser incrementada em 1."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediata_400"}}},"description":"Requisição com formato inválido."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediata_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediata_404"}}},"description":"Recurso solicitado não foi encontrado."},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediata_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."}},"security":[{"APIGatewaySTSAuthorizer":[]}]},"get":{"tags":["QR Code imediato (COB)"],"operationId":"get/cob/{txid}","description":"API para consultar um QR Code imediato específico através do identificador do QR Code (txid).","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobranca"},"examples":{"Consulta de cobranças imediata ativa":{"$ref":"#/components/examples/response_200_consulta_cobranca_imediata_ativa_by_txid"},"Consulta de cobranças imediata paga e devolvida":{"$ref":"#/components/examples/response_200_consulta_cobranca_imediata_paga_e_devolvida_by_txid"},"Consulta de cobranças saque ativo":{"$ref":"#/components/examples/response_200_consulta_cobranca_saque_pix_ativo"},"Consulta de cobranças saque pago e devolvido":{"$ref":"#/components/examples/response_200_consulta_cobranca_saque_pix_paga_e_devolvido"},"Consulta de cobranças troco ativo":{"$ref":"#/components/examples/response_200_consulta_cobranca_troco_pix_ativo"},"Consulta de cobranças troco removido":{"$ref":"#/components/examples/response_200_consulta_cobranca_troco_pix_removido"}}}},"description":"OK","headers":{"Content-Location":{"description":"URI correspondente a pesquisa corrente","schema":{"type":"string"}}}},"204":{"$ref":"#/components/responses/204_get"},"303":{"$ref":"#/components/responses/303_get"},"400":{"$ref":"#/components/responses/400_get"},"401":{"$ref":"#/components/responses/401_get"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_404"}}},"description":"Recurso solicitado não foi encontrado."},"405":{"$ref":"#/components/responses/405_get"},"422":{"$ref":"#/components/responses/422_get"},"428":{"$ref":"#/components/responses/428_get"},"500":{"$ref":"#/components/responses/500_get"},"501":{"$ref":"#/components/responses/501_get"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"504":{"$ref":"#/components/responses/504_get"}},"parameters":[{"in":"path","name":"txid","required":true,"description":"Txid a ser consultado.","schema":{"type":"string"}},{"in":"query","name":"revisao","required":false,"description":"Id de transação do documento, utilizado para a sua identificação no banco central","schema":{"type":"string"}}],"security":[{"APIGatewaySTSAuthorizer":[]}]}},"/cob":{"post":{"tags":["QR Code imediato (COB)"],"operationId":"post/cob","description":"API para emitir um QR Code imediato em que o Itaú é responsável por criar o identificador do QR Code (txid).","parameters":[{"$ref":"#/components/parameters/x-itau-apikey"},{"$ref":"#/components/parameters/x-itau-correlationID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediataPostRequest"},"examples":{"emissão de cobranca imediata com campos mínimos obrigatórios":{"$ref":"#/components/examples/request_post_cobranca_imediata_campos_obrigatorios"},"emissão de cobranca imediata com todos os campos":{"$ref":"#/components/examples/request_post_cobranca_imediata_completo"},"emissão de saque pix com campos mínimos obrigatórios":{"$ref":"#/components/examples/request_post_cobranca_imediata_saque_campos_obrigatorios"},"emissão de saque pix com todos os campos":{"$ref":"#/components/examples/request_post_cobranca_imediata_saque_completo"},"emissão de troco pix com campos mínimos obrigatórios":{"$ref":"#/components/examples/request_post_cobranca_imediata_troco_campos_obrigatorios"},"emissão de troco pix com todos os campos":{"$ref":"#/components/examples/request_post_cobranca_imediata_troco_completo"}}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediataPostResponse"},"examples":{"cobrança imediata emitida com sucesso":{"$ref":"#/components/examples/201_cobranca_imediata"},"cobrança com saque pix emitida com sucesso":{"$ref":"#/components/examples/201_cobranca_imediata_saque"},"cobrança com troco pix emitida com sucesso":{"$ref":"#/components/examples/201_cobranca_imediata_troco"}}}},"description":"Cobrança imediata criada"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediata_400"}}},"description":"Requisição com formato inválido."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediata_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediata_404"}}},"description":"Recurso solicitado não foi encontrado."},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaImediata_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."}},"security":[{"APIGatewaySTSAuthorizer":[]}]},"get":{"tags":["QR Code imediato (COB)"],"operationId":"get/cob","description":"API para consultar uma listagem de QR Codes imediatos.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancas"},"examples":{"Consulta de cobranças imediata":{"$ref":"#/components/examples/response_200_consulta_cobranca_imediata_list"}}}},"description":"Lista de cobranças imediatas.","headers":{"Content-Location":{"description":"URI correspondente a pesquisa corrente","schema":{"type":"string"}}}},"204":{"$ref":"#/components/responses/204_get"},"303":{"$ref":"#/components/responses/303_get"},"400":{"$ref":"#/components/responses/400_get"},"401":{"$ref":"#/components/responses/401_get"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"$ref":"#/components/responses/404_get"},"405":{"$ref":"#/components/responses/405_get"},"422":{"$ref":"#/components/responses/422_get"},"428":{"$ref":"#/components/responses/428_get"},"500":{"$ref":"#/components/responses/500_get"},"501":{"$ref":"#/components/responses/501_get"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"504":{"$ref":"#/components/responses/504_get"}},"parameters":[{"in":"query","name":"inicio","required":true,"description":"Data inicial. Respeita RFC 3339.","schema":{"type":"string"}},{"in":"query","name":"fim","required":true,"description":"Data de fim. Respeita RFC 3339.","schema":{"type":"string"}},{"in":"query","name":"cpf","required":false,"description":"CPF do pagador cadastrado na cobrança.","schema":{"type":"string"}},{"in":"query","name":"cnpj","required":false,"description":"CNPJ do pagador cadastrado na cobrança.","schema":{"type":"string"}},{"in":"query","name":"locationPresente","required":false,"description":"Indicador se localização está presente.","schema":{"type":"boolean"}},{"in":"query","name":"status","required":false,"description":"Filtro pelo Status da cobrança. Pode ser ATIVA, CONCLUIDA, REMOVIDA_PELO_PSP OU REMOVIDA_PELO_USUARIO_RECEBEDOR","schema":{"type":"string","enum":["ATIVA","CONCLUIDA","REMOVIDA_PELO_USUARIO_RECEBEDOR","REMOVIDA_PELO_PSP"]}},{"in":"query","name":"paginacao.paginaAtual","required":false,"description":"Numero da Página que deseja realizar o acesso, valor considerado por default 0.","schema":{"type":"integer"}},{"in":"query","name":"paginacao.itensPorPagina","required":false,"description":"Quantidade de ocorrência retornadas por pagina, valor por default 100.","schema":{"type":"integer"}},{"in":"header","name":"x-correlationID","required":false,"description":"Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail","schema":{"type":"string"}}],"security":[{"APIGatewaySTSAuthorizer":[]}]}},"/cob/{txid}/qrcode":{"get":{"tags":["QR Code imediato (COB)"],"operationId":"get/cob/{txid}/qrcode","description":"API descontinuada. Para verificar dados de um qrcode, por favor utilizar a API **GET /cob/{txid}**.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/qrcode"}}},"description":"OK","headers":{"Content-Location":{"description":"URI correspondente a pesquisa corrente","schema":{"type":"string"}}}},"204":{"$ref":"#/components/responses/204_get"},"303":{"$ref":"#/components/responses/303_get"},"400":{"$ref":"#/components/responses/400_get"},"401":{"$ref":"#/components/responses/401_get"},"403":{"$ref":"#/components/responses/403_get"},"404":{"$ref":"#/components/responses/404_get"},"405":{"$ref":"#/components/responses/405_get"},"422":{"$ref":"#/components/responses/422_get"},"428":{"$ref":"#/components/responses/428_get"},"500":{"$ref":"#/components/responses/500_get"},"501":{"$ref":"#/components/responses/501_get"},"503":{"$ref":"#/components/responses/503_get"},"504":{"$ref":"#/components/responses/504_get"}},"parameters":[{"in":"path","name":"txid","required":true,"description":"Txid a ser consultado.","schema":{"type":"string"}},{"in":"header","name":"x-correlationID","required":false,"description":"Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail","schema":{"type":"string"}}]}},"/cobv/{txid}":{"put":{"tags":["QR Code com vencimento (COBV)"],"operationId":"put/cobv/{txid}","description":"API para emitir um QR Code com vencimento.","parameters":[{"$ref":"#/components/parameters/x-itau-apikey"},{"$ref":"#/components/parameters/x-itau-correlationID"},{"$ref":"#/components/parameters/txid"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimentoPutRequest"},"examples":{"emissão de cobranca com vencimento com campos mínimos obrigatórios":{"$ref":"#/components/examples/request_put_cobranca_vencimento_campos_obrigatorios"},"emissão de cobranca com vencimento com todos os campos":{"$ref":"#/components/examples/request_put_cobranca_vencimento_completo"}}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimentoPutResponse"},"examples":{"cobrança com vencimento emitida com sucesso":{"$ref":"#/components/examples/201_cobranca_vencimento_txid"}}}},"description":"Cobrança com vencimento criada."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_400"}}},"description":"Requisição com formato inválido."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_404"}}},"description":"Recurso solicitado não foi encontrado."},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."}},"security":[{"APIGatewaySTSAuthorizer":[]}]},"patch":{"tags":["QR Code com vencimento (COBV)"],"operationId":"patch/cobv/{txid}","description":"API para alterar ou cancelar um QR Code com vencimento.","parameters":[{"$ref":"#/components/parameters/x-itau-apikey"},{"$ref":"#/components/parameters/x-itau-correlationID"},{"$ref":"#/components/parameters/txid"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimentoPatchRequest"},"examples":{"alteração de cobrança com vencimento com todos os campos":{"$ref":"#/components/examples/request_patch_cobranca_vencimento_completo"},"alteração de informações adicionais":{"$ref":"#/components/examples/request_patch_cobranca_vencimento_informacoes_adicionais"},"alteração de valor original":{"$ref":"#/components/examples/request_patch_cobranca_vencimento_valor_original"},"alteração de multa":{"$ref":"#/components/examples/request_patch_cobranca_vencimento_valor_multa"},"alteração de juros":{"$ref":"#/components/examples/request_patch_cobranca_vencimento_valor_juros"},"alteração de abatimento":{"$ref":"#/components/examples/request_patch_cobranca_vencimento_valor_abatimento"},"alteração de desconto":{"$ref":"#/components/examples/request_patch_cobranca_vencimento_valor_desconto"},"alteração de data de vencimento":{"$ref":"#/components/examples/request_patch_cobranca_vencimento_calendario_data_de_vencimento"},"alteração de validade após vencimento":{"$ref":"#/components/examples/request_patch_cobranca_vencimento_calendario_validade_apos_vencimento"},"alteração de devedor":{"$ref":"#/components/examples/request_patch_cobranca_vencimento_devedor"},"alteração de identificador de location":{"$ref":"#/components/examples/request_patch_cobranca_vencimento_loc_id"},"alteração de chave pix":{"$ref":"#/components/examples/request_patch_cobranca_vencimento_chave"},"alteração de solicitação pagador":{"$ref":"#/components/examples/request_patch_cobranca_vencimento_solicitacao_pagador"},"cancelamento da cobrança":{"$ref":"#/components/examples/request_patch_cobranca_vencimento_status"}}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimentoPatchResponse"},"examples":{"cobrança com vencimento alterada com sucesso":{"$ref":"#/components/examples/201_cobranca_vencimento_txid"}}}},"description":"Cobrança com vencimento revisada. A revisão deve ser incrementada em 1."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_400"}}},"description":"Requisição com formato inválido."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_404"}}},"description":"Recurso solicitado não foi encontrado."},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."}},"security":[{"APIGatewaySTSAuthorizer":[]}]},"get":{"tags":["QR Code com vencimento (COBV)"],"operationId":"get/cobv/{txid}","description":"API para consultar um QR Code com vencimento específico através do identificador do QR Code (txid).","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento"},"examples":{"Consulta de cobrança com vencimento ativa":{"$ref":"#/components/examples/200_cobranca_vencimento_ativa_by_txid"},"Consulta de cobrança com vencimento paga e devolvida":{"$ref":"#/components/examples/200_cobranca_vencimento_paga_e_devolvida_by_txid"},"Consulta de cobrança com vencimento removida":{"$ref":"#/components/examples/200_cobranca_vencimento_removida_by_txid"}}}},"description":"Dados da cobrança com vencimento.","headers":{"Content-Location":{"description":"URI correspondente a pesquisa corrente","schema":{"type":"string"}}}},"204":{"$ref":"#/components/responses/204_get"},"303":{"$ref":"#/components/responses/303_get"},"400":{"$ref":"#/components/responses/400_get"},"401":{"$ref":"#/components/responses/401_get"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_404"}}},"description":"Recurso solicitado não foi encontrado."},"405":{"$ref":"#/components/responses/405_get"},"422":{"$ref":"#/components/responses/422_get"},"428":{"$ref":"#/components/responses/428_get"},"500":{"$ref":"#/components/responses/500_get"},"501":{"$ref":"#/components/responses/501_get"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"504":{"$ref":"#/components/responses/504_get"}},"parameters":[{"in":"path","name":"txid","required":true,"description":"Txid a ser consultado.","schema":{"type":"string"}},{"in":"query","name":"revisao","required":false,"description":"Revisão do documento, utilizado para a sua identificação no banco central","schema":{"type":"string"}}],"security":[{"APIGatewaySTSAuthorizer":[]}]}},"/cobv":{"get":{"tags":["QR Code com vencimento (COBV)"],"operationId":"get/cobv","description":"API para consultar uma listagem de QR Codes com vencimento.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancasVencimento"},"examples":{"Consulta de cobranças com vencimento":{"$ref":"#/components/examples/200_cobranca_vencimento_list"}}}},"description":"Lista de cobranças com vencimento.","headers":{"Content-Location":{"description":"URI correspondente a pesquisa corrente","schema":{"type":"string"}}}},"204":{"$ref":"#/components/responses/204_get"},"303":{"$ref":"#/components/responses/303_get"},"400":{"$ref":"#/components/responses/400_get"},"401":{"$ref":"#/components/responses/401_get"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"$ref":"#/components/responses/404_get"},"405":{"$ref":"#/components/responses/405_get"},"422":{"$ref":"#/components/responses/422_get"},"428":{"$ref":"#/components/responses/428_get"},"500":{"$ref":"#/components/responses/500_get"},"501":{"$ref":"#/components/responses/501_get"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"504":{"$ref":"#/components/responses/504_get"}},"parameters":[{"in":"query","name":"inicio","required":true,"description":"Data inicial. Respeita RFC 3339.","schema":{"type":"string"}},{"in":"query","name":"fim","required":true,"description":"Data de fim. Respeita RFC 3339.","schema":{"type":"string"}},{"in":"query","name":"cpf","required":false,"description":"CPF do devedor cadastrado na cobrança.","schema":{"type":"string"}},{"in":"query","name":"cnpj","required":false,"description":"CNPJ do devedor cadastrado na cobrança.","schema":{"type":"string"}},{"in":"query","name":"locationPresente","required":false,"description":"Indicador se localização está presente.","schema":{"type":"boolean"}},{"in":"query","name":"status","required":false,"description":"Filtro pelo Status da cobrança. Pode ser ATIVA, CONCLUIDA, REMOVIDA_PELO_PSP OU REMOVIDA_PELO_USUARIO_RECEBEDOR","schema":{"type":"string","enum":["ATIVA","CONCLUIDA","REMOVIDA_PELO_USUARIO_RECEBEDOR","REMOVIDA_PELO_PSP"]}},{"in":"query","name":"loteCobVId","required":false,"description":"Id do lote de cobrança com vencimento.","schema":{"type":"integer"}},{"in":"query","name":"paginacao.paginaAtual","required":false,"description":"Numero da Página que deseja realizar o acesso, valor considerado por default 0.","schema":{"type":"integer"}},{"in":"query","name":"paginacao.itensPorPagina","required":false,"description":"Quantidade de ocorrência retornadas por pagina, valor por default 100.","schema":{"type":"integer"}},{"in":"header","name":"x-correlationID","required":false,"description":"Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail","schema":{"type":"string"}}],"security":[{"APIGatewaySTSAuthorizer":[]}]}},"/cobv/{txid}/qrcode":{"get":{"tags":["QR Code com vencimento (COBV)"],"operationId":"get/cobv/{txid}/qrcode","description":"API descontinuada. Para verificar dados de um qrcode, por favor utilizar a API **GET /cobv/{txid}**.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/qrcode"}}},"description":"OK","headers":{"Content-Location":{"description":"URI correspondente a pesquisa corrente","schema":{"type":"string"}}}},"204":{"$ref":"#/components/responses/204_get"},"303":{"$ref":"#/components/responses/303_get"},"400":{"$ref":"#/components/responses/400_get"},"401":{"$ref":"#/components/responses/401_get"},"403":{"$ref":"#/components/responses/403_get"},"404":{"$ref":"#/components/responses/404_get"},"405":{"$ref":"#/components/responses/405_get"},"422":{"$ref":"#/components/responses/422_get"},"428":{"$ref":"#/components/responses/428_get"},"500":{"$ref":"#/components/responses/500_get"},"501":{"$ref":"#/components/responses/501_get"},"503":{"$ref":"#/components/responses/503_get"},"504":{"$ref":"#/components/responses/504_get"}},"parameters":[{"in":"path","name":"txid","required":true,"description":"Txid a ser consultado.","schema":{"type":"string"}},{"in":"header","name":"x-correlationID","required":false,"description":"Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail","schema":{"type":"string"}}]}},"/lotecobv/{id}":{"put":{"tags":["Lote de QR Codes com vencimento (COBV)"],"operationId":"put/lotecobv/{id}","description":"API para emitir ou alterar um lote de QR Codes com vencimento.\n\nPara o caso de uso de alteração de QR Code, o array a ser atribuído na requisição e deve ser composto pelas exatas requisições de criação de QR Code com vencimento que constaram no array atribuído na requisição originária.\n\nNão se pode utilizar esta API para alterar um lote de QR Code com vencimento agregando ou removendo um QR Code já existente dentro do conjunto de QR Codes criados na requisição originária do lote.\n\nEm outras palavras, se originalmente criou-se um lote, por exemplo, com QR Codes [`a`, `b` e `c`], não se pode alterar esse conjunto de QR Codes originais que o lote representa para [`a`, `b`, `c`, `d`], ou para [`a`, `b`]. Por outro lado, pode-se alterar, em lote os QR Codes [`a`, `b`, `c`], conforme originalmente constam na requisição originária do lote.\n\nUma solicitação de criação de QR Code com status \"EM_PROCESSAMENTO\" ou \"NEGADA\" está associada a um QR Code não existe de fato, portanto não será listada em `GET /cobv` ou `GET /cobv/{txid}`.\n\nUm QR Code, uma vez criado via `PUT /cobv/{txid}`, não pode ser associada a um lote posteriormente.\n\nUm QR Code, uma vez criada via `PUT /lotecobv/{id}`, não pode ser associada a um novo lote posteriormente.\n","parameters":[{"$ref":"#/components/parameters/x-itau-apikey"},{"$ref":"#/components/parameters/x-itau-correlationID"},{"$ref":"#/components/parameters/id-lotecobv"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/loteCobrancaVencimentoPutRequest"},"examples":{"emissão de lotes de cobrancas com campos mínimos obrigatórios":{"$ref":"#/components/examples/request_put_lotecobv_campos_obrigatorios"},"emissão de lotes de cobrancas com vencimento com todos os campos":{"$ref":"#/components/examples/request_put_lotecobv_completo"}}}}},"responses":{"202":{"content":{"application/json":{"examples":{"lote de cobrança com vencimento emitido com sucesso":{"$ref":"#/components/examples/202_lotecobv_put"}}}},"description":"Lote de cobranças com vencimento solicitado para criação."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lotecobv_400"}}},"description":"Requisição com formato inválido."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lotecobv_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lotecobv_404"}}},"description":"Recurso solicitado não foi encontrado."},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lotecobv_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."}},"security":[{"APIGatewaySTSAuthorizer":[]}]},"patch":{"tags":["Lote de QR Codes com vencimento (COBV)"],"operationId":"patch/lotecobv/{id}","description":"API para revisar um QR Code com vencimento específico dentro de um lote de QR Codes com vencimento.\n\nA diferença desta API para a API PUT correlato é que esta API admite um array `cobsv` com menos solicitações de criação ou alteração de QR Code do que o array atribuído na requisição originária do lote.\n\nNão se pode, entretanto, utilizar essa API para agregar ou remover solicitações de alteração ou criação de QR Codes conforme constam na requisição originária do lote.\n","parameters":[{"$ref":"#/components/parameters/x-itau-apikey"},{"$ref":"#/components/parameters/x-itau-correlationID"},{"$ref":"#/components/parameters/id-lotecobv"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/loteCobrancaVencimentoPatchRequest"},"examples":{"alteração de lotes de cobrancas com vencimento com todos os campos":{"$ref":"#/components/examples/request_patch_lotecobv_completo"},"alteração de descrição do lote":{"$ref":"#/components/examples/request_patch_lotecobv_descricao"},"alteração de data de vencimento de cada cobrança com vencimento":{"$ref":"#/components/examples/request_patch_lotecobv_calendario_data_de_vencimento"},"alteração de validade após vencimento de cada cobrança com vencimento":{"$ref":"#/components/examples/request_patch_lotecobv_calendario_validade_apos_vencimento"},"alteração de devedor de cada cobrança com vencimento":{"$ref":"#/components/examples/request_patch_lotecobv_devedor"},"alteração de identificador de location de cada cobrança com vencimento":{"$ref":"#/components/examples/request_patch_lotecobv_loc_id"},"alteração de valor original cada cobrança com vencimento":{"$ref":"#/components/examples/request_patch_lotecobv_valor_original"},"alteração de multa de cada cobrança com vencimento":{"$ref":"#/components/examples/request_patch_lotecobv_valor_multa"},"alteração de juros de cada cobrança com vencimento":{"$ref":"#/components/examples/request_patch_lotecobv_valor_juros"},"alteração de abatimento de cada cobrança com vencimento":{"$ref":"#/components/examples/request_patch_lotecobv_valor_abatimento"},"alteração de desconto de cada cobrança com vencimento":{"$ref":"#/components/examples/request_patch_lotecobv_valor_desconto"},"alteração de chave de cada cobrança com vencimento":{"$ref":"#/components/examples/request_patch_lotecobv_chave"},"alteração de solicitação pagador de cada cobrança com vencimento":{"$ref":"#/components/examples/request_patch_lotecobv_solicitacao_pagador"},"alteração de informações adicionais de cada cobrança com vencimento":{"$ref":"#/components/examples/request_patch_lotecobv_informacoes_adicionais"},"cancelamento de cada cobrança com vencimento":{"$ref":"#/components/examples/request_patch_lotecobv_status"}}}}},"responses":{"202":{"content":{"application/json":{"examples":{"lote de cobrança com vencimento revisado com sucesso":{"$ref":"#/components/examples/202_lotecobv_patch"}}}},"description":"Lote de cobranças com vencimento revisado com sucesso."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lotecobv_400"}}},"description":"Requisição com formato inválido."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lotecobv_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lotecobv_404"}}},"description":"Recurso solicitado não foi encontrado."},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lotecobv_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."}},"security":[{"APIGatewaySTSAuthorizer":[]}]},"get":{"tags":["Lote de QR Codes com vencimento (COBV)"],"operationId":"get/lotecobv/{id}","description":"API para consultar um lote de QR Codes com vencimento.","parameters":[{"$ref":"#/components/parameters/x-itau-apikey"},{"$ref":"#/components/parameters/x-itau-correlationID"},{"$ref":"#/components/parameters/id-lotecobv"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/loteCobrancaVencimentoIdGetResponse"},"examples":{"lote de cobranças com vencimento consultado":{"$ref":"#/components/examples/200_lotecobv_get_id"}}}},"description":"Consultar lote de cobranças com vencimento."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lotecobv_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lotecobv_404"}}},"description":"Recurso solicitado não foi encontrado."},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lotecobv_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."}},"security":[{"APIGatewaySTSAuthorizer":[]}]}},"/lotecobv":{"get":{"tags":["Lote de QR Codes com vencimento (COBV)"],"operationId":"get/lotecobv","description":"API para consultar uma listagem de lotes de QR Codes com vencimento.","parameters":[{"$ref":"#/components/parameters/x-itau-apikey"},{"$ref":"#/components/parameters/x-itau-correlationID"},{"$ref":"#/components/parameters/inicio"},{"$ref":"#/components/parameters/fim"},{"$ref":"#/components/parameters/paginaAtual"},{"$ref":"#/components/parameters/itensPorPagina"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/loteCobrancaVencimentoGetResponse"},"examples":{"lotes de cobranças com vencimento consultados":{"$ref":"#/components/examples/200_lotecobv_get"}}}},"description":"Lotes de cobranças com vencimento."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."}},"security":[{"APIGatewaySTSAuthorizer":[]}]}},"/loc":{"post":{"tags":["Location"],"operationId":"post/loc","description":"API para criar uma location.","parameters":[{"$ref":"#/components/parameters/x-itau-apikey"},{"$ref":"#/components/parameters/x-itau-correlationID"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/locationPostRequest"},"examples":{"emissão de location de cobrança imediata":{"$ref":"#/components/examples/request_post_loc_cob"},"emissão de location de cobrança com vencimento":{"$ref":"#/components/examples/request_post_loc_cobv"}}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/locationPostResponse"},"examples":{"location de cobrança imediata emitida com sucesso":{"$ref":"#/components/examples/200_loc_cob"},"location de cobrança com vencimento emitida com sucesso":{"$ref":"#/components/examples/200_loc_cobv"}}}},"description":"Location criada com sucesso."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/location_400"}}},"description":"Requisição com formato inválido."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/location_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/location_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."}},"security":[{"APIGatewaySTSAuthorizer":[]}]},"get":{"tags":["Location"],"operationId":"get/loc","description":"API para consultar uma listagem de locations cadastradas.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/locs"},"examples":{"200_Locs":{"$ref":"#/components/examples/200_locs"}}}},"description":"OK","headers":{"Content-Location":{"description":"URI correspondente a pesquisa corrente","schema":{"type":"string"}}}},"204":{"$ref":"#/components/responses/204_get"},"303":{"$ref":"#/components/responses/303_get"},"400":{"$ref":"#/components/responses/400_get"},"401":{"$ref":"#/components/responses/401_get"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"$ref":"#/components/responses/404_get"},"405":{"$ref":"#/components/responses/405_get"},"422":{"$ref":"#/components/responses/422_get"},"428":{"$ref":"#/components/responses/428_get"},"500":{"$ref":"#/components/responses/500_get"},"501":{"$ref":"#/components/responses/501_get"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"504":{"$ref":"#/components/responses/504_get"}},"parameters":[{"in":"query","name":"inicio","required":true,"description":"Data inicial. Respeita RFC 3339.","schema":{"type":"string"}},{"in":"query","name":"fim","required":true,"description":"Data de fim. Respeita RFC 3339.","schema":{"type":"string"}},{"in":"query","name":"txIdPresente","required":false,"description":"Filtro pela existência de txid.","schema":{"type":"boolean"}},{"in":"query","name":"tipoCob","required":false,"description":"Define se o tipo do documento é imediata ou vencimento\n
ENUM
cob
cobv
\n","schema":{"type":"string","enum":["cob","cobv"]}},{"in":"query","name":"paginacao.paginaAtual","required":false,"description":"Numero da Página que deseja realizar o acesso, valor considerado por default 0.","schema":{"type":"integer"}},{"in":"query","name":"paginacao.itensPorPagina","required":false,"description":"Quantidade de ocorrência retornadas por pagina, valor por default 100.","schema":{"type":"integer"}},{"in":"header","name":"x-correlationID","required":false,"description":"Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail","schema":{"type":"string"}}],"security":[{"APIGatewaySTSAuthorizer":[]}]}},"/loc/{id}":{"get":{"tags":["Location"],"operationId":"get/loc/{id}","description":"API para consultar uma location específica através do identificador da location.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/locationIdGetResponse"},"examples":{"200_loc_get_id":{"$ref":"#/components/examples/200_loc_get_id"}}}},"description":"OK","headers":{"Content-Location":{"description":"URI correspondente a pesquisa corrente","schema":{"type":"string"}}}},"204":{"$ref":"#/components/responses/204_get"},"303":{"$ref":"#/components/responses/303_get"},"400":{"$ref":"#/components/responses/400_get"},"401":{"$ref":"#/components/responses/401_get"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_404"}}},"description":"Recurso solicitado não foi encontrado."},"405":{"$ref":"#/components/responses/405_get"},"422":{"$ref":"#/components/responses/422_get"},"428":{"$ref":"#/components/responses/428_get"},"500":{"$ref":"#/components/responses/500_get"},"501":{"$ref":"#/components/responses/501_get"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"504":{"$ref":"#/components/responses/504_get"}},"parameters":[{"in":"path","name":"id","required":true,"description":"id da devolução","schema":{"type":"string"}}],"security":[{"APIGatewaySTSAuthorizer":[]}]}},"/loc/{id}/txid":{"delete":{"tags":["Location"],"operationId":"delete/loc/{id}/txid","description":"API para desvincular um QR Code de uma location.","parameters":[{"$ref":"#/components/parameters/x-itau-apikey"},{"$ref":"#/components/parameters/x-itau-correlationID"},{"$ref":"#/components/parameters/id-loc"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/locationPostResponse"},"examples":{"location de cobrança imediata emitida com sucesso":{"$ref":"#/components/examples/200_loc_cob"},"location de cobrança com vencimento emitida com sucesso":{"$ref":"#/components/examples/200_loc_cobv"}}}},"description":"QR Code desvinculado da location com sucesso."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/location_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/location_404"}}},"description":"Recurso solicitado não foi encontrado."},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/location_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."}},"security":[{"APIGatewaySTSAuthorizer":[]}]}},"/pix/{e2eid}":{"get":{"tags":["Consulta de PIX recebidos e devolução de valores"],"operationId":"get/pix/{e2eid}","description":"API para consultar um Pix recebido, seja QR Code ou transferência Pix, através do identificador do pagamento (e2eid).","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pix"},"examples":{"Cobrança imediata paga":{"$ref":"#/components/examples/200_pix_cobranca_imediata_paga"},"Cobrança saque e pix pago e devolvido":{"$ref":"#/components/examples/200_pix_saque_e_pix_pago_e_devolvido"},"Cobrança troco paga e devolvido":{"$ref":"#/components/examples/200_pix_cobranca_troco_paga_e_devolvido"},"Cobrança com vencimento pago":{"$ref":"#/components/examples/200_pix_cobranca_com_vencimento_pago"}}}},"description":"OK","headers":{"Content-Location":{"description":"URI correspondente a pesquisa corrente","schema":{"type":"string"}}}},"204":{"$ref":"#/components/responses/204_get"},"303":{"$ref":"#/components/responses/303_get"},"400":{"$ref":"#/components/responses/400_get"},"401":{"$ref":"#/components/responses/401_get"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_404"}}},"description":"Recurso solicitado não foi encontrado."},"405":{"$ref":"#/components/responses/405_get"},"422":{"$ref":"#/components/responses/422_get"},"428":{"$ref":"#/components/responses/428_get"},"500":{"$ref":"#/components/responses/500_get"},"501":{"$ref":"#/components/responses/501_get"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"504":{"$ref":"#/components/responses/504_get"}},"parameters":[{"in":"path","name":"e2eid","required":true,"description":"Id fim a fim da transação.","schema":{"type":"string"}}],"security":[{"APIGatewaySTSAuthorizer":[]}]}},"/pix":{"get":{"tags":["Consulta de PIX recebidos e devolução de valores"],"operationId":"get/pix","description":"API para consultar uma listagem de Pix recebidos, seja QR Code ou transferência Pix.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pixs"},"examples":{"Consultas PIX Recebidos e Devolução de valores":{"$ref":"#/components/examples/200_pixs_list"}}}},"description":"OK","headers":{"Content-Location":{"description":"URI correspondente a pesquisa corrente","schema":{"type":"string"}}}},"204":{"$ref":"#/components/responses/204_get"},"303":{"$ref":"#/components/responses/303_get"},"400":{"$ref":"#/components/responses/400_get"},"401":{"$ref":"#/components/responses/401_get"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"$ref":"#/components/responses/404_get"},"405":{"$ref":"#/components/responses/405_get"},"422":{"$ref":"#/components/responses/422_get"},"428":{"$ref":"#/components/responses/428_get"},"500":{"$ref":"#/components/responses/500_get"},"501":{"$ref":"#/components/responses/501_get"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"504":{"$ref":"#/components/responses/504_get"}},"parameters":[{"in":"query","name":"inicio","required":true,"description":"Data inicial. Respeita RFC 3339.","schema":{"type":"string"}},{"in":"query","name":"fim","required":true,"description":"Data de fim. Respeita RFC 3339.","schema":{"type":"string"}},{"in":"query","name":"txid","required":false,"description":"ID de identificação do documento entre os bancos e o cliente emissor. O campo txid é obrigatório e determina o identificador da transação.O objetivo desse campo é ser um elemento que possibilite a conciliação de pagamentos. O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. Deve ser único por CNPJ do recebedor. Apesar de possuir o tamanho de 35 posições (PAC008), para QR Code Estático o tamanho máximo permitido é de 25 posições (limitação EMV). No caso do QR Code dinâmico o campo deve possuir de 26 posição até 35 posições. Os caracteres permitidos no contexto do Pix para o campo txId são:Letras minúsculas, de ‘a’ a ‘z’, Letras maiúsculas, de ‘A’ a ‘Z’, Dígitos decimais, de ‘0’ a ‘9’","schema":{"type":"string"}},{"in":"query","name":"txidPresente","required":false,"description":"Indicador do indentificador da taxa.","schema":{"type":"boolean"}},{"in":"query","name":"devolucaoPresente","required":false,"description":"Indicador de devolução.","schema":{"type":"boolean"}},{"in":"query","name":"cpf","required":false,"description":"CPF do pagador cadastrado na cobrança","schema":{"type":"string"}},{"in":"query","name":"cnpj","required":false,"description":"CNPJ do pagador cadastrado na cobrança.","schema":{"type":"string"}},{"in":"query","name":"paginacao.paginaAtual","required":false,"description":"Numero da Página que deseja realizar o acesso, valor considerado por default 0.","schema":{"type":"integer"}},{"in":"query","name":"paginacao.itensPorPagina","required":false,"description":"Quantidade de ocorrência retornadas por pagina, valor por default 100.","schema":{"type":"integer"}},{"in":"header","name":"x-correlationID","required":false,"description":"Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail","schema":{"type":"string"}}],"security":[{"APIGatewaySTSAuthorizer":[]}]}},"/pix/{e2eid}/devolucao/{id}":{"put":{"tags":["Consulta de PIX recebidos e devolução de valores"],"operationId":"put/pix/{e2eid}/devolucao/{id}","description":"API para solicitar uma devolução através do identificador de pagamento (e2eid) e do identificador da devolução (id).","parameters":[{"$ref":"#/components/parameters/x-itau-apikey"},{"$ref":"#/components/parameters/x-itau-correlationID"},{"$ref":"#/components/parameters/e2eid"},{"$ref":"#/components/parameters/id-devolucao"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/devolucaoPutRequest"},"examples":{"solicitação de devolução com campos mínimos obrigatórios":{"$ref":"#/components/examples/request_put_devolucao_campos_obrigatorios"},"solicitação de devolução com todos os campos":{"$ref":"#/components/examples/request_put_devolucao_completo"}}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/devolucaoPutResponse"},"examples":{"devolução solicitada com sucesso":{"$ref":"#/components/examples/200_devolucao"}}}},"description":"Dados da devolução realizada."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/devolucao_400"}}},"description":"Requisição com formato inválido."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/devolucao_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/devolucao_404"}}},"description":"Recurso solicitado não foi encontrado."},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/devolucao_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."}},"security":[{"APIGatewaySTSAuthorizer":[]}]},"get":{"tags":["Consulta de PIX recebidos e devolução de valores"],"operationId":"get/pix/{e2eid}/devolucao/{id}","description":"API para consultar uma devolução através do identificador de pagamento (e2eid) e do identificador da devolução (id).","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/devolucao"},"examples":{"200_devolucao":{"$ref":"#/components/examples/200_devolucao"}}}},"description":"Ok","headers":{"Content-Location":{"description":"URI correspondente a pesquisa corrente","schema":{"type":"string"}}}},"204":{"$ref":"#/components/responses/204_get"},"303":{"$ref":"#/components/responses/303_get"},"400":{"$ref":"#/components/responses/400_get"},"401":{"$ref":"#/components/responses/401_get"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_404"}}},"description":"Recurso solicitado não foi encontrado."},"405":{"$ref":"#/components/responses/405_get"},"422":{"$ref":"#/components/responses/422_get"},"428":{"$ref":"#/components/responses/428_get"},"500":{"$ref":"#/components/responses/500_get"},"501":{"$ref":"#/components/responses/501_get"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"504":{"$ref":"#/components/responses/504_get"}},"parameters":[{"in":"path","name":"e2eid","required":true,"description":"Id fim a fim da transação.","schema":{"type":"string"}},{"in":"path","name":"id","required":true,"description":"id da devolução","schema":{"type":"string"}}],"security":[{"APIGatewaySTSAuthorizer":[]}]}},"/webhook/{chave}":{"put":{"tags":["Notificações de recebimento via webhook"],"operationId":"put/webhook/{chave}","description":"API para configurar o serviço de notificações via webhook dos QR Codes recebidos e das transferências Pix recebidas via chave Pix para uma chave Pix.\n\n**Observação:** Transferências Pix recebidas com inserção manual (agência e conta) não serão notificadas.\n","responses":{"200":{"description":"OK","headers":{"Content-Location":{"description":"URI correspondente ao item atualziado.","schema":{"type":"string"}}}},"201":{"$ref":"#/components/responses/201_put"},"202":{"$ref":"#/components/responses/202_put"},"204":{"$ref":"#/components/responses/204_put"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_400"}}},"description":"Requisição com formato inválido."},"401":{"$ref":"#/components/responses/401_put"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_404"}}},"description":"Recurso solicitado não foi encontrado."},"405":{"$ref":"#/components/responses/405_put"},"422":{"$ref":"#/components/responses/422_put"},"428":{"$ref":"#/components/responses/428_put"},"500":{"$ref":"#/components/responses/500_put"},"501":{"$ref":"#/components/responses/501_put"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."}},"parameters":[{"in":"path","name":"chave","required":true,"description":"Chave de endereçamento do recebedor","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhookPut"}}}},"security":[{"APIGatewaySTSAuthorizer":[]}]},"get":{"tags":["Notificações de recebimento via webhook"],"operationId":"get/webhook/{chave}","description":"API para consultar o serviço de notificações via webhook de uma chave Pix específica.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook"},"examples":{"200_webhook":{"$ref":"#/components/examples/200_webhook"}}}},"description":"OK","headers":{"Content-Location":{"description":"URI correspondente a pesquisa corrente","schema":{"type":"string"}}}},"204":{"$ref":"#/components/responses/204_get"},"303":{"$ref":"#/components/responses/303_get"},"400":{"$ref":"#/components/responses/400_get"},"401":{"$ref":"#/components/responses/401_get"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_404"}}},"description":"Recurso solicitado não foi encontrado."},"405":{"$ref":"#/components/responses/405_get"},"422":{"$ref":"#/components/responses/422_get"},"428":{"$ref":"#/components/responses/428_get"},"500":{"$ref":"#/components/responses/500_get"},"501":{"$ref":"#/components/responses/501_get"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"504":{"$ref":"#/components/responses/504_get"}},"parameters":[{"in":"path","name":"chave","required":true,"description":"Chave de endereçamento do recebedor","schema":{"type":"string"}}],"security":[{"APIGatewaySTSAuthorizer":[]}]},"delete":{"tags":["Notificações de recebimento via webhook"],"operationId":"delete/webhook/{chave}","description":"API para excluir uma o serviço de notificação de recebimento de chave Pix via webhook.","responses":{"200":{"$ref":"#/components/responses/200_delete"},"202":{"$ref":"#/components/responses/202_delete"},"204":{"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_400"}}},"description":"Requisição com formato inválido."},"401":{"$ref":"#/components/responses/401_delete"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_404"}}},"description":"Recurso solicitado não foi encontrado."},"405":{"$ref":"#/components/responses/405_delete"},"422":{"$ref":"#/components/responses/422_delete"},"428":{"$ref":"#/components/responses/428_delete"},"500":{"$ref":"#/components/responses/500_delete"},"501":{"$ref":"#/components/responses/501_delete"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"504":{"$ref":"#/components/responses/504_delete"}},"parameters":[{"in":"path","name":"chave","required":true,"description":"Chave de endereçamento do recebedor","schema":{"type":"string"}}],"security":[{"APIGatewaySTSAuthorizer":[]}]}},"/webhook":{"get":{"tags":["Notificações de recebimento via webhook"],"operationId":"get/webhook","description":"API para consultar a listagem dos serviço de notificações via webhook cadastrados.","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks"},"examples":{"200_webhooks":{"$ref":"#/components/examples/200_webhooks"}}}},"description":"OK","headers":{"Content-Location":{"description":"URI correspondente a pesquisa corrente","schema":{"type":"string"}}}},"204":{"$ref":"#/components/responses/204_get"},"303":{"$ref":"#/components/responses/303_get"},"400":{"$ref":"#/components/responses/400_get"},"401":{"$ref":"#/components/responses/401_get"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_403"}}},"description":"Requisição de participante autenticado que viola alguma regra de autorização."},"404":{"$ref":"#/components/responses/404_get"},"405":{"$ref":"#/components/responses/405_get"},"422":{"$ref":"#/components/responses/422_get"},"428":{"$ref":"#/components/responses/428_get"},"500":{"$ref":"#/components/responses/500_get"},"501":{"$ref":"#/components/responses/501_get"},"503":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cobrancaVencimento_503"}}},"description":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"504":{"$ref":"#/components/responses/504_get"}},"parameters":[{"in":"query","name":"inicio","required":false,"description":"Data de inicio da pesquisa de webhooks, no formato de acordo com RFC3339","schema":{"type":"string"}},{"in":"query","name":"fim","required":false,"description":"Data fim da pesquisa de webhooks, no formato de acordo com RFC3339","schema":{"type":"string"}},{"in":"query","name":"paginacao.paginaAtual","required":false,"description":"Numero da Página que deseja realizar o acesso, valor considerado por default 0","schema":{"type":"integer"}},{"in":"query","name":"paginacao.itensPorPagina","required":false,"description":"Quantidade de ocorrência retornadas por pagina, valor por default 100","schema":{"type":"integer"}},{"in":"header","name":"x-correlationID","required":false,"description":"Identificador de correlação que serve como um agrupar dentro da estrutura de audit trail","schema":{"type":"string"}}],"security":[{"APIGatewaySTSAuthorizer":[]}]}}},"components":{"parameters":{"x-itau-apikey":{"name":"x-itau-apikey","in":"header","description":"**Descrição:** Chave da API utilizado para autorizar o consumo de uma aplicação requisitante.\n\n**RegEx:** `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`\n","required":true,"schema":{"type":"string"},"example":"96decebf-5c47-4410-95bf-0c4b803e4bb2"},"x-itau-correlationID":{"name":"x-itau-correlationID","in":"header","description":"**Descrição:** Identificador de correlação que serve como um agrupador dentro da estrutura de audit trail.\n\n**RegEx:** `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$`\n","required":false,"schema":{"type":"string"},"example":"bc4d8712-904a-47af-a3a0-63751ddb7e56"},"txid":{"name":"txid","in":"path","description":"**Descrição:** Identificador do QR Code que possibilita a conciliação de pagamentos.\n\n**Observação:** Este código deve possuir entre 26 e 35 posições, podendo conter letras minúsculas (a-z), letras maiúsculas (A-Z) e números (0-9).\n","required":true,"schema":{"type":"string"},"example":"88ba8ec675e044178d434908d9b2a30a"},"id-loc":{"name":"id","in":"path","description":"**Descrição:** Identificador da location.\n","required":true,"schema":{"type":"string"},"example":2316},"id-lotecobv":{"name":"id","in":"path","description":"**Descrição:** Identificador da lotecobv.\n","required":true,"schema":{"type":"string"},"example":12},"inicio":{"name":"inicio","in":"query","description":"**Descrição:** Data inicial.\n\n**Observação:** Respeita RFC 3339.\n","required":true,"schema":{"type":"string"},"example":"2023-01-01T00:00:00.000Z"},"fim":{"name":"fim","in":"query","description":"**Descrição:** Data de fim.\n\n**Observação:** Respeita RFC 3339.\n","required":true,"schema":{"type":"string"},"example":"2023-12-01T23:59:59.000Z"},"paginaAtual":{"name":"paginacao.paginaAtual","in":"query","description":"**Descrição:** Numero da Página que deseja realizar o acesso.\n\n**Observação:** Valor considerado por default 0.\n","required":false,"schema":{"type":"integer"},"example":0},"itensPorPagina":{"name":"paginacao.itensPorPagina","in":"query","description":"**Descrição:** Quantidade de ocorrência retornadas por pagina.\n\n**Observação:** valor por default 100.\n","required":false,"schema":{"type":"integer"},"example":100},"e2eid":{"name":"e2eid","in":"path","description":"**Descrição:** Identificador fim a fim da transação.\n","required":true,"schema":{"type":"string"}},"id-devolucao":{"name":"id","in":"path","description":"**Descrição:** Identificador da devolução.\n","required":true,"schema":{"type":"string"}}},"examples":{"request_post_cobranca_imediata_campos_obrigatorios":{"description":"","value":{"valor":{"original":"123.45"},"chave":"60701190000104"}},"request_post_cobranca_imediata_completo":{"description":"","value":{"calendario":{"expiracao":3600},"devedor":{"cnpj":"12345678000195","nome":"Empresa de Serviços SA"},"loc":{"id":"1234567890123456789"},"valor":{"original":"123.45","modalidadeAlteracao":1},"chave":"60701190000104","solicitacaoPagador":"Informar cartão fidelidade","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}]}},"request_post_cobranca_imediata_saque_campos_obrigatorios":{"description":"","value":{"valor":{"original":"0.00","retirada":{"saque":{"valor":"5.00","modalidadeAgente":"AGPSS","prestadorDoServicoDeSaque":"12345678"}}},"chave":"7d9f0335-8dcc-4054-9bf9-0dbd61d36906"}},"request_post_cobranca_imediata_saque_completo":{"description":"","value":{"calendario":{"expiracao":3600},"devedor":{"cnpj":"12345678000195","nome":"Empresa de Serviços SA"},"loc":{"id":1234567890123456800},"valor":{"original":"0.00","modalidadeAlteracao":0,"retirada":{"saque":{"valor":"5.00","modalidadeAlteracao":0,"modalidadeAgente":"AGPSS","prestadorDoServicoDeSaque":"12345678"}}},"chave":"7d9f0335-8dcc-4054-9bf9-0dbd61d36906","solicitacaoPagador":"Informar cartão fidelidade","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}]}},"request_post_cobranca_imediata_troco_campos_obrigatorios":{"description":"","value":{"valor":{"original":"10.00","retirada":{"troco":{"valor":"5.00","modalidadeAgente":"AGTEC","prestadorDoServicoDeSaque":"12345678"}}},"chave":"7d9f0335-8dcc-4054-9bf9-0dbd61d36906"}},"request_post_cobranca_imediata_troco_completo":{"description":"","value":{"calendario":{"expiracao":3600},"devedor":{"cnpj":"12345678000195","nome":"Empresa de Serviços SA"},"loc":{"id":1234567890123456800},"valor":{"original":"10.00","modalidadeAlteracao":0,"retirada":{"troco":{"valor":"5.00","modalidadeAlteracao":0,"modalidadeAgente":"AGTEC","prestadorDoServicoDeSaque":"12345678"}}},"chave":"7d9f0335-8dcc-4054-9bf9-0dbd61d36906","solicitacaoPagador":"Informar cartão fidelidade","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}]}},"request_put_cobranca_imediata_campos_obrigatorios":{"description":"","value":{"valor":{"original":"123.45"},"chave":"60701190000104"}},"request_put_cobranca_imediata_completo":{"description":"","value":{"calendario":{"expiracao":3600},"devedor":{"cnpj":"12345678000195","nome":"Empresa de Serviços SA"},"loc":{"id":"1234567890123456789"},"valor":{"original":"123.45","modalidadeAlteracao":1},"chave":"60701190000104","solicitacaoPagador":"Informar cartão fidelidade","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}]}},"request_patch_cobranca_imediata_completo":{"description":"","value":{"calendario":{"expiracao":5350},"devedor":{"cnpj":"12345678000195","nome":"Empresa de Serviços SA"},"loc":{"id":7768},"status":"ATIVA","valor":{"original":"200.00","modalidadeAlteracao":1},"chave":"a1f4102e-a446-4a57-bcce-6fa48899c1d1","solicitacaoPagador":"O que achou do serviço realizado?","infoAdicionais":[{"nome":"Campo","valor":"Informação Adicional do PSP Recebedor"}]}},"request_patch_cobranca_imediata_valor_original":{"description":"","value":{"valor":{"original":"200.00"}}},"request_patch_cobranca_imediata_modalidade_alteracao":{"description":"","value":{"valor":{"modalidadeAlteracao":1}}},"request_patch_cobranca_imediata_devedor":{"description":"","value":{"devedor":{"cpf":"48701715119","nome":"Devedor Automatizado"}}},"request_patch_cobranca_imediata_loc_id":{"description":"","value":{"loc":{"id":"7242957035641866946"}}},"request_patch_cobranca_imediata_calendario_expiracao":{"description":"","value":{"calendario":{"expiracao":3600}}},"request_patch_cobranca_imediata_chave":{"description":"","value":{"chave":"2ef1b22e-9905-432a-9e8b-5b88039fe07c"}},"request_patch_cobranca_imediata_solicitacao_pagador":{"description":"","value":{"solicitacaoPagador":"Cobrança pelos serviços prestados"}},"request_patch_cobranca_imediata_informacoes_adicionais":{"description":"","value":{"infoAdicionais":{"nome":"Identificador Adicional","valor":"7c376651-8a49-4e4a-bb78-b74b941d8462"}}},"request_patch_cobranca_imediata_status":{"description":"","value":{"status":"REMOVIDA_PELO_USUARIO_RECEBEDOR"}},"request_put_cobranca_vencimento_campos_obrigatorios":{"description":"","value":{"calendario":{"dataDeVencimento":"2023-12-31"},"devedor":{"cpf":"12345678909","nome":"Francisco da Silva"},"valor":{"original":"22.50"},"chave":"5f84a4c5-c5cb-4599-9f13-7eb4d419dacc"}},"request_put_cobranca_vencimento_completo":{"description":"","value":{"calendario":{"dataDeVencimento":"2023-12-31","validadeAposVencimento":30},"loc":{"id":789},"devedor":{"logradouro":"Alameda Souza, Numero 80, Bairro Braz","cidade":"Recife","uf":"PE","cep":"70011750","cpf":"12345678909","nome":"Francisco da Silva"},"valor":{"original":"123.45","multa":{"modalidade":2,"valorPerc":"15.00"},"juros":{"modalidade":2,"valorPerc":"2.00"},"abatimento":{"modalidade":1,"valorPerc":"1.00"},"desconto":{"modalidade":1,"descontoDataFixa":[{"data":"2023-11-30","valorPerc":"30.00"}]}},"chave":"5f84a4c5-c5cb-4599-9f13-7eb4d419dacc","solicitacaoPagador":"Cobrança dos serviços prestados.","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}]}},"request_patch_cobranca_vencimento_completo":{"description":"","value":{"loc":{"id":7768},"devedor":{"logradouro":"Alameda Souza, Numero 80, Bairro Braz","cidade":"Recife","uf":"PE","cep":"70011750","cpf":"12345678909","nome":"Francisco da Silva"},"valor":{"original":"123.45"},"solicitacaoPagador":"Cobrança dos serviços prestados."}},"request_patch_cobranca_vencimento_valor_original":{"description":"","value":{"valor":{"original":"100.00"}}},"request_patch_cobranca_vencimento_valor_multa":{"description":"","value":{"valor":{"multa":{"modalidade":1,"valorPerc":"5.00"}}}},"request_patch_cobranca_vencimento_valor_juros":{"description":"","value":{"valor":{"juros":{"modalidade":1,"valorPerc":"2.00"}}}},"request_patch_cobranca_vencimento_valor_abatimento":{"description":"","value":{"valor":{"abatimento":{"modalidade":1,"valorPerc":"1.00"}}}},"request_patch_cobranca_vencimento_valor_desconto":{"description":"","value":{"valor":{"desconto":{"modalidade":1,"valorPerc":"5.00"}}}},"request_patch_cobranca_vencimento_informacoes_adicionais":{"description":"","value":{"infoAdicionais":{"nome":"Identificador da Cobrança","valor":"3cfce744-bdbd-494a-84f1-3ae72050baed"}}},"request_patch_cobranca_vencimento_calendario_data_de_vencimento":{"description":"","value":{"calendario":{"dataDeVencimento":"2023-07-15"}}},"request_patch_cobranca_vencimento_calendario_validade_apos_vencimento":{"description":"","value":{"calendario":{"dataDeVencimento":"2023-07-15","validadeAposVencimento":60}}},"request_patch_cobranca_vencimento_devedor":{"description":"","value":{"devedor":{"logradouro":"Avenida Brasil 1","cidade":"Feira Nova do Maranhão","uf":"MA","cep":"65995970","cpf":"40103693025","nome":"Gustavo Santos"}}},"request_patch_cobranca_vencimento_loc_id":{"description":"","value":{"loc":{"id":"4579004078401780859"}}},"request_patch_cobranca_vencimento_chave":{"description":"","value":{"chave":"3cfce744-bdbd-494a-84f1-3ae72050baed"}},"request_patch_cobranca_vencimento_solicitacao_pagador":{"description":"","value":{"solicitacaoPagador":"Cobrança pelos serviços prestados"}},"request_patch_cobranca_vencimento_status":{"description":"","value":{"status":"REMOVIDA_PELO_USUARIO_RECEBEDOR"}},"request_post_loc_cob":{"description":"","value":{"tipoCob":"cob"}},"request_post_loc_cobv":{"description":"","value":{"tipoCob":"cobv"}},"request_put_lotecobv_campos_obrigatorios":{"description":"","value":{"descricao":"Cobranças dos alunos do turno vespertino","cobsv":[{"calendario":{"dataDeVencimento":"2023-12-31"},"txid":"fb2761260e554ad593c7226beb5cb650","devedor":{"cpf":"08577095428","nome":"João Souza"},"valor":{"original":"100.00"},"chave":"7c084cd4-54af-4172-a516-a7d1a12b75cc"},{"calendario":{"dataDeVencimento":"2023-12-31"},"txid":"7978c0c97ea847e78e8849634473c1f1","devedor":{"cpf":"15311295449","nome":"Manoel Silva"},"valor":{"original":"100.00"},"chave":"7c084cd4-54af-4172-a516-a7d1a12b75cc"}]}},"request_put_lotecobv_completo":{"description":"","value":{"descricao":"Cobranças dos alunos do turno vespertino","cobsv":[{"calendario":{"dataDeVencimento":"2023-12-31","validadeAposVencimento":30},"txid":"fb2761260e554ad593c7226beb5cb650","loc":{"id":789},"devedor":{"email":"email@mail.com","logradouro":"Alameda Souza, Numero 80, Bairro Braz","cidade":"Recife","uf":"PE","cep":"70011750","cpf":"08577095428","nome":"João Souza"},"valor":{"original":"100.00","multa":{"modalidade":2,"valorPerc":"15.00"},"juros":{"modalidade":2,"valorPerc":"2.00"},"abatimento":{"modalidade":1,"valorPerc":"1.00"},"desconto":{"modalidade":1,"descontoDataFixa":[{"data":"2023-11-30","valorPerc":"30.00"}]}},"chave":"7c084cd4-54af-4172-a516-a7d1a12b75cc","solicitacaoPagador":"Informar matrícula","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}]},{"calendario":{"dataDeVencimento":"2023-12-31","validadeAposVencimento":30},"txid":"7978c0c97ea847e78e8849634473c1f1","loc":{"id":57221},"devedor":{"email":"email@mail.com","logradouro":"Rua 15, Numero 1, Bairro Campo Grande","cidade":"Recife","uf":"PE","cep":"70055751","cpf":"15311295449","nome":"Manoel Silva"},"valor":{"original":"100.00","multa":{"modalidade":2,"valorPerc":"15.00"},"juros":{"modalidade":2,"valorPerc":"2.00"},"abatimento":{"modalidade":1,"valorPerc":"1.00"},"desconto":{"modalidade":1,"descontoDataFixa":[{"data":"2023-11-30","valorPerc":"30.00"}]}},"chave":"7c084cd4-54af-4172-a516-a7d1a12b75cc","solicitacaoPagador":"Informar matrícula","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}]}]}},"request_patch_lotecobv_descricao":{"description":"","value":{"descricao":"Cobranças dos alunos do turno matutino"}},"request_patch_lotecobv_calendario_data_de_vencimento":{"description":"","value":{"descricao":"Cobranças dos alunos do turno vespertino","cobsv":[{"calendario":{"dataDeVencimento":"2023-10-15"},"txid":"fb2761260e554ad593c7226beb5cb650"},{"calendario":{"dataDeVencimento":"2023-10-15"},"txid":"7978c0c97ea847e78e8849634473c1f1"}]}},"request_patch_lotecobv_calendario_validade_apos_vencimento":{"description":"","value":{"descricao":"Cobranças dos alunos do turno vespertino","cobsv":[{"calendario":{"dataDeVencimento":"2023-10-15","validadeAposVencimento":60},"txid":"fb2761260e554ad593c7226beb5cb650"},{"calendario":{"dataDeVencimento":"2023-10-15","validadeAposVencimento":60},"txid":"7978c0c97ea847e78e8849634473c1f1"}]}},"request_patch_lotecobv_devedor":{"description":"","value":{"descricao":"Cobranças dos alunos do turno vespertino","cobsv":[{"txid":"fb2761260e554ad593c7226beb5cb650","devedor":{"email":"email@mail.com","logradouro":"Rua Manuel Antônio Carvalho, Número 120, Vila Clarice","cidade":"São Paulo","uf":"SP","cep":"05177120","cpf":"59264431802","nome":"Rafael Martins"}},{"txid":"7978c0c97ea847e78e8849634473c1f1","devedor":{"email":"email@mail.com","logradouro":"Rua Jardim Botânico, Número 12, Residências do Vale","cidade":"Resende","uf":"RJ","cep":"27521645","cpf":"62275079700","nome":"Julia Souza"}}]}},"request_patch_lotecobv_loc_id":{"description":"","value":{"descricao":"Cobranças dos alunos do turno vespertino","cobsv":[{"txid":"fb2761260e554ad593c7226beb5cb650","loc":{"id":1457823}},{"txid":"7978c0c97ea847e78e8849634473c1f1","loc":{"id":1457824}}]}},"request_patch_lotecobv_status":{"description":"","value":{"descricao":"Cobranças dos alunos do turno vespertino","cobsv":[{"txid":"fb2761260e554ad593c7226beb5cb650","status":"REMOVIDA_PELO_USUARIO_RECEBEDOR"},{"txid":"7978c0c97ea847e78e8849634473c1f1","status":"REMOVIDA_PELO_USUARIO_RECEBEDOR"}]}},"request_patch_lotecobv_valor_original":{"description":"","value":{"descricao":"Cobranças dos alunos do turno vespertino","cobsv":[{"txid":"fb2761260e554ad593c7226beb5cb650","valor":{"original":"10.00"}},{"txid":"7978c0c97ea847e78e8849634473c1f1","valor":{"original":"10.00"}}]}},"request_patch_lotecobv_valor_multa":{"description":"","value":{"descricao":"Cobranças dos alunos do turno vespertino","cobsv":[{"txid":"fb2761260e554ad593c7226beb5cb650","valor":{"original":"10.00","multa":{"modalidade":1,"valorPerc":"2.00"}}},{"txid":"7978c0c97ea847e78e8849634473c1f1","valor":{"original":"10.00","multa":{"modalidade":1,"valorPerc":"2.00"}}}]}},"request_patch_lotecobv_valor_juros":{"description":"","value":{"descricao":"Cobranças dos alunos do turno vespertino","cobsv":[{"txid":"fb2761260e554ad593c7226beb5cb650","valor":{"original":"10.00","juros":{"modalidade":1,"valorPerc":"2.00"}}},{"txid":"7978c0c97ea847e78e8849634473c1f1","valor":{"original":"10.00","juros":{"modalidade":1,"valorPerc":"2.00"}}}]}},"request_patch_lotecobv_valor_abatimento":{"description":"","value":{"descricao":"Cobranças dos alunos do turno vespertino","cobsv":[{"txid":"fb2761260e554ad593c7226beb5cb650","valor":{"original":"10.00","abatimento":{"modalidade":1,"valorPerc":"2.00"}}},{"txid":"7978c0c97ea847e78e8849634473c1f1","valor":{"original":"10.00","abatimento":{"modalidade":1,"valorPerc":"2.00"}}}]}},"request_patch_lotecobv_valor_desconto":{"description":"","value":{"descricao":"Cobranças dos alunos do turno vespertino","cobsv":[{"txid":"fb2761260e554ad593c7226beb5cb650","valor":{"original":"10.00","desconto":{"modalidade":1,"valorPerc":"2.00"}}},{"txid":"7978c0c97ea847e78e8849634473c1f1","valor":{"original":"10.00","desconto":{"modalidade":1,"valorPerc":"2.00"}}}]}},"request_patch_lotecobv_chave":{"description":"","value":{"descricao":"Cobranças dos alunos do turno vespertino","cobsv":[{"txid":"fb2761260e554ad593c7226beb5cb650","chave":"5f84a4c5-c5cb-4599-9f13-7eb4d419dacc"},{"txid":"7978c0c97ea847e78e8849634473c1f1","chave":"5f84a4c5-c5cb-4599-9f13-7eb4d419dacc"}]}},"request_patch_lotecobv_solicitacao_pagador":{"description":"","value":{"descricao":"Cobranças dos alunos do turno vespertino","cobsv":[{"txid":"fb2761260e554ad593c7226beb5cb650","solicitacaoPagador":"Cobrança pelos serviços prestados"},{"txid":"7978c0c97ea847e78e8849634473c1f1","solicitacaoPagador":"Cobrança pelos serviços prestados"}]}},"request_patch_lotecobv_informacoes_adicionais":{"description":"","value":{"descricao":"Cobranças dos alunos do turno vespertino","cobsv":[{"txid":"fb2761260e554ad593c7226beb5cb650","infoAdicionais":{"nome":"Identificador da Cobrança","valor":"3cfce744-bdbd-494a-84f1-3ae72050baed"}},{"txid":"7978c0c97ea847e78e8849634473c1f1","infoAdicionais":{"nome":"Identificador da Cobrança","valor":"3cfce744-bdbd-494a-84f1-3ae720504756"}}]}},"request_patch_lotecobv_completo":{"description":"","value":{"descricao":"Cobranças dos alunos do turno vespertino","cobsv":[{"calendario":{"dataDeVencimento":"2023-12-31","validadeAposVencimento":30},"txid":"fb2761260e554ad593c7226beb5cb650","loc":{"id":789},"devedor":{"email":"email@mail.com","logradouro":"Alameda Souza, Numero 80, Bairro Braz","cidade":"Recife","uf":"PE","cep":"70011750","cpf":"08577095428","nome":"João Souza"},"valor":{"original":"100.00","multa":{"modalidade":2,"valorPerc":"15.00"},"juros":{"modalidade":2,"valorPerc":"2.00"},"abatimento":{"modalidade":1,"valorPerc":"1.00"},"desconto":{"modalidade":1,"descontoDataFixa":[{"data":"2023-11-30","valorPerc":"30.00"}]}},"chave":"7c084cd4-54af-4172-a516-a7d1a12b75cc","solicitacaoPagador":"Informar matrícula","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}]},{"calendario":{"dataDeVencimento":"2023-12-31","validadeAposVencimento":30},"txid":"7978c0c97ea847e78e8849634473c1f1","loc":{"id":57221},"devedor":{"email":"email@mail.com","logradouro":"Rua 15, Numero 1, Bairro Campo Grande","cidade":"Recife","uf":"PE","cep":"70055751","cpf":"15311295449","nome":"Manoel Silva"},"valor":{"original":"100.00","multa":{"modalidade":2,"valorPerc":"15.00"},"juros":{"modalidade":2,"valorPerc":"2.00"},"abatimento":{"modalidade":1,"valorPerc":"1.00"},"desconto":{"modalidade":1,"descontoDataFixa":[{"data":"2023-11-30","valorPerc":"30.00"}]}},"chave":"7c084cd4-54af-4172-a516-a7d1a12b75cc","solicitacaoPagador":"Informar matrícula","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}]}]}},"request_put_devolucao_campos_obrigatorios":{"description":"","value":{"valor":"100.00"}},"request_put_devolucao_completo":{"description":"","value":{"valor":"100.00","natureza":"RETIRADA","descricao":"Devolução integral do pagamento"}},"response_200_consulta_cobranca_imediata_list":{"value":{"value":{"parametros":{"inicio":"2020-04-01T00:00:00Z","fim":"2020-04-02T10:00:00Z","paginacao":{"paginaAtual":0,"itensPorPagina":100,"quantidadeDePaginas":1,"quantidadeTotalDeItens":2}},"cobs":[{"calendario":{"criacao":"2023-01-01T00:00:00Z","expiracao":3600},"devedor":{"cnpj":"12345678000195","nome":"Empresa de Serviços SA"},"loc":{"id":"1234567890123456789","location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-01-01T00:00:00Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","valor":{"original":"123.45","modalidadeAlteracao":1},"chave":"60701190000104","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"status":"ATIVA","pixCopiaECola":"00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925Empresa de Serviços SA62070503***6304D56E","solicitacaoPagador":"Informar cartão fidelidade","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}]},{"calendario":{"criacao":"2023-01-01T00:00:00Z","expiracao":3600},"devedor":{"cnpj":"12345678000195","nome":"Empresa de Serviços SA"},"loc":{"id":"1234567890123456789","location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-01-01T00:00:00Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","valor":{"original":"123.45","modalidadeAlteracao":0},"chave":"60701190000104","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"status":"CONCLUIDA","pixCopiaECola":"00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925Empresa de Serviços SA6009SAO PAULO62070503***6304D56E","solicitacaoPagador":"Informar cartão fidelidade","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}],"pix":{"endToEndId":"E60701190202207240459DY5GKNGX7B4","txid":"7978c0c97ea847e78e8849634473c1f1","valor":"123.45","horario":"2023-01-01T00:00:00Z","componentesValor":{"original":{"valor":"123.45"}},"devolucoes":{"id":"D6070119020221201142431749005800","rtrId":"D6070119020221201142431749005800","valor":"123.45","horario":{"solicitacao":"2023-01-01T00:00:00Z","liquidacao":"2023-01-01T00:00:00Z"},"status":"DEVOLVIDO","natureza":"ORIGINAL"}}},{"calendario":{"criacao":"2023-07-12T16:36:07Z","expiracao":3600},"devedor":{"cnpj":"12345678000195","nome":"Empresa de Serviços SA"},"loc":{"id":"1234567890123456789","location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-07-12T16:36:08Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","valor":{"original":"123.45","modalidadeAlteracao":0,"retirada":{"saque":{"valor":"123.45","modalidadeAlteracao":0,"modalidadeAgente":"AGPSS","prestadorDoServicoDeSaque":"12345678"}}},"chave":"7d9f0335-8dcc-4054-9bf9-0dbd61d36906","solicitacaoPagador":"Informar cartão fidelidade","txid":"squadpixsaque000000000000000069","revisao":0,"status":"ATIVA","pixCopiaECola":"'00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925Empresa de Serviços SA6009SAO PAULO62070503***6304D56E'","infoAdicionais":[{"nome":"Campo 2","valor":"Informação Adicional 2"},{"nome":"Campo 1","valor":"Informação Adicional 1"}]},{"calendario":{"criacao":"2023-01-01T00:00:00Z","expiracao":3600},"devedor":{"cnpj":"12345678000195","nome":"Empresa de Serviços SA"},"loc":{"id":"1234567890123456789","location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-01-01T00:00:00Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","valor":{"original":"123.45","modalidadeAlteracao":0,"retirada":{"saque":{"valor":"123.45","modalidadeAlteracao":0,"modalidadeAgente":"AGPSS","prestadorDoServicoDeSaque":"12345678"}}},"chave":"60701190000104","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"status":"CONCLUIDA","pixCopiaECola":"00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925Empresa de Serviços SA6009SAO PAULO62070503***6304D56E","solicitacaoPagador":"Informar cartão fidelidade","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}],"pix":{"endToEndId":"E60701190202207240459DY5GKNGX7B4","txid":"7978c0c97ea847e78e8849634473c1f1","valor":"123.45","horario":"2023-01-01T00:00:00Z","componentesValor":{"original":{"valor":"123.45"}},"devolucoes":{"id":"D6070119020221201142431749005800","rtrId":"D6070119020221201142431749005800","valor":"123.45","horario":{"solicitacao":"2023-01-01T00:00:00Z","liquidacao":"2023-01-01T00:00:00Z"},"status":"DEVOLVIDO","natureza":"ORIGINAL"}}},{"calendario":{"criacao":"2023-01-01T00:00:00Z","expiracao":3600},"status":"ATIVA","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"loc":{"id":"1234567890123456789","location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-01-01T00:00:00Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","devedor":{"cnpj":"12345678000195","nome":"PMD HOBISSOM EDERLAN EINS"},"valor":{"original":"123.45","modalidadeAlteracao":0,"retirada":{"troco":{"valor":"123.45","modalidadeAlteracao":0,"modalidadeAgente":"AGTEC","prestadorDoServicoDeSaque":"12345678"}}},"chave":"7d9f0335-8dcc-4054-9bf9-0dbd61d36906","solicitacaoPagador":"Informar cartão fidelidade","pixCopiaECola":"00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925PMD HOBISSOM EDERLAN EINS6009SAO PAULO62070503***6304D56E","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}]},{"calendario":{"criacao":"2023-01-01T00:00:00Z","expiracao":3600},"devedor":{"cnpj":"12345678000195","nome":"PMD HOBISSOM EDERLAN EINS"},"loc":{"id":"1234567890123456789","location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-05-24T14:42:00Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","valor":{"original":"10.00","modalidadeAlteracao":0,"retirada":{"troco":{"valor":"5.00","modalidadeAlteracao":0,"modalidadeAgente":"AGTEC","prestadorDoServicoDeSaque":"12345678"}}},"chave":"a1f4102e-a446-4a57-bcce-6fa48899c1d1","solicitacaoPagador":"Informar cartão fidelidade","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":1,"status":"REMOVIDA_PELO_USUARIO_RECEBEDOR","pixCopiaECola":"00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925PMD HOBISSOM EDERLAN EINS6009SAO PAULO62070503***6304D56E","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}]}]},"description":""},"description":""},"response_200_consulta_cobranca_imediata_ativa_by_txid":{"description":"","value":{"calendario":{"criacao":"2023-01-01T00:00:00Z","expiracao":86400},"devedor":{"cnpj":"12345678000195","nome":"Empresa de Serviços SA"},"loc":{"id":"1234567890123456789","location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-01-01T00:00:00Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","valor":{"original":"123.45","modalidadeAlteracao":1},"chave":"60701190000104","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"status":"ATIVA","pixCopiaECola":"00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925Empresa de Serviços SA62070503***6304D56E","solicitacaoPagador":"Informar cartão fidelidade","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}]}},"response_200_consulta_cobranca_imediata_paga_e_devolvida_by_txid":{"description":"","value":{"calendario":{"criacao":"2023-01-01T00:00:00Z","expiracao":86400},"devedor":{"cnpj":"12345678000195","nome":"Empresa de Serviços SA"},"loc":{"id":"1234567890123456789","location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-01-01T00:00:00Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","valor":{"original":"123.45","modalidadeAlteracao":0},"chave":"60701190000104","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"status":"CONCLUIDA","pixCopiaECola":"00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925Empresa de Serviços SA6009SAO PAULO62070503***6304D56E","solicitacaoPagador":"Informar cartão fidelidade","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}],"pix":{"endToEndId":"E60701190202207240459DY5GKNGX7B4","txid":"7978c0c97ea847e78e8849634473c1f1","valor":"123.45","horario":"2023-01-01T00:00:00Z","componentesValor":{"original":{"valor":"123.45"}},"devolucoes":{"id":"D6070119020221201142431749005800","rtrId":"D6070119020221201142431749005800","valor":"123.45","horario":{"solicitacao":"2023-01-01T00:00:00Z","liquidacao":"2023-01-01T00:00:00Z"},"status":"DEVOLVIDO","natureza":"ORIGINAL"}}}},"response_200_consulta_cobranca_saque_pix_ativo":{"value":{"value":{"calendario":{"criacao":"2023-07-12T16:36:07Z","expiracao":86400},"devedor":{"cnpj":"12345678000195","nome":"Empresa de Serviços SA"},"loc":{"id":"1234567890123456789","location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-07-12T16:36:08Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","valor":{"original":"123.45","modalidadeAlteracao":0,"retirada":{"saque":{"valor":"123.45","modalidadeAlteracao":0,"modalidadeAgente":"AGPSS","prestadorDoServicoDeSaque":"12345678"}}},"chave":"7d9f0335-8dcc-4054-9bf9-0dbd61d36906","solicitacaoPagador":"Cobrança dos serviços prestados.","txid":"7d9f0335-8dcc-4054-9bf9-0dbd61d36906","revisao":0,"status":"ATIVA","pixCopiaECola":"'00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925Empresa de Serviços SA6009SAO PAULO62070503***6304D56E'","infoAdicionais":[{"nome":"Campo 2","valor":"Informação Adicional 2"},{"nome":"Campo 1","valor":"Informação Adicional 1"}],"description":""}},"description":""},"response_200_consulta_cobranca_saque_pix_paga_e_devolvido":{"description":"","value":{"calendario":{"criacao":"2023-01-01T00:00:00Z","expiracao":86400},"devedor":{"cnpj":"12345678000195","nome":"Empresa de Serviços SA"},"loc":{"id":"1234567890123456789","location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-01-01T00:00:00Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","valor":{"original":"123.45","modalidadeAlteracao":0,"retirada":{"saque":{"valor":"123.45","modalidadeAlteracao":0,"modalidadeAgente":"AGPSS","prestadorDoServicoDeSaque":"12345678"}}},"chave":"7d9f0335-8dcc-4054-9bf9-0dbd61d36906","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"status":"CONCLUIDA","pixCopiaECola":"00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925Empresa de Serviços SA6009SAO PAULO62070503***6304D56E","solicitacaoPagador":"Informar cartão fidelidade","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}],"pix":{"endToEndId":"E60701190202207240459DY5GKNGX7B4","txid":"7978c0c97ea847e78e8849634473c1f1","valor":"123.45","horario":"2023-01-01T00:00:00Z","componentesValor":{"original":{"valor":"123.45"}},"devolucoes":{"id":"D6070119020221201142431749005800","rtrId":"D6070119020221201142431749005800","valor":"123.45","horario":{"solicitacao":"2023-01-01T00:00:00Z","liquidacao":"2023-01-01T00:00:00Z"},"status":"DEVOLVIDO","natureza":"ORIGINAL"}}}},"response_200_consulta_cobranca_troco_pix_ativo":{"value":{"value":{"cobs":[{"calendario":{"criacao":"2023-01-01T00:00:00Z","expiracao":86400},"status":"ATIVA","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"loc":{"id":"1234567890123456789","location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-01-01T00:00:00Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","devedor":{"cnpj":"12345678000195","nome":"PMD HOBISSOM EDERLAN EINS"},"valor":{"original":"123.45","modalidadeAlteracao":0,"retirada":{"troco":{"valor":"123.45","modalidadeAlteracao":0,"modalidadeAgente":"AGTEC","prestadorDoServicoDeSaque":"12345678"}}},"chave":"60701190000104","solicitacaoPagador":"Informar cartão fidelidade","pixCopiaECola":"00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925PMD HOBISSOM EDERLAN EINS6009SAO PAULO62070503***6304D56E","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}],"description":""}]}},"description":""},"response_200_consulta_cobranca_troco_pix_removido":{"description":"","value":{"calendario":{"criacao":"2023-01-01T00:00:00Z","expiracao":86400},"devedor":{"cnpj":"12345678000195","nome":"PMD HOBISSOM EDERLAN EINS"},"loc":{"id":"1234567890123456789","location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-05-24T14:42:00Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","valor":{"original":"123.45","modalidadeAlteracao":0,"retirada":{"troco":{"valor":"123.45","modalidadeAlteracao":0,"modalidadeAgente":"AGTEC","prestadorDoServicoDeSaque":"12345678"}}},"chave":"a1f4102e-a446-4a57-bcce-6fa48899c1d1","solicitacaoPagador":"Informar cartão fidelidade","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":1,"status":"REMOVIDA_PELO_USUARIO_RECEBEDOR","pixCopiaECola":"00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925PMD HOBISSOM EDERLAN EINS6009SAO PAULO62070503***6304D56E","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}]}},"201_cobranca_imediata":{"description":"","value":{"calendario":{"criacao":"2023-01-01T00:00:00Z","expiracao":3600},"txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"loc":{"id":789,"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-01-01T00:00:00Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","status":"ATIVA","devedor":{"cnpj":"12345678000195","nome":"PMD HOBISSOM EDERLAN EINS"},"valor":{"original":"567.89","modalidadeAlteracao":1},"chave":"a1f4102e-a446-4a57-bcce-6fa48899c1d1","pixCopiaECola":"00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925PMD HOBISSOM EDERLAN EINS6009SAO PAULO62070503***6304D56E","solicitacaoPagador":"Informar cartão fidelidade","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1 do PSP-Recebedor"},{"nome":"Campo 2","valor":"Informação Adicional 2 do PSP-Recebedor"}]}},"201_cobranca_imediata_txid":{"description":"","value":{"calendario":{"criacao":"2023-01-01T00:00:00Z","expiracao":3600},"txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"loc":{"id":789,"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-01-01T00:00:00Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","status":"ATIVA","devedor":{"cnpj":"12345678000195","nome":"PMD HOBISSOM EDERLAN EINS"},"valor":{"original":"567.89","modalidadeAlteracao":1},"chave":"a1f4102e-a446-4a57-bcce-6fa48899c1d1","pixCopiaECola":"00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925PMD HOBISSOM EDERLAN EINS6009SAO PAULO62070503***6304D56E","solicitacaoPagador":"Serviço realizado.","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1 do PSP-Recebedor"},{"nome":"Campo 2","valor":"Informação Adicional 2 do PSP-Recebedor"}]}},"201_cobranca_imediata_saque":{"description":"","value":{"calendario":{"criacao":"2023-01-01T00:00:00Z","expiracao":3600},"txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"loc":{"id":789,"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-01-01T00:00:00Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","status":"ATIVA","devedor":{"cnpj":"12345678000195","nome":"PMD HOBISSOM EDERLAN EINS"},"valor":{"original":"0.00","modalidadeAlteracao":0,"retirada":{"saque":{"valor":"5.00","modalidadeAlteracao":0,"modalidadeAgente":"AGPSS","prestadorDoServicoDeSaque":"12345678"}}},"chave":"a1f4102e-a446-4a57-bcce-6fa48899c1d1","pixCopiaECola":"00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925PMD HOBISSOM EDERLAN EINS6009SAO PAULO62070503***6304D56E","solicitacaoPagador":"Informar cartão fidelidade","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1 do PSP-Recebedor"},{"nome":"Campo 2","valor":"Informação Adicional 2 do PSP-Recebedor"}]}},"201_cobranca_imediata_troco":{"description":"","value":{"calendario":{"criacao":"2023-01-01T00:00:00Z","expiracao":3600},"txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"loc":{"id":789,"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-01-01T00:00:00Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","status":"ATIVA","devedor":{"cnpj":"12345678000195","nome":"PMD HOBISSOM EDERLAN EINS"},"valor":{"original":"10.00","modalidadeAlteracao":0,"retirada":{"troco":{"valor":"5.00","modalidadeAlteracao":0,"modalidadeAgente":"AGTEC","prestadorDoServicoDeSaque":"12345678"}}},"chave":"a1f4102e-a446-4a57-bcce-6fa48899c1d1","pixCopiaECola":"00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925PMD HOBISSOM EDERLAN EINS6009SAO PAULO62070503***6304D56E","solicitacaoPagador":"Informar cartão fidelidade","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1 do PSP-Recebedor"},{"nome":"Campo 2","valor":"Informação Adicional 2 do PSP-Recebedor"}]}},"200_cobranca_imediata_txid":{"description":"","value":{"calendario":{"criacao":"2023-01-01T00:00:00Z","expiracao":3600},"txid":"7978c0c97ea847e78e8849634473c1f1","revisao":1,"loc":{"id":789,"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","tipoCob":"cob","criacao":"2023-01-01T00:00:00Z"},"location":"pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc","status":"ATIVA","devedor":{"cnpj":"12345678000195","nome":"PMD HOBISSOM EDERLAN EINS"},"valor":{"original":"567.89","modalidadeAlteracao":0},"chave":"a1f4102e-a446-4a57-bcce-6fa48899c1d1","pixCopiaECola":"00020101021226840014BR.GOV.BCB.PIX2562pix.example.com/pix/qr/v2/c8cff0b5-5b2f-4154-835f-14ede94a2afc5204000053039865802BR5925PMD HOBISSOM EDERLAN EINS6009SAO PAULO62070503***6304D56E","solicitacaoPagador":"Serviço realizado.","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1 do PSP-Recebedor"},{"nome":"Campo 2","valor":"Informação Adicional 2 do PSP-Recebedor"}]}},"200_cobrancas":{"value":{"value":{"parametros":{"inicio":"2020-04-01T00:00:00Z","fim":"2020-04-02T10:00:00Z","paginacao":{"paginaAtual":0,"itensPorPagina":100,"quantidadeDePaginas":1,"quantidadeTotalDeItens":2}},"cobs":[{"status":"ATIVA","calendario":{"criacao":"2020-01-01T00:00:00Z","expiracao":3600},"location":"pix.example.com/qr/9d36b84f-c70b-478f-b95c-12729b90ca25","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":1,"devedor":{"cnpj":"12345678000195","cpf":"11111111111","nome":"Empresa de Serviços SA"},"valor":{"original":"567.89"},"chave":"a1f4102e-a446-4a57-bcce-6fa48899c1d1","solicitacaoPagador":"Informar cartão fidelidade"},{"status":"CONCLUIDA","calendario":{"criacao":"2020-01-01T00:00:00Z","expiracao":3600},"location":"pix.example.com/qr/1dd7f893-a58e-4172-8702-8dc33e21a403","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":1,"devedor":{"cnpj":"12345678000195","cpf":"11111111111","nome":"Empresa de Serviços SA"},"valor":{"original":"100.00"},"chave":"40a0932d-1918-4eee-845d-35a2da1690dc","solicitacaoPagador":"Informar cartão fidelidade","pix":[{"chave":"40a0932d-1918-4eee-845d-35a2da1690dc","endToEndId":"E12345678202009091221kkkkkkkkkkk","txid":"7978c0c97ea847e78e8849634473c1f1","valor":"110.00","horario":"2020-01-01T00:00:00Z","infoPagador":123456789,"devolucoes":[{"id":"123ABC","rtrId":"Dxxxxxxxx202009091221kkkkkkkkkkk","valor":"10.00","horario":{"solicitacao":"2020-01-01T00:00:00Z"},"status":"EM_PROCESSAMENTO"}]}],"infoAdicionais":[{"nome":"codigo_cliente","valor":"59ba145f-adf9-440c-af8e-fb16f0d9d07a"}]}]},"description":""},"description":""},"200_cobranca_txid":{"value":{"value":{"status":"ATIVA","calendario":{"criacao":"2020-01-01T00:00:00Z","expiracao":3600},"location":"pix.example.com/qr/v2/cobv/9d36b84fc70b478fb95c12729b90ca25","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":1,"devedor":{"cpf":"11111111111","cnpj":"12345678000195","nome":"Empresa de Serviços SA"},"valor":{"original":"567.89"},"chave":"a1f4102e-a446-4a57-bcce-6fa48899c1d1","solicitacaoPagador":"Informar cartão fidelidade"},"description":""},"description":""},"200_pixs_list":{"value":{"value":{"parametros":{"inicio":"2023-05-01T00:00:00Z","fim":"2023-05-01T23:59:59Z","paginacao":{"paginaAtual":0,"itensPorPagina":100,"quantidadeDePaginas":1,"quantidadeTotalDeItens":5}},"pix":[{"endToEndId":"E12345678202009091221abcdef12345","txid":"7978c0c97ea847e78e8849634473c1f1","chave":"7978c0c97ea847e78e8849634473c1f1","valor":"123.45","horario":"2023-01-01T0:00:00Z","infoPagador":"Informar cartão fidelidade","componentesValor":{"original":{"valor":"123.45"}}},{"endToEndId":"E12345678202009091221abcdef12345","txid":"7978c0c97ea847e78e8849634473c1f1","chave":"7978c0c97ea847e78e8849634473c1f1","valor":"123.45","horario":"2023-01-01T0:00:00Z","infoPagador":"Informar cartão fidelidade","componentesValor":{"original":{"valor":"123.45"}},"devolucoes":[{"id":"D6070119020221201140815955940407","rtrId":"D6070119020221201140815955940407","valor":"123.45","horario":{"solicitacao":"2023-01-01T00:00:00Z","liquidacao":"2023-01-01T00:00:00Z"},"status":"DEVOLVIDO","natureza":"ORIGINAL"}]},{"endToEndId":"E12345678202009091221abcdef12345","txid":"7978c0c97ea847e78e8849634473c1f1","chave":"7978c0c97ea847e78e8849634473c1f1","valor":"123.45","horario":"2023-01-01T0:00:00Z","infoPagador":"Informar cartão fidelidade","componentesValor":{"original":{"valor":"103.45"}},"troco":{"valor":"20.00","modalidadeAgente":"AGTEC","prestadorDeServicoDeSaque":60701190},"devolucoes":[{"id":"D6070119020221201140815955940407","rtrId":"D6070119020221201140815955940407","valor":"5.0","horario":{"solicitacao":"2023-01-01T00:00:00Z","liquidacao":"2023-01-01T00:00:00Z"},"status":"DEVOLVIDO","natureza":"RETIRADA"}]},{"endToEndId":"E12345678202009091221abcdef12345","txid":"7978c0c97ea847e78e8849634473c1f1","chave":"7978c0c97ea847e78e8849634473c1f1","valor":"123.45","horario":"2023-01-01T0:00:00Z","infoPagador":"Informar cartão fidelidade","componentesValor":{"original":{"valor":"0.0"}},"saque":{"valor":"123.45","modalidadeAgente":"AGTEC","prestadorDeServicoDeSaque":60701190},"devolucoes":[{"id":"D6070119020221201140815955940407","rtrId":"D6070119020221201140815955940407","valor":"123.45","horario":{"solicitacao":"2023-01-01T00:00:00Z","liquidacao":"2023-01-01T00:00:00Z"},"status":"DEVOLVIDO","natureza":"RETIRADA"}]}]},"description":""},"description":""},"200_pix_cobranca_imediata_paga":{"value":{"value":{"pix":[{"endToEndId":"E60701190202207240459DY5GKNGX7B4","txid":"7978c0c97ea847e78e8849634473c1f1","chave":"60701190000104","valor":"123.45","horario":"2023-01-01T0:00:00Z","infoPagador":"Informar cartão fidelidade","componentesValor":{"original":{"valor":"123.45"}}}]},"description":""},"description":""},"200_pix_saque_e_pix_pago_e_devolvido":{"value":{"value":{"pix":[{"endToEndId":"E60701190202207240459DY5GKNGX7B4","txid":"7978c0c97ea847e78e8849634473c1f1","valor":"123.45","chave":"62718521651","horario":"2023-05-28T17:52:43Z","componentesValor":{"original":{"valor":"123.45"},"saque":{"valor":"123.45","modalidadeAgente":"AGTEC","prestadorDeServicoDeSaque":"12345678"}},"devolucoes":[{"id":"D6070119020221201142431749005800","rtrId":"D6070119020221201142431749005800","valor":"123.45","horario":{"solicitacao":"2023-05-28T17:52:43Z","liquidacao":"2023-05-28T17:52:43Z"},"status":"DEVOLVIDO","natureza":"RETIRADA"}]}]},"description":""},"description":""},"200_pix_cobranca_troco_paga_e_devolvido":{"value":{"value":{"pix":[{"endToEndId":"E60701190202207240459DY5GKNGX7B4","txid":"7978c0c97ea847e78e8849634473c1f1","chave":"7d9f0335-8dcc-4054-9bf9-0dbd61d36906","valor":"123.45","horario":"2023-01-01T0:00:00Z","infoPagador":"Informar cartão fidelidade","componentesValor":{"original":{"valor":"123.45"}},"troco":{"valor":"20.00","modalidadeAgente":"AGTEC","prestadorDeServicoDeSaque":60701190},"devolucoes":[{"id":"D6070119020221201142431749005800","rtrId":"D6070119020221201142431749005800","valor":"5.0","horario":{"solicitacao":"2023-01-01T00:00:00Z","liquidacao":"2023-01-01T00:00:00Z"},"status":"DEVOLVIDO","natureza":"RETIRADA"}]}]},"description":""},"description":""},"200_pix_cobranca_com_vencimento_pago":{"value":{"value":{"pix":[{"endToEndId":"E60701190202207240459DY5GKNGX7B4","txid":"7978c0c97ea847e78e8849634473c1f1","chave":"60701190000104","valor":"123.45","horario":"2023-01-01T0:00:00Z","infoPagador":"Informar cartão fidelidade","componentesValor":{"original":{"valor":"123.45"}},"devolucoes":[{"id":"D6070119020221201142431749005800","rtrId":"D6070119020221201142431749005800","valor":"123.45","horario":{"solicitacao":"2023-01-01T00:00:00Z","liquidacao":"2023-01-01T00:00:00Z"},"status":"DEVOLVIDO","natureza":"RETIRADA"}]}]},"description":""},"description":""},"200_devolucao":{"description":"","value":{"id":"123456","rtrId":"D12345678202009091000abcde123456","valor":"7.89","natureza":"ORIGINAL","descricao":"Devolução de cobrança","horario":{"solicitacao":"2020-09-11T15:25:59.411Z","liquidacao":"2020-09-11T15:27:23.411Z"},"status":"DEVOLVIDO","motivo":"Devolução solicitada pelo usuário recebedor do pagamento original"}},"200_webhooks":{"value":{"value":{"parametros":{"inicio":"2020-04-01T00:00:00Z","fim":"2020-04-01T23:59:59Z","paginacao":{"paginaAtual":0,"itensPorPagina":100,"quantidadeDePaginas":1,"quantidadeTotalDeItens":1}},"webhooks":[{"webhookUrl":"https://pix.example.com/api/webhook/","chave":"email@email.com","criacao":"2020-11-11T10:15:00.358Z"}]},"description":""},"description":""},"200_webhook":{"value":{"value":{"webhookUrl":"https://pix.example.com/api/webhook/","chave":"40a0932d-1918-4eee-845d-35a2da1690dc","criacao":"2020-11-11T10:15:00.358Z"},"description":""},"description":""},"200_lotecobv_get":{"description":"","value":{"parametros":{"inicio":"2023-04-01T00:00:00Z","fim":"2023-04-01T23:59:59Z","paginacao":{"paginaAtual":0,"itensPorPagina":100,"quantidadeDePaginas":1,"quantidadeTotalDeItens":2}},"lotes":[{"id":12,"descricao":"Cobranças dos alunos do turno vespertino.","criacao":"2023-04-01T23:59:59Z","cobsv":[{"criacao":"2023-04-01T23:59:59Z","txid":"fb2761260e554ad593c7226beb5cb650","status":"CRIADA"},{"txid":"7978c0c97ea847e78e8849634473c1f1","status":"NEGADA","problema":{"type":"https://pix.bcb.gov.br/api/v2/error/CobVOperacaoInvalida","title":"Cobrança inválida.","status":400,"detail":"A requisição que busca alterar ou criar uma cobrança com vencimento não respeita o schema ou está semanticamente errada.","violacoes":[{"razao":"O objeto cobv.devedor não respeita o schema.","propriedade":"cobv.devedor","valor":5678}]}}]},{"id":13,"descricao":"Cobranças dos alunos do turno vespertino.","criacao":"2023-04-01T23:59:59Z","cobsv":[{"criacao":"2023-04-01T23:59:59Z","txid":"fb2761260e554ad593c7226beb5cb650","status":"CRIADA"},{"txid":"7978c0c97ea847e78e8849634473c1f1","status":"NEGADA","problema":{"type":"https://pix.bcb.gov.br/api/v2/error/CobVOperacaoInvalida","title":"Cobrança inválida.","status":400,"detail":"A requisição que busca alterar ou criar uma cobrança com vencimento não respeita o schema ou está semanticamente errada.","violacoes":[{"razao":"O objeto cobv.devedor não respeita o schema.","propriedade":"cobv.devedor","valor":1234}]}}]}]}},"200_lotecobv_get_id":{"description":"","value":{"id":10,"descricao":"Cobranças dos alunos do turno vespertino","criacao":"2023-04-01T23:59:59Z","cobsv":[{"txid":"fb2761260e554ad593c7226beb5cb650","criacao":"2023-04-01T23:59:59Z","status":"CRIADA"},{"txid":"7978c0c97ea847e78e8849634473c1f1","status":"NEGADA","problema":{"type":"https://pix.bcb.gov.br/api/v2/error/CobVOperacaoInvalida","title":"Cobrança inválida.","status":400,"detail":"A requisição que busca alterar ou criar uma cobrança com vencimento não respeita o schema ou está semanticamente errada.\n","violacoes":[{"razao":"O objeto cobv.devedor não respeita o schema.","propriedade":"cobv.devedor","valor":1234}]}}]}},"200_cobranca_vencimento_ativa_by_txid":{"description":"","value":{"calendario":{"dataDeVencimento":"2023-02-20","validadeAposVencimento":30,"criacao":"2023-01-01T00:00:00Z"},"devedor":{"cpf":"12345678909","nome":"Francisco da Silva","logradouro":"Alameda Souza, Numero 80, Bairro Braz","cidade":"Recife","uf":"PE","cep":"70011750"},"loc":{"id":789,"location":"pix.example.com/pix/qr/v2/cobv/b3835e2c-c62a-4376-a511-3e856714f905","tipoCob":"cobv","criacao":"2023-01-01T00:00:00Z"},"valor":{"original":"123.45","multa":{"modalidade":2,"valorPerc":"15.00"},"juros":{"modalidade":2,"valorPerc":"2.00"},"abatimento":{"modalidade":1,"valorPerc":"1.00"},"desconto":{"modalidade":1,"descontoDataFixa":[{"data":"2023-11-30","valorPerc":"30.00"}]}},"chave":"5f84a4c5-c5cb-4599-9f13-7eb4d419dacc","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"recebedor":{"cnpj":"56989000019533","nome":"PMD HOBISSOM EDERLAN EINS","logradouro":"Rua 15, Numero 1200, Bairro São Luiz","cidade":"São Paulo","uf":"SP","cep":"70800100"},"status":"ATIVA","solicitacaoPagador":"Cobrança dos serviços prestados."}},"200_cobranca_vencimento_paga_e_devolvida_by_txid":{"description":"","value":{"calendario":{"dataDeVencimento":"2023-02-20","validadeAposVencimento":30,"criacao":"2023-01-01T00:00:00Z"},"devedor":{"cpf":"12345678909","nome":"Francisco da Silva","logradouro":"Alameda Souza, Numero 80, Bairro Braz","cidade":"Recife","uf":"PE","cep":"70011750"},"loc":{"id":789,"location":"pix.example.com/pix/qr/v2/cobv/b3835e2c-c62a-4376-a511-3e856714f905","tipoCob":"cobv","criacao":"2023-01-01T00:00:00Z"},"valor":{"original":"123.45","multa":{"modalidade":2,"valorPerc":"15.00"},"juros":{"modalidade":2,"valorPerc":"2.00"},"abatimento":{"modalidade":1,"valorPerc":"1.00"},"desconto":{"modalidade":1,"descontoDataFixa":[{"data":"2023-11-30","valorPerc":"30.00"}]}},"chave":"5f84a4c5-c5cb-4599-9f13-7eb4d419dacc","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"recebedor":{"cnpj":"56989000019533","nome":"PMD HOBISSOM EDERLAN EINS","logradouro":"Rua 15, Numero 1200, Bairro São Luiz","cidade":"São Paulo","uf":"SP","cep":"70800100"},"status":"ATIVA","solicitacaoPagador":"Cobrança dos serviços prestados.","pix":[{"endToEndId":"E60701190202212011355DY57CPBODMU","txid":"7978c0c97ea847e78e8849634473c1f1","valor":"123.45","chave":"a1f4102e-a446-4a57-bcce-6fa48899c1d1","horario":"2023-05-30T00:00:00Z","infoPagador":123456789,"devolucoes":[{"id":"D6070119020221201182983866988039","rtrId":"D6070119020221201182983866988039","valor":"123.45","horario":{"solicitacao":"2023-01-01T00:00:00Z"},"status":"DEVOLVIDO"}]}]}},"200_cobranca_vencimento_removida_by_txid":{"description":"","value":{"calendario":{"dataDeVencimento":"2023-02-20","validadeAposVencimento":30,"criacao":"2023-01-01T00:00:00Z"},"devedor":{"cpf":"12345678909","nome":"Francisco da Silva","logradouro":"Alameda Souza, Numero 80, Bairro Braz","cidade":"Recife","uf":"PE","cep":"70011750"},"loc":{"id":789,"location":"pix.example.com/pix/qr/v2/cobv/b3835e2c-c62a-4376-a511-3e856714f905","tipoCob":"cobv","criacao":"2023-01-01T00:00:00Z"},"valor":{"original":"123.45","multa":{"modalidade":2,"valorPerc":"15.00"},"juros":{"modalidade":2,"valorPerc":"2.00"},"abatimento":{"modalidade":1,"valorPerc":"1.00"},"desconto":{"modalidade":1,"descontoDataFixa":[{"data":"2023-11-30","valorPerc":"30.00"}]}},"chave":"5f84a4c5-c5cb-4599-9f13-7eb4d419dacc","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"recebedor":{"cnpj":"56989000019533","nome":"PMD HOBISSOM EDERLAN EINS","logradouro":"Rua 15, Numero 1200, Bairro São Luiz","cidade":"São Paulo","uf":"SP","cep":"70800100"},"status":"REMOVIDA_PELO_USUARIO_RECEBEDOR","solicitacaoPagador":"Cobrança dos serviços prestados."}},"200_cobranca_vencimento_list":{"value":{"value":{"parametros":{"inicio":"2020-04-01T00:00:00Z","fim":"2020-04-02T10:00:00Z","paginacao":{"paginaAtual":0,"itensPorPagina":100,"quantidadeDePaginas":1,"quantidadeTotalDeItens":3}},"cobs":[{"calendario":{"dataDeVencimento":"2023-12-31","validadeAposVencimento":30,"criacao":"2023-01-01T00:00:00Z"},"devedor":{"cpf":"12345678909","nome":"Francisco da Silva","logradouro":"Alameda Souza, Numero 80, Bairro Braz","cidade":"Recife","uf":"PE","cep":"70011750"},"loc":{"id":789,"location":"pix.example.com/pix/qr/v2/cobv/b3835e2c-c62a-4376-a511-3e856714f905","tipoCob":"cobv","criacao":"2023-01-01T00:00:00Z"},"valor":{"original":"123.45","multa":{"modalidade":2,"valorPerc":"15.00"},"juros":{"modalidade":2,"valorPerc":"2.00"},"abatimento":{"modalidade":1,"valorPerc":"1.00"},"desconto":{"modalidade":1,"descontoDataFixa":[{"data":"2023-11-30","valorPerc":"30.00"}]}},"chave":"5f84a4c5-c5cb-4599-9f13-7eb4d419dacc","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"recebedor":{"cnpj":"56989000019533","nome":"PMD HOBISSOM EDERLAN EINS","logradouro":"Rua 15, Numero 1200, Bairro São Luiz","cidade":"São Paulo","uf":"SP","cep":"70800100"},"status":"ATIVA","solicitacaoPagador":"Cobrança dos serviços prestados."},{"calendario":{"dataDeVencimento":"2023-12-31","validadeAposVencimento":30,"criacao":"2023-01-01T00:00:00Z"},"devedor":{"cpf":"12345678909","nome":"Francisco da Silva","logradouro":"Alameda Souza, Numero 80, Bairro Braz","cidade":"Recife","uf":"PE","cep":"70011750"},"loc":{"id":789,"location":"pix.example.com/pix/qr/v2/cobv/b3835e2c-c62a-4376-a511-3e856714f905","tipoCob":"cobv","criacao":"2023-01-01T00:00:00Z"},"valor":{"original":"123.45","multa":{"modalidade":2,"valorPerc":"15.00"},"juros":{"modalidade":2,"valorPerc":"2.00"},"abatimento":{"modalidade":1,"valorPerc":"1.00"},"desconto":{"modalidade":1,"descontoDataFixa":[{"data":"2023-11-30","valorPerc":"30.00"}]}},"chave":"5f84a4c5-c5cb-4599-9f13-7eb4d419dacc","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"recebedor":{"cnpj":"56989000019533","nome":"PMD HOBISSOM EDERLAN EINS","logradouro":"Rua 15, Numero 1200, Bairro São Luiz","cidade":"São Paulo","uf":"SP","cep":"70800100"},"status":"REMOVIDA_PELO_USUARIO_RECEBEDOR","solicitacaoPagador":"Cobrança dos serviços prestados."},{"calendario":{"dataDeVencimento":"2023-12-31","validadeAposVencimento":30,"criacao":"2023-01-01T00:00:00Z"},"devedor":{"cpf":"12345678909","nome":"Francisco da Silva","logradouro":"Alameda Souza, Numero 80, Bairro Braz","cidade":"Recife","uf":"PE","cep":"70011750"},"loc":{"id":789,"location":"pix.example.com/pix/qr/v2/cobv/b3835e2c-c62a-4376-a511-3e856714f905","tipoCob":"cobv","criacao":"2023-01-01T00:00:00Z"},"valor":{"original":"123.45","multa":{"modalidade":2,"valorPerc":"15.00"},"juros":{"modalidade":2,"valorPerc":"2.00"},"abatimento":{"modalidade":1,"valorPerc":"1.00"},"desconto":{"modalidade":1,"descontoDataFixa":[{"data":"2023-11-30","valorPerc":"30.00"}]}},"chave":"5f84a4c5-c5cb-4599-9f13-7eb4d419dacc","txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"recebedor":{"cnpj":"56989000019533","nome":"PMD HOBISSOM EDERLAN EINS","logradouro":"Rua 15, Numero 1200, Bairro São Luiz","cidade":"São Paulo","uf":"SP","cep":"70800100"},"status":"ATIVA","solicitacaoPagador":"Cobrança dos serviços prestados.","pix":[{"endToEndId":"E60701190202212011355DY57CPBODMU","txid":"7978c0c97ea847e78e8849634473c1f1","valor":"123.45","chave":"a1f4102e-a446-4a57-bcce-6fa48899c1d1","horario":"2023-05-30T00:00:00Z","infoPagador":123456789,"devolucoes":[{"id":"D6070119020221201182983866988039","rtrId":"D6070119020221201182983866988039","valor":"123.45","horario":{"solicitacao":"2023-01-01T00:00:00Z"},"status":"DEVOLVIDO"}]}]}]},"description":""},"description":""},"201_cobranca_vencimento_txid":{"description":"","value":{"calendario":{"criacao":"2023-01-20T00:00:00Z","dataDeVencimento":"2023-02-20","validadeAposVencimento":30},"txid":"7978c0c97ea847e78e8849634473c1f1","revisao":0,"loc":{"id":789,"location":"pix.example.com/pix/qr/v2/cobv/b3835e2c-c62a-4376-a511-3e856714f905","tipoCob":"cobv","criacao":"2023-01-20T00:00:00Z"},"status":"ATIVA","devedor":{"logradouro":"Alameda Souza, Numero 80, Bairro Braz","cidade":"Recife","uf":"PE","cep":"70011750","cpf":"12345678909","nome":"Francisco da Silva"},"recebedor":{"logradouro":"Rua 15, Numero 1200, Bairro São Luiz","cidade":"São Paulo","uf":"SP","cep":"70800100","cnpj":"56989000019533","nome":"PMD HOBISSOM EDERLAN EINS"},"valor":{"original":"567.89"},"chave":"a1f4102e-a446-4a57-bcce-6fa48899c1d1","pixCopiaECola":"00020101021226890014BR.GOV.BCB.PIX2567pix.example.com/pix/qr/v2/cobv/b3835e2c-c62a-4376-a511-3e856714f9055204000053039865802BR5925PMD HOBISSOM EDERLAN EINS6009SAO PAULO62070503***63044DCB","solicitacaoPagador":"Cobrança dos serviços prestados.","infoAdicionais":[{"nome":"Campo 1","valor":"Informação Adicional 1"},{"nome":"Campo 2","valor":"Informação Adicional 2"}]}},"200_locs":{"value":{"value":{"parametros":{"inicio":"2020-04-01T00:00:00Z","fim":"2020-04-01T23:59:59Z","paginacao":{"paginaAtual":0,"itensPorPagina":100,"quantidadeDePaginas":1,"quantidadeTotalDeItens":2}},"loc":[{"id":789,"txid":"7978c0c97ea847e78e8849634473c1f1","location":"pix.example.com/qr/v2/cobv/9d36b84fc70b478fb95c12729b90ca25","tipoCob":"cobv","criacao":"2020-03-11T21:19:51.013Z"},{"id":789,"txid":"7978c0c97ea847e78e8849634473c1f1","location":"pix.example.com/qr/v2/cobv/9d36b84fc70b478fb95c12729b90ca25","tipoCob":"cobv","criacao":"2020-03-11T21:19:51.013Z"}]},"description":""},"description":""},"200_loc_cob":{"description":"","value":{"id":7716,"location":"pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002","tipoCob":"cob","criacao":"2023-03-01T23:59:59Z"}},"200_loc_cobv":{"description":"","value":{"id":856,"location":"pix.example.com/qr/v2/cobv/39c9f435c6324867aa1dec1260e1127c","tipoCob":"cobv","criacao":"2023-03-10T20:30:00Z"}},"200_loc_get_id":{"value":{"value":{"id":7716,"txid":"fda9460fe04e4f129b72863ae57ee22f","location":"pix.example.com/qr/v2/cobv/2353c790eefb11eaadc10242ac120002","tipoCob":"cobv","criacao":"2020-03-11T21:19:51.013Z"},"description":""},"description":""},"202_lotecobv_put":{"description":"","value":"OK"},"202_lotecobv_patch":{"description":"","value":"OK"}},"responses":{"200_get":{"headers":{"Content-Location":{"description":"URI correspondente a pesquisa corrente","schema":{"type":"string"}}},"description":"A execução foi bem sucedida e retornou os dados do recurso de saída.\n -- Se for um recurso único este estará representado na saída\n -- Se o recurso for uma coleção, todos os elementos da consulta serão devolvidos.\n -- Se a resposta for um conjunto parcial então o status 206 deverá ser utilizado.\n"},"204_get":{"description":"Solicitação processada com sucesso, mas não está retornando nenhum conteúdo.\n"},"303_get":{"description":"See Other - Resposta à solicitação da consulta será redirecionada (pode ser encontrada em outro URI/localização), usando o método GET. Quando recebido em resposta a um POST (ou PUT / DELETE), o cliente deve presumir que o servidor recebeu os dados e deve emitir uma nova solicitação GET para o URI/localização fornecido.\n"},"400_get":{"description":"Parâmetros incorretos (os dados de entradas estão incorretos ou ausentes)."},"401_get":{"description":"Não autorizado. Verifique se os parâmetros de acesso estão válidos (como certificado, expiração do token, configuração da credencial e secret ou jwt). Se o problema persistir, entre em contato com o suporte Itaú."},"403_get":{"description":"Acesso Proibido. Verifique se os parâmetros de acesso estão válidos (como certificado, expiração do token, configuração da credencial e secret ou jwt). Se o problema persistir, entre em contato com o suporte Itaú."},"404_get":{"description":"Recurso Inexistente (não encontrado)"},"405_get":{"description":"Método não permitido"},"422_get":{"description":"Erro semântico"},"428_get":{"description":"Solicitação requer pré requisito ou condição que não foi enviada"},"500_get":{"description":"Erro Inesperado. Entre em contato com o suporte Itaú."},"501_get":{"description":"Não implementado. Entre em contato com o suporte Itaú."},"503_get":{"description":"Serviço Indisponível.Entre em contato com o suporte Itaú."},"504_get":{"description":"Gateway Timeout. Entre em contato com o suporte Itaú."},"200_post":{"description":"O recurso foi criado com êxito, a resposta incluirá um corpo com a representação do recurso.\n"},"201_post":{"description":"O recurso foi criado de forma síncrona."},"202_post":{"description":"O recurso será criado de forma assíncrona.\nO retorno deverá ser um recurso de tarefas.\n"},"400_post":{"description":"Parâmetros incorretos (os dados de entradas estão incorretos ou ausentes)."},"401_post":{"description":"Não autorizado. Verifique se os parâmetros de acesso estão válidos (certificado, expiração do token, configuração da credencial, secret ou jwt). Se o problema persistir, entre em contato com o suporte Itaú."},"403_post":{"description":"Acesso Proibido. Verifique se os parâmetros de acesso estão válidos (certificado, expiração do token, configuração da credencial, secret ou jwt). Se o problema persistir, entre em contato com o suporte Itaú."},"404_post":{"description":"Recurso Inexistente (não encontrado)"},"405_post":{"description":"Método não permitido"},"422_post":{"description":"Erro semântico"},"428_post":{"description":"Solicitação requer pré-requisito ou condição que não foi enviada"},"500_post":{"description":"Erro Inesperado. Entre em contato com o suporte Itaú."},"501_post":{"description":"Não implementado. Entre em contato com o suporte Itaú."},"503_post":{"description":"Serviço Indisponível.Entre em contato com o suporte Itaú."},"504_post":{"description":"Gateway Timeout. Entre em contato com o suporte Itaú."},"200_put":{"description":"A execução foi bem-sucedida, o recurso é atualizado de acordo com as mudanças enviadas de forma síncrona.\n"},"201_put":{"description":"Se não exsitir o recurso, neste caso, o recurso foi criado.\n"},"202_put":{"description":"A execução foi bem-sucedida, o recurso é atualizado / criado de acordo com as mudanças enviadas de forma assíncrona.\nO retorno deverá ser um recurso de taferas.\n"},"204_put":{"description":"Solicitação processada com sucesso, mas não está retornando nenhum conteúdo.\n"},"400_put":{"description":"Parâmetros incorretos (os dados de entradas estão incorretos ou ausentes)."},"401_put":{"description":"Não autorizado. Verifique se os parâmetros de acesso estão válidos (certificado, expiração do token, configuração da credencial, secret ou jwt). Se o problema persistir, entre em contato com o suporte Itaú."},"403_put":{"description":"Acesso Proibido. Verifique se os parâmetros de acesso estão válidos (certificado, expiração do token, configuração da credencial, secret ou jwt). Se o problema persistir, entre em contato com o suporte Itaú."},"404_put":{"description":"Recurso Inexistente (não encontrado)"},"405_put":{"description":"Método não permitido"},"422_put":{"description":"Erro semântico"},"428_put":{"description":"Solicitação requer pré requisito ou condição que não foi enviada"},"500_put":{"description":"Erro Inesperado. Entre em contato com o suporte Itaú."},"501_put":{"description":"Não implementado. Entre em contato com o suporte Itaú."},"503_put":{"description":"Serviço Indisponível.Entre em contato com o suporte Itaú."},"200_patch":{"description":"A execução foi bem-sucedida, o recurso é atualizado de acordo com as mudanças enviadas de forma síncrona.\n"},"202_patch":{"description":"A execução foi bem-sucedido e atualização se derá de forma assíncrona.\nO retorno deverá ser um recurso de taferas.\n"},"204_patch":{"description":"Solicitação processada com sucesso, mas não está retornando nenhum conteúdo.\n"},"400_patch":{"description":"Parâmetros incorretos (os dados de entradas estão incorretos ou ausentes)."},"401_patch":{"description":"Não autorizado. Verifique se os parâmetros de acesso estão válidos (certificado, expiração do token, configuração da credencial, secret ou jwt). Se o problema persistir, entre em contato com o suporte Itaú."},"403_patch":{"description":"Acesso Proibido. Verifique se os parâmetros de acesso estão válidos (certificado, expiração do token, configuração da credencial, secret ou jwt). Se o problema persistir, entre em contato com o suporte Itaú."},"404_patch":{"description":"Recurso Inexistente (não encontrado)"},"405_patch":{"description":"Método não permitido"},"422_patch":{"description":"Erro semântico"},"428_patch":{"description":"Solicitação requer pré requisito ou condição que não foi enviada"},"500_patch":{"description":"Erro Inesperado. Entre em contato com o suporte Itaú."},"501_patch":{"description":"Não implementado. Entre em contato com o suporte Itaú."},"503_patch":{"description":"Serviço Indisponível.Entre em contato com o suporte Itaú."},"504_patch":{"description":"Gateway Timeout. Entre em contato com o suporte Itaú."},"200_delete":{"description":"A execução foi bem-sucedida, o recurso foi removido corretamente de forma síncrona.\n"},"202_delete":{"description":"A execução foi bem-sucedida, o recurso será excluído de forma assíncrona.\nO retorno deste pedido deve ser um recurso de tarefas.\n"},"400_delete":{"description":"Parâmetros incorretos (os dados de entradas estão incorretos ou ausentes)."},"401_delete":{"description":"Não autorizado. Verifique se os parâmetros de acesso estão válidos (certificado, expiração do token, configuração da credencial, secret ou jwt). Se o problema persistir, entre em contato com o suporte Itaú."},"403_delete":{"description":"Acesso Proibido. Verifique se os parâmetros de acesso estão válidos (certificado, expiração do token, configuração da credencial, secret ou jwt). Se o problema persistir, entre em contato com o suporte Itaú."},"404_delete":{"description":"Recurso Inexistente (não encontrado)"},"405_delete":{"description":"Método não permitido"},"422_delete":{"description":"Erro semântico"},"428_delete":{"description":"Solicitação requer pré requisito ou condição que não foi enviada"},"500_delete":{"description":"Erro Inesperado. Entre em contato com o suporte Itaú."},"501_delete":{"description":"Não implementado. Entre em contato com o suporte Itaú."},"503_delete":{"description":"Serviço Indisponível.Entre em contato com o suporte Itaú."},"504_delete":{"description":"Gateway Timeout. Entre em contato com o suporte Itaú."}},"schemas":{"devedor":{"type":"object","title":"Devedor","description":"**Descrição:** Campo que organiza a identificação do devedor, ou seja, a pessoa ou instituição a quem a cobrança está endereçada. Não identifica, necessariamente, quem irá efetivamente realizar o pagamento.\n\n**Observação:** Não é permitido que o campo `devedor.cpf` e campo `devedor.cnpj` estejam preenchidos ao mesmo tempo. Se o campo `devedor.cnpj` está preenchido, então o campo `devedor.cpf` não pode estar preenchido, e vice-versa. Se o campo devedor.nome está preenchido, então deve existir ou um `devedor.cpf` ou um campo `devedor.cnpj` preenchido.\n","properties":{"email":{"title":"Email","description":"**Descrição:** E-mail do devedor.\n","type":"string"},"logradouro":{"title":"Logradouro","description":"**Descrição:** Logradouro do devedor.\n","type":"string","maxLength":200},"cidade":{"title":"Cidade","description":"**Descrição:** Cidade do devedor.\n","type":"string","maxLength":200},"uf":{"title":"UF","description":"**Descrição:** UF do devedor.\n","type":"string","maxLength":2},"cep":{"title":"CEP","description":"**Descrição:** CEP do devedor.\n","type":"string","maxLength":8},"cpf":{"description":"**Descrição:** Número do Documento Cadastro de Pessoa Física.\n\n**Observação:** Se preenchido, não enviar CNPJ.\n","type":"string","title":"CPF","pattern":"/^\\d{11}$/"},"cnpj":{"description":"**Descrição:** Número do Cadastro Nacional da Pessoa Jurídica.\n\n**Observação:** Se preenchido, não enviar CPF.\n","type":"string","title":"CNPJ","pattern":"/^\\d{14}$/"},"nome":{"description":"**Descrição:** Nome do pagador da cobrança. \n\n**Observação:** Necessário preencher o campo CNPJ ou o campo CPF.\n","type":"string","title":"Nome","maxLength":200}},"required":["cpf","cnpj","nome"]},"loc":{"type":"object","title":"Location do Payload","description":"**Descrição:** Dados da localização do payload.\n","properties":{"id":{"title":"Identificador da Localização do Payload","description":"**Descrição:** Identificador da URL do PIX para consulta do payload criptografado - pix link BACEN.\n\n**Tipo do campo:** integer($int64).\n","type":"integer","readOnly":true},"location":{"title":"Localização do Payload","description":"**Descrição:** URL do PIX para consulta do payload criptografado - pix link BACEN.\n\n**Tipo do campo:** integer($uri).\n","type":"string","maxLength":77,"readOnly":true},"tipoCob":{"title":"Tipo da Cobrança","description":"**Descrição:** Define se o tipo do documento é imediata ou vencimento.\n","enum":["cob","cobv"],"type":"string"},"criacao":{"title":"Data de Criação","description":"**Descrição:** Data e hora de criação da localização da cobrança.\n\n**Observação:** Respeita RFC 3339.\n\n**Tipo do campo:** string($date-time).\n","type":"string","readOnly":true}},"required":["id","location","tipoCob","criacao"]},"saque":{"type":"object","title":"Saque","description":"**Descrição:** Informações relacionadas ao saque.\n","properties":{"valor":{"title":"Valor do Saque","description":"**Descrição:** Valor do saque efetuado. \n\n**Observação:** Valor mínimo do saque 10.00 e valor máximo do saque 500.00.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"},"modalidadeAlteracao":{"title":"Modalidade de Alteração do Saque","description":"**Descrição:** Modalidade de alteração de valor do saque. Trata-se de um campo que determina se o valor final do documento pode ser alterado pelo pagador.\n\n**Observação:** Quando não preenchido o valor assumido é o 0 (zero).\n\nNa ausência desse campo, assume-se que não se pode alterar o valor do saque, ou seja, assume-se o valor 0.\n\nSe o campo estiver presente e com valor 1, então está determinado que o valor final do saque pode ser alterado pelo pagador.\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":0,"maximum":1,"example":0},"modalidadeAgente":{"title":"Modalidade do Agente","description":"**Descrição:** Modalidade do Agente.\n| SIGLA | Descrição |\n| ----- | --------------------------------------- |\n| AGTEC | Agente Estabelecimento Comercial |\n| AGTOT | Agente Outra Espécie de Pessoa Jurídica |\n| AGPSS | Agente Prestador de Serviço de Saque |\n\n**ATENÇÃO:** no mapeamento para o campo `modalidadeAgente`, da pacs.008, o AGPSS deve ser substituído por AGFSS.\n","type":"string","enum":["AGTEC","AGTOT","AGPSS"]},"prestadorDoServicoDeSaque":{"description":"**Descrição:** ISPB do Facilitador de Serviço de Saque.\n","type":"string","title":"Facilitador de Serviço de Saque","pattern":"\\d{8}"}},"required":["valor","modalidadeAgente","prestadorDoServicoDeSaque"]},"troco":{"type":"object","title":"Troco","description":"**Descrição:** Informações relacionadas ao troco.\n","properties":{"valor":{"description":"**Descrição:** Valor do troco efetuado. \n\n**Observação:** Valor mínimo do troco 10.00 e valor máximo do troco 500.00.\n","type":"string","title":"Valor do Troco","pattern":"\\d{1,10}\\.\\d{2}"},"modalidadeAlteracao":{"title":"Modalidade de Alteração do Troco","description":"**Descrição:** Modalidade de alteração de valor do troco. Trata-se de um campo que determina se o valor final do documento pode ser alterado pelo pagador.\n\n**Observação:** Quando não preenchido o valor assumido é o 0 (zero).\n\nNa ausência desse campo, assume-se que não se pode alterar o valor do troco, ou seja, assume-se o valor 0.\n\nSe o campo estiver presente e com valor 1, então está determinado que o valor final do troco pode ser alterado pelo pagador.\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":0,"maximum":1},"modalidadeAgente":{"title":"Modalidade do Agente","description":"**Descrição:** Modalidade do Agente.\n| SIGLA | Descrição |\n| ----- | --------------------------------------- |\n| AGTEC | Agente Estabelecimento Comercial |\n| AGTOT | Agente Outra Espécie de Pessoa Jurídica |\n","type":"string","enum":["AGTEC","AGTOT"]},"prestadorDoServicoDeSaque":{"title":"Facilitador de Serviço de Saque","description":"**Descrição:** ISPB do Facilitador de Serviço de Saque.\n","type":"string","pattern":"\\d{8}"}},"required":["valor","modalidadeAgente","prestadorDoServicoDeSaque"]},"retirada":{"type":"object","title":"Informações de Retirada","description":"**Descrição:** Estrutura opcional relacionada ao Saque/Troco Pix.\n","properties":{"saque":{"$ref":"#/components/schemas/saque"},"troco":{"$ref":"#/components/schemas/troco"}}},"valor":{"type":"object","title":"Valor da Cobrança com Vencimento","description":"**Descrição:** Campo que organiza os valores monetários referentes à cobrança.\n","properties":{"original":{"title":"Valor","description":"**Descrição:** Valor nominal/original da cobrança.\n\n**Observação:** O valor deve ser maior do que zero. Todos os campos que indicam valores monetários obedecem ao formato do ID 54 da especificação EMV/BR Code para QR Codes. O separador decimal é o caractere ponto. Não é aplicável utilizar separador de milhar. Exemplos de valores aderentes ao padrão: “0.00”, “1.00”, “123.99”, “123456789.23”.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"},"multa":{"title":"Multa Aplicada","description":"**Descrição:** Multa aplicada à cobrança.\n","type":"object","properties":{"modalidade":{"title":"Modalidade da Multa","description":"**Descrição:** Modalidade da multa, conforme tabela de domínios.\n| Descrição | Domínio |\n| ---------- | ------- |\n| Valor Fixo | 1 |\n| Percentual | 2 |\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":1,"maximum":2},"valorPerc":{"title":"Valor da Multa Absoluta","description":"**Descrição:** Multa do documento em valor absoluto ou percentual, conforme `valor.multa.modalidade`.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"}},"required":["modalidade","valorPerc"]},"juros":{"title":"Juro Aplicado","description":"**Descrição:** Juros aplicado à cobrança.\n","type":"object","properties":{"modalidade":{"title":"Modalidade de Juros","description":"**Descrição:** Modalidade de juros, conforme tabela de domínios.\n\n| Descrição | Domínio |\n| --------------------------------- | ------- |\n| Valor (dias corridos) | 1 |\n| Percentual ao dia (dias corridos) | 2 |\n| Percentual ao mês (dias corridos) | 3 |\n| Percentual ao ano (dias corridos) | 4 |\n| Valor (dias úteis) | 5 |\n| Percentual ao dia (dias úteis) | 6 |\n| Percentual ao mês (dias úteis) | 7 |\n| Percentual ao ano (dias úteis) | 8 |\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":1,"maximum":8},"valorPerc":{"title":"Valor","description":"**Descrição:** Juros do documento em valor absoluto ou percentual.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"}},"required":["modalidade","valorPerc"]},"abatimento":{"title":"Abatimento Aplicado","description":"**Descrição:** Abatimento aplicado à cobrança.\n","type":"object","properties":{"modalidade":{"title":"Modalidade de Abatimentos","description":"**Descrição:** Modalidade de abatimentos, conforme tabela de domínios.\n| Descrição | Domínio |\n| ---------- | ------- |\n| Valor Fixo | 1 |\n| Percentual | 2 |\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":1,"maximum":2},"valorPerc":{"title":"Abatimentos","description":"**Descrição:** Abatimentos ou outras deduções aplicadas ao documento, em valor absoluto ou percentual do valor original do documento.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"}},"required":["modalidade","valorPerc"]},"desconto":{"title":"Descontos Aplicados","description":"**Descrição:** Descontos aplicados à cobranca.\n","type":"object","properties":{"modalidade":{"title":"Modalidade de Descontos","description":"**Descrição:** Modalidade de desconto, conforme tabela de domínios.\n| Descrição | Domínio |\n| ---------------------------------------- | ------- |\n| Valor Fixo até a[s] data[s] informada[s] | 1 |\n| Percentual até a data informada | 2 |\n| Valor por antecipação dia corrido | 3 |\n| Valor por antecipação dia útil | 4 |\n| Percentual por antecipação dia corrido | 5 |\n| Percentual por antecipação dia útil | 6 |\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":1,"maximum":6},"valorPerc":{"title":"Abatimentos","description":"**Descrição:** Abatimentos ou outras deduções aplicadas ao documento, em valor absoluto ou percentual do valor original do documento.\n\n**Observação:** Não deve ser enviado `valorPerc` e `descontoDataFixa` juntos.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"},"descontoDataFixa":{"title":"Lista de Descontos","description":"**Descrição:** Data limite para o desconto absoluto da cobrança.\n\n**Observação:** A data de desconto obrigatoriamente deverá ser menor que a data de vencimento da cobrança.\n","type":"array","minItems":1,"maxItems":3,"uniqueItems":true,"items":{"type":"object","description":"","properties":{"data":{"title":"Data Limite","description":"**Descrição:** Data limite para o desconto absoluto da cobrança.\n\n**Observação:** Descontos por pagamento antecipado, com data fixa. Matriz com até três elementos, sendo que cada elemento é composto por um par `data` e `valorPerc`, para estabelecer descontos percentuais ou absolutos, até aquela data de pagamento. Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. A data de desconto obrigatoriamente deverá ser menor ou igual à data de vencimento da cobrança.\n\n**Tipo do campo:** string($date).\n","type":"string"},"valorPerc":{"title":"Valor do Desconto Absoluto","description":"**Descrição:** Desconto em valor absoluto ou percentual por dia, útil ou corrido, conforme `valor.desconto.modalidade`.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"}},"required":["data","valorPerc"]}}},"required":["modalidade","valorPerc"]}},"required":["original"]},"informacaoAdicional":{"type":"object","description":"","properties":{"nome":{"description":"**Descrição:** Nome do campo de informação adicional.\n","type":"string","title":"Nome","maxLength":50},"valor":{"description":"**Descrição:** Dados a serem apresentados na informação adicional.\n","type":"string","title":"Valor","maxLength":200}},"required":["nome","valor"]},"componentesValor":{"type":"object","description":"","properties":{"original":{"description":"Valor original da cobrança.","type":"object","properties":{"valor":{"description":"Valor original da cobrança.","type":"string","example":"10.00"}},"required":["valor"]},"saque":{"$ref":"#/components/schemas/saqueCv"},"troco":{"$ref":"#/components/schemas/trocoCv"},"juros":{"description":"Juro aplicado à cobrança.","type":"object","properties":{"valor":{"description":"Juro aplicado à cobrança.","type":"string","example":"10.00"}},"required":["valor"]},"multa":{"description":"Multa aplicada à cobrança.","type":"object","properties":{"valor":{"description":"Multa aplicada à cobrança.","type":"string","example":"10.00"}},"required":["valor"]},"desconto":{"description":"Descontos aplicados à cobrança.","type":"object","properties":{"valor":{"description":"Descontos aplicados à cobrança.","type":"string","example":"10.00"}},"required":["valor"]},"abatimento":{"description":"Abatimento aplicado à cobrança.","type":"object","properties":{"valor":{"description":"Abatimento aplicado à cobrança.","type":"string","example":"10.00"}},"required":["valor"]}}},"devolucao":{"type":"object","description":"","properties":{"id":{"description":"Id da devolução","type":"string","example":"208ab4b58be84186927b15ed2a4fbff9"},"rtrId":{"description":"ReturnIdentification (Transita na PACS004).","type":"string","example":"D12345678202009091000abcde123456"},"valor":{"description":"Valor a devolver.","type":"string","example":"11.00"},"natureza":{"description":"Natureza da Devolução
ENUM
ORIGINAL
RETIRADA
MED_OPERACIONAL
MED_FRAUDE
\n","type":"string","example":"ORIGINAL"},"descricao":{"description":"O campo descricao, opcional, determina um texto a ser apresentado ao pagador contendo informações sobre a devolução. Esse texto será preenchido, na pacs.004, pelo PSP do recebedor, no campo RemittanceInformation. O tamanho do campo na pacs.004 está limitado a 140 caracteres.","type":"string","example":"Descrição teste"},"horario":{"description":"","type":"object","properties":{"solicitacao":{"description":"Data hora em que foi efetuada a devolução","type":"string","example":"2020-09-10T13:03:33.902Z"},"liquidacao":{"description":"Horário no qual a devolução foi liquidada no PSP.","type":"string","example":"2020-09-10T13:03:33.902Z"}}},"status":{"description":"Status da Devolução
ENUM
EM_PROCESSAMENTO
DEVOLVIDO
NAO_REALIZADO
\n","type":"string","example":"DEVOLVIDO"},"motivo":{"description":"Campo opcional que pode ser utilizado pelo PSP recebedor para detalhar os motivos de a devolução ter atingido o status em questão. Pode ser utilizado, por exemplo, para detalhar o motivo de a devolução não ter sido realizada.","type":"string"}},"required":["id","rtrId","valor","status"]},"pix":{"type":"object","description":"","properties":{"endToEndId":{"description":"Id fim a fim da transação. Esse campo é o \"id do pagamento\". Transita nas mensagens de recebimento dos QR Codes e transferências.","type":"string","example":"E12345678202009091221abcdef12345"},"txid":{"description":"O campo txid determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite a conciliação de pagamentos. O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. Deve ser único por CNPJ do recebedor. Para Code dinâmico o campo deve possuir de 26 posição até 35 posições. Os caracteres permitidos no contexto do Pix para o campo txId são: Letras minúsculas, de ‘a’ a ‘z’, Letras maiúsculas, de ‘A’ a ‘Z’, Dígitos decimais, de ‘0’ a ‘9’","type":"string","example":"7978c0c97ea847e78e8849634473c1f1"},"valor":{"description":"Valor do pagamento.","type":"string","example":"100.00"},"componentesValor":{"description":"O objetivo dessa estrutura é explicar os elementos de composição do valor do Pix, incluindo informações sobre as multas, juros, descontos e abatimentos quando o Pix for relativo a cobranças com vencimento.","type":"array","items":{"$ref":"#/components/schemas/componentesValor"}},"chave":{"description":"Chave DICT do recebedor","type":"string","example":"a1f4102e-a446-4a57-bcce-6fa48899c1d1"},"horario":{"description":"Horário do pagamento.","type":"string","example":"2020-09-10T13:03:33.902Z"},"infoPagador":{"description":"Informação livre do pagador.","type":"string","example":"Reforma da casa"},"devolucoes":{"description":"Devolucoes registradas no documento","type":"array","items":{"$ref":"#/components/schemas/devolucao"}}},"required":["endToEndId","valor","chave","horario","infoPagador"]},"cobranca":{"type":"object","description":"","properties":{"calendario":{"description":"Os campos aninhados sob o identificador calendário e que organizam informações a respeito de controle de tempo da cobrança","type":"object","properties":{"criacao":{"description":"Data e Hora de criação da cobrança","type":"string","example":"2020-01-01T00:00:00Z"},"expiracao":{"description":"Tempo de vida da cobrança, especificado em segundos a partir da data de criação (Calendario.criacao).","type":"integer","example":3600}},"required":["criacao","expiracao"]},"devedor":{"$ref":"#/components/schemas/pessoa"},"loc":{"$ref":"#/components/schemas/loc"},"valor":{"type":"object","description":"","properties":{"original":{"description":"Valor nominal/original da cobrança.","type":"string"},"modalidadeAlteracao":{"description":"Trata-se de um campo que determina se o valor final do documento pode ser alterado pelo pagador. Na ausência desse campo, assume-se que não se pode alterar o valor do documento de cobrança, ou seja, assume-se o valor 0. Se o campo estiver presente e com valor 1, então está determinado que o valor final da cobrança pode ter seu valor alterado pelo pagador.","type":"integer"},"retirada":{"$ref":"#/components/schemas/retirada"}}},"chave":{"description":"Chave DICT do recebedor","type":"string","example":"a1f4102e-a446-4a57-bcce-6fa48899c1d1"},"solicitacaoPagador":{"description":"O campo solicitacaoPagador, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor","type":"string","example":"Informar cartão fidelidade"},"infoAdicionais":{"description":"Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador","type":"array","items":{"$ref":"#/components/schemas/informacaoAdicional"}},"txid":{"description":"O campo txid determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite a conciliação de pagamentos. O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. Deve ser único por CNPJ do recebedor. Para Code dinâmico o campo deve possuir de 26 posição até 35 posições. Os caracteres permitidos no contexto do Pix para o campo txId são: Letras minúsculas, de ‘a’ a ‘z’, Letras maiúsculas, de ‘A’ a ‘Z’, Dígitos decimais, de ‘0’ a ‘9’","type":"string","example":"7978c0c97ea847e78e88496344"},"revisao":{"description":"Quantidade de revisões da cobrança.","type":"integer","example":1},"location":{"description":"URL com a localização do payload informado na criação da cobrança","type":"string","example":"pix.example.com/qr/9d36b84f-c70b-478f-b95c-12729b90ca25"},"status":{"description":"Status do registro da cobrança.
ENUM
ATIVA
CONCLUIDA
REMOVIDA_PELO_USUARIO_RECEBEDOR
REMOVIDA_PELO_PSP
\n","type":"string","example":"ATIVA"},"pixCopiaECola":{"description":"Este campo retorna o valor do Pix Copia e Cola correspondente à cobrança. Trata-se da sequência de caracteres que representa o BR Code.","type":"string","example":"00020101021226860014BR.GOV.BCB.PIX2564spi-h.itau.com.br/pix/qr/v1/c3d189b4-c859-4218-b9de-b44594755a2e5204000053039865802BR5924PMD XA da Silva Einstein6009SAO PAULO62070503***63045E66"},"pix":{"description":"Lista de Pix recebidos","type":"array","items":{"$ref":"#/components/schemas/pix"}}},"required":["calendario","valor","chave","txid","revisao","location","status"]},"calendario":{"type":"object","description":"","properties":{"dataDeVencimento":{"description":"É a data de vencimento da cobrança. A cobrança pode ser honrada até esse dia, inclusive, em qualquer horário do dia","type":"string","example":"2020-10-09"},"validadeAposVencimento":{"description":"Trata-se da quantidade de dias corridos após o vencimento em que a cobrança poderá ser paga. Caso vencido este período e a cobrança não tenha sido paga, esta continuará ATIVA","type":"integer","example":30},"criacao":{"description":"Data e Hora de criação da cobrança","type":"string","example":"2020-01-01T00:00:00Z"}},"required":["dataDeVencimento","criacao"]},"recebedor":{"type":"object","title":"Recebedor","description":"**Descrição:** Campo que organiza a identificação do recebedor, ou seja, a pessoa ou instituição na qual a cobrança está sendo recebida.\n**Observação:** Não é permitido que o campo `recebedor.cpf` e campo `recebedor.cnpj` estejam preenchidos ao mesmo tempo. Se o campo `recebedor.cnpj` está preenchido, então o campo `recebedor.cpf` não pode estar preenchido, e vice-versa. Se o campo devedor.nome está preenchido, então deve existir ou um `recebedor.cpf` ou um campo `recebedor.cnpj` preenchido.\n","properties":{"logradouro":{"title":"Logradouro","description":"**Descrição:** Logradouro do usuário.\n","type":"string","maxLength":200},"cidade":{"title":"Cidade","description":"**Descrição:** Cidade do usuário.\n","type":"string","maxLength":200},"uf":{"title":"UF","description":"**Descrição:** UF do usuário.\n","type":"string","maxLength":2},"cep":{"title":"CEP","description":"**Descrição:** CEP do usuário.\n","type":"string","maxLength":8},"cpf":{"title":"CPF","description":"**Descrição:** Número do Documento Cadastro de Pessoa Física. (Apenas CPF, não enviar CNPJ).\n","type":"string","pattern":"/^\\d{11}$/"},"cnpj":{"title":"CNPJ","description":"**Descrição:** Número do Cadastro Nacional da Pessoa Jurídica. (Apenas CNPJ, não enviar CPF).\n","type":"string","pattern":"/^\\d{14}$/"},"nome":{"title":"Nome","description":"**Descrição:** Nome do usuário.\n","type":"string","maxLength":200},"nomeFantasia":{"title":"Nome Fantasia","description":"**Descrição:** Nome fantasia.\n","type":"string","maxLength":200}},"required":["logradouro","cidade","uf","cep","cpf","cnpj","nome"]},"cobrancaVencimento":{"type":"object","title":"Lotes de Cobranças com Vencimento Consultados","description":"**Descrição:** Dados retornados na consulta de lotes de cobranças com vencimento.\n","properties":{"txid":{"title":"Identificador do QR Code","description":"**Descrição:** O campo `txid` determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.\n\n**Observação:** Na pacs.008, é referenciado como `TransactionIdentification ` ou `idConciliacaoRecebedor`.\n\nEm termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.\n\nO txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de um QR Code, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.\n\nEste código deve possuir entre 26 e 35 posições, podendo conter letras minúsculas (a-z), letras maiúsculas (A-Z) e números (0-9).\n","type":"string","pattern":"[a-zA-Z0-9]{26,35}"},"status":{"title":"Status","description":"**Descrição:** Status da solicitação de criação/alteração de QR Code no contexto de criação via lote.\n","enum":["EM_PROCESSAMENTO","CRIADA","NEGADA"],"type":"string"},"criacao":{"title":"Data de Criação","description":"**Descrição:** Timestamp que indica o momento em que foi criado o QR Code.\n\n**Observação:** Respeita o RFC 3339.\n\n**Tipo do campo:** string($date-time).\n","type":"string","readOnly":true},"problema":{"$ref":"#/components/schemas/cobrancaVencimento_400"}},"required":["txid","status"]},"cobrancas":{"type":"object","description":"","properties":{"parametros":{"description":"","type":"object","properties":{"inicio":{"description":"Data inicial. Respeita RFC 3339.","type":"string","example":"2020-04-01T00:00:00Z"},"fim":{"description":"Data de fim. Respeita RFC 3339.","type":"string","example":"2020-04-01T23:59:59Z"},"txid":{"description":"ID de identificação do documento entre os bancos e o cliente emissor. O campo txid é obrigatório e determina o identificador da transação.O objetivo desse campo é ser um elemento que possibilite a conciliação de pagamentos. O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. Deve ser único por CNPJ do recebedor. Apesar de possuir o tamanho de 35 posições (PAC008), para QR Code Estático o tamanho máximo permitido é de 25 posições (limitação EMV). No caso do QR Code dinâmico o campo deve possuir de 26 posição até 35 posições. Os caracteres permitidos no contexto do Pix para o campo txId são:Letras minúsculas, de ‘a’ a ‘z’, Letras maiúsculas, de ‘A’ a ‘Z’, Dígitos decimais, de ‘0’ a ‘9’","type":"string","example":"7978c0c97ea847e78e88496344"},"cpf":{"description":"CPF do pagador cadastrado na cobrança","type":"string","example":"11111111111"},"cnpj":{"description":"CNPJ do pagador cadastrado na cobrança.","type":"string","example":"11111111111111"},"locationPresente":{"description":"Filtro pela existência de location vinculada.","type":"boolean","example":true},"status":{"description":"Filtro pelo status das cobranças.","type":"boolean","example":true},"paginacao":{"description":"","type":"object","properties":{"paginaAtual":{"description":"Numero da Página que deseja realizar o acesso, valor considerado por default 0","type":"integer"},"itensPorPagina":{"description":"Quantidade de ocorrência retornadas por Página, valor por default 100","type":"integer","example":100},"quantidadeDePaginas":{"description":"Quantidade de páginas disponíveis para consulta.","type":"integer","example":1},"quantidadeTotalDeItens":{"description":"Quantidade total de itens disponíveis de acordo com os parâmetros informados.","type":"integer","example":1}},"required":["paginaAtual","itensPorPagina","quantidadeDePaginas","quantidadeTotalDeItens"]}},"required":["inicio","fim"]},"cobs":{"description":"Estrutura com informações referentes a cobranca do documento","type":"array","items":{"$ref":"#/components/schemas/cobranca"}}},"required":["cobs"]},"cobrancasVencimento":{"type":"object","description":"","properties":{"parametros":{"description":"","type":"object","properties":{"inicio":{"description":"Data inicial. Respeita RFC 3339.","type":"string","example":"2020-04-01T00:00:00Z"},"fim":{"description":"Data de fim. Respeita RFC 3339.","type":"string","example":"2020-04-01T23:59:59Z"},"txid":{"description":"ID de identificação do documento entre os bancos e o cliente emissor. O campo txid é obrigatório e determina o identificador da transação.O objetivo desse campo é ser um elemento que possibilite a conciliação de pagamentos. O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. Deve ser único por CNPJ do recebedor. Apesar de possuir o tamanho de 35 posições (PAC008), para QR Code Estático o tamanho máximo permitido é de 25 posições (limitação EMV). No caso do QR Code dinâmico o campo deve possuir de 26 posição até 35 posições. Os caracteres permitidos no contexto do Pix para o campo txId são:Letras minúsculas, de ‘a’ a ‘z’, Letras maiúsculas, de ‘A’ a ‘Z’, Dígitos decimais, de ‘0’ a ‘9’","type":"string","example":"7978c0c97ea85656654648e88496344"},"txIdPresente":{"description":"Indicador do indentificador da taxa.","type":"boolean","example":true},"devolucaoPresente":{"description":"Indicador de devolução.","type":"boolean","example":true},"cpf":{"description":"CPF do pagador cadastrado na cobrança","type":"string","example":"11111111111"},"cnpj":{"description":"CNPJ do pagador cadastrado na cobrança.","type":"string","example":"11111111111111"},"locationPresente":{"description":"Filtro pela existência de location vinculada.","type":"boolean","example":true},"status":{"description":"Filtro pelo status das cobranças.","type":"boolean","example":true},"paginacao":{"description":"","type":"object","properties":{"paginaAtual":{"description":"Numero da Página que deseja realizar o acesso, valor considerado por default 0","type":"integer"},"itensPorPagina":{"description":"Quantidade de ocorrência retornadas por pagina, valor por default 100","type":"integer","example":100},"quantidadeDePaginas":{"description":"Quantidade de páginas disponíveis para consulta.","type":"integer","example":1},"quantidadeTotalDeItens":{"description":"Quantidade total de itens disponíveis de acordo com os parâmetros informados.","type":"integer","example":1}},"required":["paginaAtual","itensPorPagina","quantidadeDePaginas","quantidadeTotalDeItens"]}},"required":["inicio","fim"]},"cobs":{"description":"Estrutura com informações referentes a cobranca com vencimento do documento","type":"array","items":{"type":"object","description":"","properties":{"calendario":{"$ref":"#/components/schemas/calendario"},"devedor":{"$ref":"#/components/schemas/devedor"},"loc":{"$ref":"#/components/schemas/loc"},"valor":{"$ref":"#/components/schemas/cobrancaVencimentoPutRequest/properties/valor"},"chave":{"title":"Chave","description":"**Descrição:** Chave Pix do Sistema DICT - BACEN.\n","type":"string","example":"a1f4102e-a446-4a57-bcce-6fa48899c1d1"},"solicitacaoPagador":{"description":"O campo solicitacaoPagador, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor","type":"string","example":"Informar cartão fidelidade"},"infoAdicionais":{"description":"Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador","type":"array","items":{"$ref":"#/components/schemas/informacaoAdicional"}},"txid":{"description":"O campo txid determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite a conciliação de pagamentos. O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. Deve ser único por CNPJ do recebedor. Para Code dinâmico o campo deve possuir de 26 posição até 35 posições. Os caracteres permitidos no contexto do Pix para o campo txId são: Letras minúsculas, de ‘a’ a ‘z’, Letras maiúsculas, de ‘A’ a ‘Z’, Dígitos decimais, de ‘0’ a ‘9’","type":"string","example":"7978c0c97ea85656654648e88496344"},"revisao":{"title":"Revisão","description":"**Descrição:** Quantidade de revisões da cobrança.\n","type":"integer","example":1},"recebedor":{"$ref":"#/components/schemas/recebedor"},"status":{"description":"Status do registro da cobrança.
ENUM
ATIVA
CONCLUIDA
REMOVIDA_PELO_USUARIO_RECEBEDOR
REMOVIDA_PELO_PSP
\n","type":"string","example":"ATIVA"},"pixCopiaECola":{"description":"Este campo retorna o valor do Pix Copia e Cola correspondente à cobrança. Trata-se da sequência de caracteres que representa o BR Code.","type":"string","example":"00020101021226860014BR.GOV.BCB.PIX2564spi-h.itau.com.br/pix/qr/v1/c3d189b4-c859-4218-b9de-b44594755a2e5204000053039865802BR5924PMD XA da Silva Einstein6009SAO PAULO62070503***63045E66"},"pix":{"description":"**Descrição:** Lista de Pix recebidos\n","type":"array","items":{"$ref":"#/components/schemas/pix"}}},"required":["calendario","devedor","valor","chave","txid","revisao","recebedor","status"]}}},"required":["cobs"]},"pixs":{"type":"object","description":"","properties":{"parametros":{"description":"","type":"object","properties":{"inicio":{"description":"Data inicial. Respeita RFC 3339.","type":"string","example":"2020-04-01T00:00:00Z"},"fim":{"description":"Data de fim. Respeita RFC 3339.","type":"string","example":"2020-04-01T23:59:59Z"},"txid":{"description":"ID de identificação do documento entre os bancos e o cliente emissor. O campo txid é obrigatório e determina o identificador da transação.O objetivo desse campo é ser um elemento que possibilite a conciliação de pagamentos. O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. Deve ser único por CNPJ do recebedor. Apesar de possuir o tamanho de 35 posições (PAC008), para QR Code Estático o tamanho máximo permitido é de 25 posições (limitação EMV). No caso do QR Code dinâmico o campo deve possuir de 26 posição até 35 posições. Os caracteres permitidos no contexto do Pix para o campo txId são:Letras minúsculas, de ‘a’ a ‘z’, Letras maiúsculas, de ‘A’ a ‘Z’, Dígitos decimais, de ‘0’ a ‘9’","type":"string"},"txIdPresente":{"description":"Indicador do indentificador da taxa.","type":"boolean"},"devolucaoPresente":{"description":"Indicador de devolução.","type":"boolean"},"cpf":{"description":"CPF do pagador cadastrado na cobrança","type":"string"},"cnpj":{"description":"CNPJ do pagador cadastrado na cobrança.","type":"string"},"paginacao":{"description":"","type":"object","properties":{"paginaAtual":{"description":"Numero da Página que deseja realizar o acesso, valor considerado por default 0","type":"integer"},"itensPorPagina":{"description":"Quantidade de ocorrência retornadas por pagina, valor por default 100","type":"integer","example":100},"quantidadeDePaginas":{"description":"Quantidade de páginas disponíveis para consulta.","type":"integer","example":1},"quantidadeTotalDeItens":{"description":"Quantidade total de itens consultados","type":"integer","example":1}}}}},"pix":{"description":"Devolucoes registradas no documento","type":"array","items":{"$ref":"#/components/schemas/pix"}}}},"devolucaoPix":{"$ref":"#/components/schemas/devolucao"},"devolucaoPutRequest":{"type":"object","title":"Devolução Solicitada","description":"**Descrição:** Dados para solicitação de devoluções.\n","properties":{"valor":{"title":"Valor","description":"**Descrição:** Valor solicitado para devolução. A soma dos valores de todas as devolucões não podem ultrapassar o valor total do Pix.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"},"natureza":{"title":"Natureza da Devolução Solicitada","description":"**Descrição:** Indica qual é a natureza da devolução solicitada. Uma solicitação de devolução pelo usuário recebedor pode ser relacionada a um Pix comum (com código: `MD06` da pacs.004), ou a um Pix de Saque ou Troco (com códigos possíveis: `MD06` e `SL02` da pacs.004). Na ausência deste campo a natureza deve ser interpretada como sendo de um Pix comum (`ORIGINAL`).\n\n**Observação:** As naturezas são assim definidas:\n`ORIGINAL`: quando a devolução é solicitada pelo usuário recebedor e se refere a um Pix comum ou ao valor da compra em um Pix Troco (`MD06`);\n\n`RETIRADA`: quando a devolução é solicitada pelo usuário recebedor e se refere a um Pix Saque ou ao valor do troco em um Pix Troco (`SL02`).\n\nOs valores de devoluções são sempre limitados aos valores máximos a seguir:\n**Pix comum:** o valor da devolução é limitado ao valor do próprio Pix (a natureza nesse caso deve ser: `ORIGINAL`);\n\n**Pix Saque:** o valor da devolução é limitado ao valor da retirada (a natureza nesse caso deve ser: `RETIRADA`); e\n\n**Pix Troco:** o valor da devolução é limitado ao valor relativo à compra ou ao troco:\n\nQuando a devolução for referente à compra, o valor limita-se ao valor da compra (a natureza nesse caso deve ser `ORIGINAL`); e\n\nQuando a devolução for referente ao troco, o valor limita-se ao valor do troco (a natureza nesse caso deve ser `RETIRADA`).\n","type":"string","enum":["ORIGINAL","RETIRADA"]},"descricao":{"title":"Mensagem ao Pagador","description":"**Descrição:** O campo `descricao`, opcional, determina um texto a ser apresentado ao pagador contendo informações sobre a devolução. Esse texto será preenchido, na pacs.004, pelo PSP do recebedor, no campo `RemittanceInformation`. O tamanho do campo na pacs.004 está limitado a 140 caracteres.\n","type":"string","maxLength":140}},"required":["valor"]},"devolucaoPutResponse":{"type":"object","title":"Devolução Realizada","description":"**Descrição:** Dados da solicitação de devolução realizada.\n","properties":{"id":{"title":"Identificador da Devolução","description":"**Descrição:** Id gerado pelo cliente para representar unicamente uma devolução.\n","type":"string","pattern":"[a-zA-Z0-9]{1,35}"},"rtrId":{"title":"RtrId","description":"**Descrição:** ReturnIdentification que transita na PACS004.\n","type":"string","pattern":"[a-zA-Z0-9]{32}","minLength":32,"maxLength":32},"valor":{"title":"Valor a Devolver","description":"**Descrição:** Valor a devolver.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"},"natureza":{"title":"Natureza da Devolução","description":"**Descrição:** Indica qual é a natureza da devolução. Uma devolução pode ser relacionada a um Pix comum (com códigos possíveis: `MD06`, `BE08` e `FR01` da pacs.004), ou a um Pix de Saque ou Troco (com códigos possíveis: `MD06` e `SL02` da pacs.004). Na ausência deste campo a natureza deve ser interpretada como sendo de um Pix comum (`ORIGINAL`).\n\n**Observação:** As naturezas são assim definidas:\n\n`ORIGINAL`: quando a devolução é solicitada pelo usuário recebedor e se refere a um Pix comum ou ao valor da compra em um Pix Troco (MD06);\n\n`RETIRADA`: quando a devolução é solicitada pelo usuário recebedor e se refere a um Pix Saque ou ao valor do troco em um Pix Troco (SL02);\n\n`MED_OPERACIONAL`: quando a devolução ocorre no âmbito do `MED` por motivo de falha operacional e se refere a um Pix comum (`BE08`);\n\n`MED_FRAUDE`: quando a devolução ocorre no âmbito do `MED` por fundada suspeita de fraude e se refere a um Pix comum (`FR01`).\n\nOs valores de devoluções são sempre limitados aos valores máximos a seguir:\n\n**Pix comum:** o valor da devolução é limitado ao valor do próprio Pix (a natureza nesse caso pode ser: `ORIGINAL`, `MED_OPERACIONAL` ou `MED_FRAUDE`);\n\n**Pix Saque:** o valor da devolução é limitado ao valor da retirada (a natureza nesse caso deve ser: `RETIRADA`); e\n\n**Pix Troco:** o valor da devolução é limitado ao valor relativo à compra ou ao troco:\n\nQuando a devolução for referente à compra, o valor limita-se ao valor da compra (a natureza nesse caso deve ser `ORIGINAL`); e\n\nQuando a devolução for referente ao troco, o valor limita-se ao valor do troco (a natureza nesse caso deve ser `RETIRADA`).\n","type":"string"},"descricao":{"title":"Mensagem ao Pagador","description":"**Descrição:** O campo `descricao`, opcional, determina um texto a ser apresentado ao pagador contendo informações sobre a devolução. Esse texto será preenchido, na pacs.004, pelo PSP do recebedor, no campo `RemittanceInformation`. O tamanho do campo na pacs.004 está limitado a 140 caracteres.\n","type":"string","maxLength":140},"horario":{"title":"Horário","description":"**Descrição:** Estrutura que retorna o periodo da devolução.\n","type":"object","properties":{"solicitacao":{"title":"Horário de Solicitação","description":"**Descrição:** Horário no qual a devolução foi solicitada no PSP.\n\n**Tipo do campo:** string($date-time).\n","type":"string"},"liquidacao":{"title":"Horário de Liquidação","description":"**Descrição:** Horário no qual a devolução foi liquidada no PSP.\n\n**Tipo do campo:** string($date-time).\n","type":"string"}}},"status":{"title":"Status","description":"**Descrição:** Status da Devolução.\n","enum":["EM_PROCESSAMENTO","DEVOLVIDO","NAO_REALIZADO"],"type":"string"},"motivo":{"title":"Descrição do Status","description":"**Descrição:** Campo opcional que pode ser utilizado pelo PSP recebedor para detalhar os motivos de a devolução ter atingido o status em questão. Pode ser utilizado, por exemplo, para detalhar o motivo de a devolução não ter sido realizada.\n","type":"string","maxLength":140}},"required":["id","rtrId","valor","status","horario"]},"locs":{"type":"object","description":"","properties":{"parametros":{"description":"","type":"object","properties":{"inicio":{"description":"Data inicial. Respeita RFC 3339.","type":"string","example":"2020-04-01T00:00:00Z"},"fim":{"description":"Data de fim. Respeita RFC 3339.","type":"string","example":"2020-04-01T23:59:59Z"},"txIdPresente":{"description":"Filtro pela existência de txid.","type":"boolean","example":true},"tipoCob":{"description":"Define se o tipo do documento é imediata ou vencimento\n
ENUM
cob
cobv
\n","type":"string","example":"cob"},"paginacao":{"description":"","type":"object","properties":{"paginaAtual":{"description":"Numero da Página que deseja realizar o acesso, valor considerado por default 0","type":"integer"},"itensPorPagina":{"description":"Quantidade de ocorrência retornadas por pagina, valor por default 100","type":"integer","example":100},"quantidadeDePaginas":{"description":"Quantidade de páginas disponíveis para consulta.","type":"integer","example":1},"quantidadeTotalDeItens":{"description":"Quantidade total de itens consultados","type":"integer","example":1}},"required":["paginaAtual","itensPorPagina","quantidadeDePaginas","quantidadeTotalDeItens"]}},"required":["inicio","fim"]},"loc":{"description":"Locations registrados no documento","type":"array","items":{"$ref":"#/components/schemas/loc"}}},"required":["loc"]},"qrcode":{"type":"object","description":"","properties":{"pix_link":{"description":"URL do PIX para consulta do payload criptografado - Pix Link BACEN","type":"string","example":"https://pix.bcb.gov.br/qr/MDAwMjAxMDEwMjEyMjY4NjAwMTRCUi5HT1YuQkNCLlBJWDI1NjRzcGktaC5pdGF1LmNvbS5ici9waXgvcXIvdjEvYzNkMTg5YjQtYzg1OS00MjE4LWI5ZGUtYjQ0NTk0NzU1YTJlNTIwNDAwMDA1MzAzOTg2NTgwMkJSNTkyNFBNRCBYQSBkYSBTaWx2YSBFaW5zdGVpbjYwMDlTQU8gUEFVTE82MjA3MDUwMyoqKjYzMDQ1RTY2"},"emv":{"description":"Texto do QR CODE no padrao EMVco","type":"string","example":"00020101021226860014BR.GOV.BCB.PIX2564spi-h.itau.com.br/pix/qr/v1/c3d189b4-c859-4218-b9de-b44594755a2e5204000053039865802BR5924PMD XA da Silva Einstein6009SAO PAULO62070503***63045E66"},"imagem_base64":{"description":"Imagem em base64 do QRCODE PIX","type":"string","example":"iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAAC3ElEQVR4Xu2XQW7kMAwEpY+I///FPkX6iLxVVJDxzCHYQ4Z7GcFwbKkCMGSz6bTr5/Wnve68rA9w1gc46wOc9W/AbK3vuNaOPTrX2i2Wm4XA4prheeuzQY2Y3c1KIF8Jk1tnm9fdz2YpMEfsWBxcZGm3Ef8B2I0CcUiqOMjU1QJcRIlYPJujk6rcLATU53pdr6p+Pf9lIJfNYq04IsgRX9tVwLRCMxRqa220MVqQt4SqALo2slto2qZ/2Mi+FQLTFOEZl62jcrGRZsyFwMY9kexEtF9G1s3e+BZMAcBJM0dcJ0vAYTMVAiQJlRCg/bpzuFw2sT/KAKRqfTgaVImz0FdvxSoAHKjLzjE7+ll3qjxMrADgDANVsSbMvtVHbkEWAEaJVEyOZTNV2b8eVQEaxwhd9HKULSfcMHmFgJ3Txfy8sVihhG7NWwCQHgS7jJAOppEN1F+rBAhnd3QSF7eTpCDSKASyb1VpRjuMkb1b41QAJok+cb57Yra6Y6YQ4Gyxv50kKjYFvLJgZcBlSMNJxgPAeZgPMy8AzE7Lubp8UMTG+yhWCUBiTA2jBdFSOhV7M5ACgCpZJEIUI0fpH2wWApcfdn7pYB49u9hvnuvRvAXAUq7aRjDLTJv3ZQLrAL6qsjI6iMnSzShWVAJskioLZWj7fOakgAoBYsTDESwe3q1aesi9ed8OoJBuWGHGwoRdKviWyfcDGQ83vrz7l6NTtvtf8X6AV1xjOdJ44uS07qN5CwB9W6Uq1CxWPt2CLAC2xrHyzu5SxUMz+y5WBXBaxWAbSQrH2VbBhQBVWQKONGbZpY08mXkB4EIfTekaKBkbz9P//YAREVbX1dUuM21oYd/FKgCUiBz56UZrgP3+sVcB4BsGeYqlVPpzsYqAedwb2ZixTN6jWEUABppDRBsFA9ye1wHJ2L328UrNAD9X881AVsaumYZIscJ/0u3pOuCn9QHO+gBnfYCzfgH4C2GVFDHlHIBpAAAAAElFTkSuQmCC"}},"required":["pix_link","emv","imagem_base64"]},"webhook":{"type":"object","description":"","properties":{"webhookUrl":{"description":"URL para chamada webhook de aviso de recebimento pix","type":"string","example":"https://pix.example.com/api/webhook/"},"chave":{"description":"Chave de endereçamento do recebedor cadastrada na DICT","type":"string","example":"chave@email.com"},"criacao":{"description":"Data e hora de criação do webhook em formato de acordo com RFC 3339","type":"string","example":"2020-04-01T00:00:00Z"}},"required":["webhookUrl","chave","criacao"]},"webhookPut":{"type":"object","description":"","properties":{"webhookUrl":{"description":"URL para chamada webhook de aviso de recebimento pix","type":"string","example":"https://pix.example.com/api/webhook/"}},"required":["webhookUrl"]},"webhooks":{"type":"object","description":"","properties":{"parametros":{"description":"","type":"object","properties":{"inicio":{"description":"Data inicial. Respeita RFC 3339.","type":"string","example":"2020-04-01T00:00:00Z"},"fim":{"description":"Data fim da criação do webhook, em formato de acordo com RFC 3339.","type":"string","example":"2021-04-01T00:00:00Z"},"paginacao":{"description":"","type":"object","properties":{"paginaAtual":{"description":"Numero da Página que deseja realizar o acesso, valor considerado por default 0","type":"integer","example":1},"itensPorPagina":{"description":"Quantidade de ocorrência retornadas por pagina, valor por default 100","type":"integer","example":10},"quantidadeDePaginas":{"description":"Quantidade de páginas disponíveis para consulta.","type":"integer","example":5},"quantidadeTotalDeItens":{"description":"Quantidade total de itens consultados","type":"integer","example":50}},"required":["paginaAtual","itensPorPagina","quantidadeDePaginas","quantidadeTotalDeItens"]}}},"webhooks":{"description":"Webhooks cadastrados para o cliente","type":"array","items":{"$ref":"#/components/schemas/webhook"}}},"required":["webhooks"]},"location":{"type":"object","title":"Location do Payload","description":"**Descrição:** Dados da localização do payload.\n","properties":{"id":{"title":"Identificador da Localização do Payload","description":"**Descrição:** Identificador da URL do PIX para consulta do payload criptografado - pix link BACEN.\n\n**Tipo do campo:** integer($int64).\n","type":"integer","readOnly":true},"location":{"title":"Localização do Payload","description":"**Descrição:** URL do PIX para consulta do payload criptografado - pix link BACEN.\n\n**Tipo do campo:** string($uri).\n","type":"string","maxLength":77,"readOnly":true},"tipoCob":{"title":"Tipo da Cobrança","description":"**Descrição:** Define se o tipo do documento é imediata ou vencimento.\n","enum":["cob","cobv"],"type":"string"},"criacao":{"title":"Data de Criação","description":"**Descrição:** Data e hora de criação da localização da cobrança.\n\n**Observação:** Respeita RFC 3339.\n\n**Tipo do campo:** string($date-time).\n","type":"string","readOnly":true}},"required":["id","location","tipoCob","criacao"]},"saqueCv":{"type":"object","description":"","properties":{"valor":{"description":"Valor nominal do saque.","type":"string","example":"10.00"},"modalidadeAgente":{"description":"Modalidade do Agente\n
SIGLADescrição
AGTECAgente Estabelecimento Comercial
AGTOTAgente Outra Espécie de Pessoa Jurí­dica
AGPSSAgente Prestador de Serviço de Saque
\n","type":"string","example":"AGTEC"},"prestadorDoServicoDeSaque":{"description":"ISPB do Facilitador de Serviço de Saque","type":"string","example":"60701190"}},"required":["valor","modalidadeAgente","prestadorDoServicoDeSaque"]},"trocoCv":{"type":"object","description":"","properties":{"valor":{"description":"Valor do troco.","type":"string","example":"10.00"},"modalidadeAgente":{"description":"Modalidade do Agente\n
SIGLADescrição
AGTECAgente Estabelecimento Comercial
AGTOTAgente Outra Espécie de Pessoa Jurídica ou Correspondente no País
\n","type":"string","example":"AGTEC"},"prestadorDoServicoDeSaque":{"description":"ISPB do Facilitador de Serviço de Saque","type":"string","example":"60701190"}},"required":["valor","prestadorDoServicoDeSaque"]},"pessoa":{"type":"object","title":"Devedor","description":"**Descrição:** Campo que organiza a identificação do devedor, ou seja, a pessoa ou instituição a quem a cobrança está endereçada. Não identifica, necessariamente, quem irá efetivamente realizar o pagamento.\n\n**Observação:** Campo retornado somente se o parâmetro de entrada foi colocado na requisição.\n\nNão é permitido que o campo `devedor.cpf` e campo `devedor.cnpj` estejam preenchidos ao mesmo tempo. Se o campo `devedor.cnpj` está preenchido, então o campo `devedor.cpf` não pode estar preenchido, e vice-versa. Se o campo devedor.nome está preenchido, então deve existir ou um `devedor.cpf` ou um campo `devedor.cnpj` preenchido.\n","properties":{"cpf":{"description":"**Descrição:** Número do Documento Cadastro de Pessoa Física.\n\n**Observação:** Se preenchido, não enviar CNPJ.\n","type":"string","title":"CPF","pattern":"/^\\d{11}$/"},"cnpj":{"description":"**Descrição:** Número do Cadastro Nacional da Pessoa Jurídica.\n\n**Observação:** Se preenchido, não enviar CPF.\n","type":"string","title":"CNPJ","pattern":"/^\\d{14}$/"},"nome":{"description":"**Descrição:** Nome do pagador da cobrança. \n\n**Observação:** Necessário preencher o campo CNPJ ou o campo CPF.\n","type":"string","title":"Nome","maxLength":200}},"required":["cpf","cnpj","nome"]},"cobrancaImediataPutRequest":{"type":"object","title":"Cobrança imediata solicitada","description":"**Descrição:** Dados enviados para criação ou alteração da cobrança imediata via API Pix.\n","properties":{"calendario":{"title":"Calendário","description":"**Descrição:** Objeto que organiza informações a respeito de controle de tempo da cobrança.\n","type":"object","properties":{"expiracao":{"title":"Expiração","description":"**Descrição:** Tempo de vida da cobrança, especificado em segundos a partir da data de criação da cobrança (`calendario.criacao`).\n\n**Observação:** Caso o campo expiracao não seja preenchido, ele terá um tempo de vida padrão de 86400 segundos.\n\n**Tipo do campo:** integer($int32).\n","type":"integer"}}},"devedor":{"$ref":"#/components/schemas/pessoa"},"loc":{"title":"Location do Payload","description":"**Descrição:** Estrutura com informações do identificador da localização do payload.\n\n**Observação:** A localização é a URL onde os dados cobrança são exibidos.\n","type":"object","properties":{"id":{"title":"Identificador da Localização do Payload","description":"**Descrição:** Identificador da localização do payload a ser informado na criação da cobrança.\n","type":"integer"}},"required":["id"]},"valor":{"title":"Valor da Cobrança Imediata","description":"**Descrição:** Campo que organiza os valores monetários referentes à cobrança.\n","type":"object","properties":{"original":{"title":"Valor","description":"**Descrição:** Valor nominal/original da cobrança.\n\n**Observação:** O valor deve ser maior do que zero. Todos os campos que indicam valores monetários obedecem ao formato do ID 54 da especificação EMV/BR Code para QR Codes. O separador decimal é o caractere ponto. Não é aplicável utilizar separador de milhar. Exemplos de valores aderentes ao padrão: “0.00”, “1.00”, “123.99”, “123456789.23”.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"},"modalidadeAlteracao":{"title":"Modalidade de Alteração","description":"**Descrição:** Trata-se de um campo que determina se o valor final do documento pode ser alterado pelo pagador. \n\n**Observação:** Na ausência desse campo, assume-se que não se pode alterar o valor do documento de cobrança, ou seja, assume-se o valor 0.\n\nSe o campo estiver presente e com valor 1, então está determinado que o valor final da cobrança pode ter seu valor alterado pelo pagador.\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":0,"maximum":1},"retirada":{"$ref":"#/components/schemas/retirada"}},"required":["original"]},"chave":{"title":"Chave DICT do Recebedor","description":"**Descrição:** Campo que organiza a chave Pix do cliente registrada na DICT que será utilizada para recebimento da cobrança.\n","type":"string","maxLength":77},"solicitacaoPagador":{"title":"Solicitação ao Pagador","description":"**Descrição:** O campo `solicitacaoPagador`, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. \n\n**Observação:** Esse texto será preenchido, na **pacs.008**, pelo PSP do pagador, no campo `RemittanceInformation`. O tamanho do campo na pacs.008 está limitado a **140 caracteres**.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"string","maxLength":140},"infoAdicionais":{"title":"Informações Adicionais","description":"**Descrição:** Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.\n\n**Observação:** Pode-se adicionar quantas informações adicionais desejar.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"array","maximum":50,"items":{"$ref":"#/components/schemas/informacaoAdicional"}}},"required":["valor","chave","calendario"]},"cobrancaImediataPutResponse":{"type":"object","title":"Cobrança Imediata Gerada","description":"**Descrição:** Dados criados ou alterados da cobrança imediata via API Pix.\n","properties":{"calendario":{"title":"Calendário","description":"**Descrição:** Objeto que organiza informações a respeito de controle de tempo da cobrança.\n","type":"object","properties":{"criacao":{"title":"Data de Criação","description":"**Descrição:** Timestamp que indica o momento em que foi criada a cobrança.\n\n**Observação:** Respeita o RFC 3339.\n\n**Tipo do campo:** string($date-time).\n","type":"string"},"expiracao":{"title":"Expiração","description":"**Descrição:** Tempo de vida da cobrança, especificado em segundos a partir da data de criação da cobrança (`calendario.criacao`).\n\n**Observação:** Caso o campo expiracao não seja preenchido, ele terá um tempo de vida padrão de 86400 segundos.\n\n**Tipo do campo:** integer($int32).\n","type":"integer"}},"required":["criacao","expiracao"]},"txid":{"title":"Identificador do QR Code","description":"**Descrição:** O campo `txid` determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.\n\n**Observação:** Na pacs.008, é referenciado como `TransactionIdentification ` ou `idConciliacaoRecebedor`.\n\nEm termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.\n\nO txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de um QR Code, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.\n\nEste código deve possuir entre 26 e 35 posições, podendo conter letras minúsculas (a-z), letras maiúsculas (A-Z) e números (0-9).\n","type":"string","pattern":"[a-zA-Z0-9]{26,35}"},"revisao":{"title":"Revisão","description":"**Descrição:** Quantidade de revisões que a cobrança teve.\n\n**Observação:** Sempre começa em zero. Quando a cobrança é alterada esse valor é incrementado (sempre com acréscimos de 1).\n\nO incremento em uma cobrança deve ocorrer sempre que um objeto da cobrança em questão for alterado. O campo `loc` é uma exceção a esta regra.\n\nSe em uma determinada alteração em uma cobrança, o único campo alterado for o campo `loc`, então esta operação não incrementa a revisão da cobrança.\n\nO campo `loc` não ocasiona uma alteração na cobrança em si. Não é necessário armazenar histórico das alterações do campo `loc` para uma determinada cobrança. Para os outros campos da cobrança, registra-se histórico.\n\n**Tipo do campo:** integer($int32).\n","type":"integer","readOnly":true},"devedor":{"$ref":"#/components/schemas/pessoa"},"loc":{"$ref":"#/components/schemas/loc"},"location":{"title":"Localização do Payload","description":"**Descrição:** URL com a localização do payload informado na criação da cobrança.\n\n**Tipo do campo:** string($uri).\n","type":"string","maxLength":77,"readOnly":true},"status":{"title":"Status","description":"**Descrição:** Status da cobrança. Na criação da cobrança será enviada sempre com o status \"ATIVA\". Caso tenha alterações no status desse QrCode, as opções de valor do campo são: `ATIVA`, `CONCLUIDA`, `REMOVIDA_PELO_PSP`, `REMOVIDA_PELO_USUARIO_RECEBEDOR`.\n\n**Observação:** Estado do registro da cobrança. Não se confunde com o estado da cobrança em si, ou seja, não guarda relação com o fato de a cobrança encontrar-se vencida ou expirada, por exemplo.\n","maxLength":31,"enum":["ATIVA","CONCLUIDA","REMOVIDA_PELO_USUARIO_RECEBEDOR","REMOVIDA_PELO_PSP"],"type":"string"},"valor":{"title":"Valor da Cobrança Imediata","description":"**Descrição:** Campo que organiza os valores monetários referentes à cobrança.\n","type":"object","properties":{"original":{"title":"Valor","description":"**Descrição:** Valor nominal/original da cobrança.\n\n**Observação:** O valor deve ser maior do que zero. Todos os campos que indicam valores monetários obedecem ao formato do ID 54 da especificação EMV/BR Code para QR Codes. O separador decimal é o caractere ponto. Não é aplicável utilizar separador de milhar. Exemplos de valores aderentes ao padrão: “0.00”, “1.00”, “123.99”, “123456789.23”.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"},"modalidadeAlteracao":{"title":"Modalidade de Alteração","description":"**Descrição:** Trata-se de um campo que determina se o valor final do documento pode ser alterado pelo pagador. \n\n**Observação:** Na ausência desse campo, assume-se que não se pode alterar o valor do documento de cobrança, ou seja, assume-se o valor 0.\n\nSe o campo estiver presente e com valor 1, então está determinado que o valor final da cobrança pode ter seu valor alterado pelo pagador.\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":0,"maximum":1},"retirada":{"$ref":"#/components/schemas/retirada"}},"required":["original"]},"pixCopiaECola":{"title":"Pix Copia e Cola","description":"**Descrição:** Este campo retorna o valor do Pix Copia e Cola correspondente à cobrança. Trata-se da sequência de caracteres que representa o BR Code.\n","type":"string","maxLength":512},"chave":{"title":"Chave DICT do Recebedor","description":"**Descrição:** Campo que contém a chave Pix registrada na DICT que será utilizada para recebimento da cobrança.\n","type":"string","maxLength":77},"solicitacaoPagador":{"title":"Solicitação ao Pagador","description":"**Descrição:** O campo `solicitacaoPagador`, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor.\n\n**Observação:** Esse texto será preenchido, na **pacs.008**, pelo PSP do pagador, no campo `RemittanceInformation`. O tamanho do campo na pacs.008 está limitado a **140 caracteres**.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"string","maxLength":140},"infoAdicionais":{"title":"Informações Adicionais","description":"**Descrição:** Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.\n\n**Observação:** Pode-se adicionar quantas informações adicionais desejar.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"array","maximum":50,"items":{"$ref":"#/components/schemas/informacaoAdicional"}}},"required":["status","txid","revisao","valor","chave","calendario"]},"cobrancaImediataPatchRequest":{"type":"object","title":"Cobrança imediata revisada","description":"**Descrição:** Dados enviados para revisão da cobrança imediata via API Pix\n","properties":{"calendario":{"title":"Calendário","description":"**Descrição:** Objeto que organiza informações a respeito de controle de tempo da cobrança.\n","type":"object","properties":{"expiracao":{"title":"Expiração","description":"**Descrição:** Tempo de vida da cobrança, especificado em segundos a partir da data de criação da cobrança (`calendario.criacao`).\n\n**Observação:** Caso o campo expiracao não seja preenchido, ele terá um tempo de vida padrão de 86400 segundos.\n\n**Tipo do campo:** integer($int32).\n","type":"integer"}}},"devedor":{"$ref":"#/components/schemas/pessoa"},"loc":{"title":"Location do Payload","description":"**Descrição:** Estrutura com informações do identificador da localização do payload.\n\n**Observação:** A localização é a URL onde os dados cobrança são exibidos.\n","type":"object","properties":{"id":{"title":"Identificador da Localização do Payload","description":"**Descrição:** Identificador da localização do payload a ser informado na criação da cobrança.\n","type":"integer"}},"required":["id"]},"status":{"title":"Status","description":"**Descrição:** Status da cobrança. Na alteração da cobrança será enviada sempre com o status \"REMOVIDA_PELO_USUARIO_RECEBEDOR\".\n\n**Observação:** Estado do registro da cobrança. Não se confunde com o estado da cobrança em si, ou seja, não guarda relação com o fato de a cobrança encontrar-se vencida ou expirada, por exemplo.\n","enum":["REMOVIDA_PELO_USUARIO_RECEBEDOR"],"type":"string","example":"REMOVIDA_PELO_USUARIO_RECEBEDOR"},"valor":{"title":"Valor da Cobrança Imediata","description":"**Descrição:** Campo que organiza os valores monetários referentes à cobrança.\n","type":"object","properties":{"original":{"title":"Valor","description":"**Descrição:** Valor nominal/original da cobrança.\n\n**Observação:** O valor deve ser maior do que zero. Todos os campos que indicam valores monetários obedecem ao formato do ID 54 da especificação EMV/BR Code para QR Codes. O separador decimal é o caractere ponto. Não é aplicável utilizar separador de milhar. Exemplos de valores aderentes ao padrão: “0.00”, “1.00”, “123.99”, “123456789.23”.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"},"modalidadeAlteracao":{"title":"Modalidade de Alteração","description":"**Descrição:** Trata-se de um campo que determina se o valor final do documento pode ser alterado pelo pagador. \n\n**Observação:** Na ausência desse campo, assume-se que não se pode alterar o valor do documento de cobrança, ou seja, assume-se o valor 0.\n\nSe o campo estiver presente e com valor 1, então está determinado que o valor final da cobrança pode ter seu valor alterado pelo pagador.\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":0,"maximum":1},"retirada":{"$ref":"#/components/schemas/retirada"}}},"chave":{"title":"Chave DICT do Recebedor","description":"**Descrição:** Campo que organiza a chave Pix do cliente registrada na DICT que será utilizada para recebimento da cobrança.\n","maxLength":77,"type":"string"},"solicitacaoPagador":{"title":"Solicitação ao Pagador","description":"**Descrição:** O campo `solicitacaoPagador`, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. \n\n**Observação:** Esse texto será preenchido, na **pacs.008**, pelo PSP do pagador, no campo `RemittanceInformation`. O tamanho do campo na pacs.008 está limitado a **140 caracteres**.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"string","maxLength":140},"infoAdicionais":{"title":"Informações Adicionais","description":"**Descrição:** Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.\n\n**Observação:** Pode-se adicionar quantas informações adicionais desejar.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"array","maximum":50,"items":{"$ref":"#/components/schemas/informacaoAdicional"}}}},"cobrancaImediataPatchResponse":{"type":"object","title":"Cobrança Imediata Revisada","description":"**Descrição:** Dados enviados para revisão da cobrança imediata via API Pix.\n","properties":{"calendario":{"title":"Calendário","description":"**Descrição:** Objeto que organiza informações a respeito de controle de tempo da cobrança.\n","type":"object","properties":{"criacao":{"title":"Data de Criação","description":"**Descrição:** Timestamp que indica o momento em que foi criada a cobrança.\n\n**Observação:** Respeita o RFC 3339.\n\n**Tipo do campo:** string($date-time).\n","type":"string"},"expiracao":{"title":"Expiração","description":"**Descrição:** Tempo de vida da cobrança, especificado em segundos a partir da data de criação da cobrança (`calendario.criacao`).\n\n**Observação:** Caso o campo expiracao não seja preenchido, ele terá um tempo de vida padrão de 86400 segundos.\n\n**Tipo do campo:** integer($int32).\n","type":"integer"}},"required":["criacao","expiracao"]},"txid":{"title":"Identificador do QR Code","description":"**Descrição:** O campo `txid` determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.\n\n**Observação:** Na pacs.008, é referenciado como `TransactionIdentification ` ou `idConciliacaoRecebedor`.\n\nEm termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.\n\nO txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de um QR Code, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.\n\nEste código deve possuir entre 26 e 35 posições, podendo conter letras minúsculas (a-z), letras maiúsculas (A-Z) e números (0-9).\n","type":"string","pattern":"[a-zA-Z0-9]{26,35}"},"revisao":{"title":"Revisão","description":"**Descrição:** Quantidade de revisões que a cobrança teve.\n\n**Observação:** Sempre começa em zero. Quando a cobrança é alterada esse valor é incrementado (sempre com acréscimos de 1).\nO incremento em uma cobrança deve ocorrer sempre que um objeto da cobrança em questão for alterado. O campo `loc` é uma exceção a esta regra.\n\nSe em uma determinada alteração em uma cobrança, o único campo alterado for o campo `loc`, então esta operação não incrementa a revisão da cobrança.\n\nO campo `loc` não ocasiona uma alteração na cobrança em si. Não é necessário armazenar histórico das alterações do campo `loc` para uma determinada cobrança. Para os outros campos da cobrança, registra-se histórico.\n\n**Tipo do campo:** integer($int32).\n","type":"integer","readOnly":true},"devedor":{"$ref":"#/components/schemas/pessoa"},"loc":{"$ref":"#/components/schemas/loc"},"location":{"title":"Localização do Payload","description":"**Descrição:** URL com a localização do payload informado na criação da cobrança.\n\n**Tipo do campo:** string($uri).\n","type":"string","maxLength":77,"readOnly":true},"status":{"title":"Status","description":"**Descrição:** Status da cobrança. Na criação da cobrança será enviada sempre com o status \"ATIVA\". Caso tenha alterações no status desse QrCode, as opções de valor do campo são: `ATIVA`, `CONCLUIDA`, `REMOVIDA_PELO_PSP`, `REMOVIDA_PELO_USUARIO_RECEBEDOR`.\n\n**Observação:** Estado do registro da cobrança. Não se confunde com o estado da cobrança em si, ou seja, não guarda relação com o fato de a cobrança encontrar-se vencida ou expirada, por exemplo.\n","maxLength":31,"enum":["ATIVA","CONCLUIDA","REMOVIDO_PELO_USUARIO_RECEBEDOR","REMOVIDO_PELO_PSP"],"type":"string"},"valor":{"title":"Valor da Cobrança Imediata","description":"**Descrição:** Campo que organiza os valores monetários referentes à cobrança.\n","type":"object","properties":{"original":{"title":"Valor","description":"**Descrição:** Valor nominal/original da cobrança.\n\n**Observação:** O valor deve ser maior do que zero. Todos os campos que indicam valores monetários obedecem ao formato do ID 54 da especificação EMV/BR Code para QR Codes. O separador decimal é o caractere ponto. Não é aplicável utilizar separador de milhar. Exemplos de valores aderentes ao padrão: “0.00”, “1.00”, “123.99”, “123456789.23”.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"},"modalidadeAlteracao":{"title":"Modalidade de Alteração","description":"**Descrição:** Trata-se de um campo que determina se o valor final do documento pode ser alterado pelo pagador. \n\n**Observação:** Na ausência desse campo, assume-se que não se pode alterar o valor do documento de cobrança, ou seja, assume-se o valor 0.\n\nSe o campo estiver presente e com valor 1, então está determinado que o valor final da cobrança pode ter seu valor alterado pelo pagador.\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":0,"maximum":1},"retirada":{"$ref":"#/components/schemas/retirada"}},"required":["original"]},"pixCopiaECola":{"title":"Pix Copia e Cola","description":"**Descrição:** Este campo retorna o valor do Pix Copia e Cola correspondente à cobrança. Trata-se da sequência de caracteres que representa o BR Code.\n","type":"string","maxLength":512},"chave":{"title":"Chave DICT do Recebedor","description":"**Descrição:** Campo que contém a chave Pix registrada na DICT que será utilizada para recebimento da cobrança.\n","type":"string","maxLength":77},"solicitacaoPagador":{"title":"Solicitação ao Pagador","description":"**Descrição:** O campo `solicitacaoPagador`, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor.\n\n**Observação:** Esse texto será preenchido, na **pacs.008**, pelo PSP do pagador, no campo `RemittanceInformation`. O tamanho do campo na pacs.008 está limitado a **140 caracteres**.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"string","maxLength":140},"infoAdicionais":{"title":"Informações Adicionais","description":"**Descrição:** Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.\n\n**Observação:** Pode-se adicionar quantas informações adicionais desejar.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"array","maximum":50,"items":{"$ref":"#/components/schemas/informacaoAdicional"}}},"required":["status","txid","revisao","valor","chave","calendario"]},"cobrancaImediataPostRequest":{"type":"object","title":"Cobrança imediata solicitada","description":"**Descrição:** Dados enviados para criação ou alteração da cobrança imediata via API Pix\n","properties":{"calendario":{"title":"Calendário","description":"**Descrição:** Objeto que organiza informações a respeito de controle de tempo da cobrança.\n","type":"object","properties":{"expiracao":{"title":"Expiração","description":"**Descrição:** Tempo de vida da cobrança, especificado em segundos a partir da data de criação da cobrança (`calendario.criacao`).\n\n**Observação:** Caso o campo expiracao não seja preenchido, ele terá um tempo de vida padrão de 86400 segundos.\n\n**Tipo do campo:** integer($int32).\n","type":"integer"}}},"devedor":{"$ref":"#/components/schemas/pessoa"},"loc":{"title":"Location do Payload","description":"**Descrição:** Estrutura com informações do identificador da localização do payload.\n\n**Observação:** A localização é a URL onde os dados cobrança são exibidos.\n","type":"object","properties":{"id":{"title":"Identificador da Localização do Payload","description":"**Descrição:** Identificador da localização do payload a ser informado na criação da cobrança.\n","type":"integer"}},"required":["id"]},"valor":{"title":"Valor da Cobrança Imediata","description":"**Descrição:** Campo que organiza os valores monetários referentes à cobrança.\n","type":"object","properties":{"original":{"title":"Valor","description":"**Descrição:** Valor nominal/original da cobrança.\n\n**Observação:** O valor deve ser maior do que zero. Todos os campos que indicam valores monetários obedecem ao formato do ID 54 da especificação EMV/BR Code para QR Codes. O separador decimal é o caractere ponto. Não é aplicável utilizar separador de milhar. Exemplos de valores aderentes ao padrão: “0.00”, “1.00”, “123.99”, “123456789.23”.\n","type":"string","example":"567.89","pattern":"\\d{1,10}\\.\\d{2}"},"modalidadeAlteracao":{"title":"Modalidade de Alteração","description":"**Descrição:** Trata-se de um campo que determina se o valor final do documento pode ser alterado pelo pagador. \n\n**Observação:** Na ausência desse campo, assume-se que não se pode alterar o valor do documento de cobrança, ou seja, assume-se o valor 0.\n\nSe o campo estiver presente e com valor 1, então está determinado que o valor final da cobrança pode ter seu valor alterado pelo pagador.\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":0,"maximum":1},"retirada":{"$ref":"#/components/schemas/retirada"}},"required":["original"]},"chave":{"title":"Chave DICT do Recebedor","description":"**Descrição:** Campo que organiza a chave Pix do cliente registrada na DICT que será utilizada para recebimento da cobrança.\n","type":"string","maxLength":77},"solicitacaoPagador":{"title":"Solicitação ao Pagador","description":"**Descrição:** O campo `solicitacaoPagador`, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. \n\n**Observação:** Esse texto será preenchido, na **pacs.008**, pelo PSP do pagador, no campo `RemittanceInformation`. O tamanho do campo na pacs.008 está limitado a **140 caracteres**.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"string","maxLength":140},"infoAdicionais":{"title":"Informações Adicionais","description":"**Descrição:** Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.\n\n**Observação:** Pode-se adicionar quantas informações adicionais desejar.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"array","maximum":50,"items":{"$ref":"#/components/schemas/informacaoAdicional"}}},"required":["valor","chave","calendario"]},"cobrancaImediataPostResponse":{"type":"object","title":"Cobrança Imediata Gerada","description":"**Descrição:** Dados criados ou alterados da cobrança imediata via API Pix.\n","properties":{"calendario":{"title":"Calendário","description":"**Descrição:** Objeto que organiza informações a respeito de controle de tempo da cobrança.\n","type":"object","properties":{"criacao":{"title":"Data de Criação","description":"**Descrição:** Timestamp que indica o momento em que foi criada a cobrança.\n\n**Observação:** Respeita o RFC 3339.\n\n**Tipo do campo:** string($date-time).\n","type":"string"},"expiracao":{"title":"Expiração","description":"**Descrição:** Tempo de vida da cobrança, especificado em segundos a partir da data de criação da cobrança (`calendario.criacao`).\n\n**Observação:** Caso o campo expiracao não seja preenchido, ele terá um tempo de vida padrão de 86400 segundos.\n\n**Tipo do campo:** integer($int32).\n","type":"integer"}},"required":["criacao","expiracao"]},"txid":{"title":"Identificador do QR Code","description":"**Descrição:** O campo `txid` determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.\n\n**Observação:** Na pacs.008, é referenciado como `TransactionIdentification ` ou `idConciliacaoRecebedor`.\n\nEm termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.\n\nO txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de um QR Code, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.\n\nEste código deve possuir entre 26 e 35 posições, podendo conter letras minúsculas (a-z), letras maiúsculas (A-Z) e números (0-9).\n","type":"string","pattern":"[a-zA-Z0-9]{26,35}"},"revisao":{"title":"Revisão","description":"**Descrição:** Quantidade de revisões que a cobrança teve.\n\n**Observação:** Sempre começa em zero. Quando a cobrança é alterada esse valor é incrementado (sempre com acréscimos de 1).\nO incremento em uma cobrança deve ocorrer sempre que um objeto da cobrança em questão for alterado. O campo `loc` é uma exceção a esta regra.\n\nSe em uma determinada alteração em uma cobrança, o único campo alterado for o campo `loc`, então esta operação não incrementa a revisão da cobrança.\n\nO campo `loc` não ocasiona uma alteração na cobrança em si. Não é necessário armazenar histórico das alterações do campo `loc` para uma determinada cobrança. Para os outros campos da cobrança, registra-se histórico.\n\n**Tipo do campo:** integer($int32).\n","type":"integer","readOnly":true},"devedor":{"$ref":"#/components/schemas/pessoa"},"loc":{"$ref":"#/components/schemas/loc"},"location":{"title":"Localização do Payload","description":"**Descrição:** URL com a localização do payload informado na criação da cobrança.\n\n**Tipo do campo:** string($uri).\n","type":"string","maxLength":77,"readOnly":true},"status":{"title":"Status","description":"**Descrição:** Status da cobrança. Na criação da cobrança será enviada sempre com o status \"ATIVA\". Caso tenha alterações no status desse QrCode, as opções de valor do campo são: `ATIVA`, `CONCLUIDA`, `REMOVIDA_PELO_PSP`, `REMOVIDA_PELO_USUARIO_RECEBEDOR`.\n\n**Observação:** Estado do registro da cobrança. Não se confunde com o estado da cobrança em si, ou seja, não guarda relação com o fato de a cobrança encontrar-se vencida ou expirada, por exemplo.\n","maxLength":31,"enum":["ATIVA","CONCLUIDA","REMOVIDA_PELO_USUARIO_RECEBEDOR","REMOVIDA_PELO_PSP"],"type":"string"},"valor":{"title":"Valor da Cobrança Imediata","description":"**Descrição:** Campo que organiza os valores monetários referentes à cobrança.\n","type":"object","properties":{"original":{"title":"Valor","description":"**Descrição:** Valor nominal/original da cobrança.\n\n**Observação:** O valor deve ser maior do que zero. Todos os campos que indicam valores monetários obedecem ao formato do ID 54 da especificação EMV/BR Code para QR Codes. O separador decimal é o caractere ponto. Não é aplicável utilizar separador de milhar. Exemplos de valores aderentes ao padrão: “0.00”, “1.00”, “123.99”, “123456789.23”.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"},"modalidadeAlteracao":{"title":"Modalidade de Alteração","description":"**Descrição:** Trata-se de um campo que determina se o valor final do documento pode ser alterado pelo pagador. \n\n**Observação:** Na ausência desse campo, assume-se que não se pode alterar o valor do documento de cobrança, ou seja, assume-se o valor 0.\n\nSe o campo estiver presente e com valor 1, então está determinado que o valor final da cobrança pode ter seu valor alterado pelo pagador.\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":0,"maximum":1},"retirada":{"$ref":"#/components/schemas/retirada"}},"required":["original"]},"pixCopiaECola":{"title":"Pix Copia e Cola","description":"**Descrição:** Este campo retorna o valor do Pix Copia e Cola correspondente à cobrança. Trata-se da sequência de caracteres que representa o BR Code.\n","type":"string","maxLength":512},"chave":{"title":"Chave DICT do Recebedor","description":"**Descrição:** Campo que contém a chave Pix registrada na DICT que será utilizada para recebimento da cobrança.\n","type":"string","maxLength":77},"solicitacaoPagador":{"title":"Solicitação ao Pagador","description":"**Descrição:** O campo `solicitacaoPagador`, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor.\n\n**Observação:** Esse texto será preenchido, na **pacs.008**, pelo PSP do pagador, no campo `RemittanceInformation`. O tamanho do campo na pacs.008 está limitado a **140 caracteres**.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"string","maxLength":140},"infoAdicionais":{"title":"Informações Adicionais","description":"**Descrição:** Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.\n\n**Observação:** Pode-se adicionar quantas informações adicionais desejar.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"array","maximum":50,"items":{"$ref":"#/components/schemas/informacaoAdicional"}}},"required":["status","txid","revisao","valor","chave","calendario"]},"cobrancaVencimentoPatchRequest":{"type":"object","title":"Cobrança com Vencimento Revisada","description":"**Descrição:** Dados enviados para revisão da cobrança com vencimento via API Pix.\n","properties":{"calendario":{"title":"Calendário","description":"**Descrição:** Objeto que organiza informações a respeito de controle de tempo da cobrança.\n","type":"object","properties":{"dataDeVencimento":{"title":"Data de Vencimento","description":"**Descrição:** Data de vencimento da cobrança.\n\n**Observação:** Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. É a data de vencimento da cobrança. A cobrança pode ser honrada até esse dia, inclusive, em qualquer horário do dia.\n\n**Tipo do campo:** string($date).\n","type":"string"},"validadeAposVencimento":{"title":"Validade Após Vencimento","description":"**Descrição:** Trata-se da quantidade de dias corridos após calendario.dataDeVencimento, em que a cobrança poderá ser paga.\n\n**Observação:** Sempre que a data de vencimento cair em um fim de semana ou em um feriado para o usuário pagador, ela deve ser automaticamente prorrogada para o primeiro dia útil subsequente. Todos os campos que façam referência a esta data (`validadeAposVencimento`; `desconto`; `juros` e `multa`) devem assumir essa prorrogação, quando for o caso. O valor padrão é 30.\n\n**Tipo do campo:** integer($int32).\n","type":"integer"}},"required":["dataDeVencimento"]},"devedor":{"$ref":"#/components/schemas/devedor"},"loc":{"title":"Location do Payload","description":"**Descrição:** Estrutura com informações do identificador da localização do payload.\n\n**Observação:** A localização é a URL onde os dados cobrança são exibidos.\n","type":"object","properties":{"id":{"title":"Identificador da Localização do Payload","description":"**Descrição:** Identificador da localização do payload a ser informado na criação da cobrança.\n","type":"integer"}},"required":["id"]},"status":{"title":"Status","description":"**Descrição:** Status da cobrança. Na alteração da cobrança será enviada sempre com o status \"REMOVIDA_PELO_USUARIO_RECEBEDOR\".\n\n**Observação:** Estado do registro da cobrança. Não se confunde com o estado da cobrança em si, ou seja, não guarda relação com o fato de a cobrança encontrar-se vencida ou expirada, por exemplo.\n","enum":["REMOVIDA_PELO_USUARIO_RECEBEDOR"],"type":"string","example":"REMOVIDA_PELO_USUARIO_RECEBEDOR"},"valor":{"type":"object","title":"Valor da Cobrança com Vencimento","description":"**Descrição:** Campo que organiza os valores monetários referentes à cobrança.\n","properties":{"original":{"title":"Valor","description":"**Descrição:** Valor nominal/original da cobrança.\n\n**Observação:** O valor deve ser maior do que zero. Todos os campos que indicam valores monetários obedecem ao formato do ID 54 da especificação EMV/BR Code para QR Codes. O separador decimal é o caractere ponto. Não é aplicável utilizar separador de milhar. Exemplos de valores aderentes ao padrão: “0.00”, “1.00”, “123.99”, “123456789.23”.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"},"multa":{"title":"Multa Aplicada","description":"**Descrição:** Multa aplicada à cobrança.\n","type":"object","properties":{"modalidade":{"title":"Modalidade da Multa","description":"**Descrição:** Modalidade da multa, conforme tabela de domínios.\n| Descrição | Domínio |\n| ---------- | ------- |\n| Valor Fixo | 1 |\n| Percentual | 2 |\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":1,"maximum":2},"valorPerc":{"title":"Valor da Multa Absoluta","description":"**Descrição:** Multa do documento em valor absoluto ou percentual, conforme `valor.multa.modalidade`.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"}},"required":["modalidade","valorPerc"]},"juros":{"title":"Juro Aplicado","description":"**Descrição:** Juros aplicado à cobrança.\n","type":"object","properties":{"modalidade":{"title":"Modalidade de Juros","description":"**Descrição:** Modalidade de juros, conforme tabela de domínios.\n\n| Descrição | Domínio |\n| --------------------------------- | ------- |\n| Valor (dias corridos) | 1 |\n| Percentual ao dia (dias corridos) | 2 |\n| Percentual ao mês (dias corridos) | 3 |\n| Percentual ao ano (dias corridos) | 4 |\n| Valor (dias úteis) | 5 |\n| Percentual ao dia (dias úteis) | 6 |\n| Percentual ao mês (dias úteis) | 7 |\n| Percentual ao ano (dias úteis) | 8 |\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":1,"maximum":8},"valorPerc":{"title":"Valor","description":"**Descrição:** Juros do documento em valor absoluto ou percentual.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"}},"required":["modalidade","valorPerc"]},"abatimento":{"title":"Abatimento Aplicado","description":"**Descrição:** Abatimento aplicado à cobrança.\n","type":"object","properties":{"modalidade":{"title":"Modalidade de Abatimentos","description":"**Descrição:** Modalidade de abatimentos, conforme tabela de domínios.\n| Descrição | Domínio |\n| ---------- | ------- |\n| Valor Fixo | 1 |\n| Percentual | 2 |\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":1,"maximum":2},"valorPerc":{"title":"Abatimentos","description":"**Descrição:** Abatimentos ou outras deduções aplicadas ao documento, em valor absoluto ou percentual do valor original do documento.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"}},"required":["modalidade","valorPerc"]},"desconto":{"title":"Descontos Aplicados","description":"**Descrição:** Descontos aplicados à cobranca.\n","type":"object","properties":{"modalidade":{"title":"Modalidade de Descontos","description":"**Descrição:** Modalidade de desconto, conforme tabela de domínios.\n| Descrição | Domínio |\n| ---------------------------------------- | ------- |\n| Valor Fixo até a[s] data[s] informada[s] | 1 |\n| Percentual até a data informada | 2 |\n| Valor por antecipação dia corrido | 3 |\n| Valor por antecipação dia útil | 4 |\n| Percentual por antecipação dia corrido | 5 |\n| Percentual por antecipação dia útil | 6 |\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":1,"maximum":6},"valorPerc":{"title":"Abatimentos","description":"**Descrição:** Abatimentos ou outras deduções aplicadas ao documento, em valor absoluto ou percentual do valor original do documento.\n\n**Observação:** Não deve ser enviado `valorPerc` e `descontoDataFixa` juntos.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"},"descontoDataFixa":{"title":"Lista de Descontos","description":"**Descrição:** Data limite para o desconto absoluto da cobrança.\n\n**Observação:** A data de desconto obrigatoriamente deverá ser menor que a data de vencimento da cobrança.\n","type":"array","minItems":1,"maxItems":3,"uniqueItems":true,"items":{"type":"object","description":"","properties":{"data":{"title":"Data Limite","description":"**Descrição:** Data limite para o desconto absoluto da cobrança.\n\n**Observação:** Descontos por pagamento antecipado, com data fixa. Matriz com até três elementos, sendo que cada elemento é composto por um par `data` e `valorPerc`, para estabelecer descontos percentuais ou absolutos, até aquela data de pagamento. Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. A data de desconto obrigatoriamente deverá ser menor ou igual à data de vencimento da cobrança.\n\n**Tipo do campo:** string($date).\n","type":"string"},"valorPerc":{"title":"Valor do Desconto Absoluto","description":"**Descrição:** Desconto em valor absoluto ou percentual por dia, útil ou corrido, conforme `valor.desconto.modalidade`.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"}},"required":["data","valorPerc"]}}},"required":["modalidade","valorPerc"]}},"required":["original"]},"chave":{"title":"Chave DICT do Recebedor","description":"**Descrição:** Campo que organiza a chave Pix do cliente registrada na DICT que será utilizada para recebimento da cobrança.\n","type":"string","maxLength":77},"solicitacaoPagador":{"title":"Solicitação ao Pagador","description":"**Descrição:** O campo `solicitacaoPagador`, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. \n\n**Observação:** Esse texto será preenchido, na **pacs.008**, pelo PSP do pagador, no campo `RemittanceInformation`. O tamanho do campo na pacs.008 está limitado a **140 caracteres**.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"string","maxLength":140},"infoAdicionais":{"title":"Informações Adicionais","description":"**Descrição:** Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.\n\n**Observação:** Pode-se adicionar quantas informações adicionais desejar.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"array","maximum":50,"items":{"$ref":"#/components/schemas/informacaoAdicional"}}}},"cobrancaVencimentoPatchResponse":{"type":"object","title":"Cobrança com Vencimento Revisada","description":"**Descrição:** Dados criados ou alterados da cobrança com vencimento via API Pix.\n","properties":{"calendario":{"title":"Calendário","description":"**Descrição:** Objeto que organiza informações a respeito de controle de tempo da cobrança.\n","type":"object","properties":{"criacao":{"title":"Data de Criação","description":"**Descrição:** Timestamp que indica o momento em que foi criada a cobrança.\n\n**Observação:** Respeita o RFC 3339.\n\n**Tipo do campo:** string($date-time).\n","type":"string"},"dataDeVencimento":{"title":"Data de Vencimento","description":"**Descrição:** Data de vencimento da cobrança.\n\n**Observação:** Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. É a data de vencimento da cobrança. A cobrança pode ser honrada até esse dia, inclusive, em qualquer horário do dia.\n\n**Tipo do campo:** string(date).\n","type":"string"},"validadeAposVencimento":{"title":"Validade Após Vencimento","description":"**Descrição:** Trata-se da quantidade de dias corridos após `calendario.dataDeVencimento`, em que a cobrança poderá ser paga.\n\n**Observação:** Sempre que a data de vencimento cair em um fim de semana ou em um feriado para o usuário pagador, ela deve ser automaticamente prorrogada para o primeiro dia útil subsequente. Todos os campos que façam referência a esta data (`validadeAposVencimento`; `desconto`; `juros` e `multa`) devem assumir essa prorrogação, quando for o caso. O valor padrão é 30.\n\n**Tipo do campo:** integer($int32).\n","type":"integer"}},"required":["criacao","dataDeVencimento"]},"txid":{"title":"Identificador do QR Code","description":"**Descrição:** O campo `txid` determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.\n\n**Observação:** Na pacs.008, é referenciado como `TransactionIdentification ` ou `idConciliacaoRecebedor`.\n\nEm termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.\n\nO txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de um QR Code, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.\n\nEste código deve possuir entre 26 e 35 posições, podendo conter letras minúsculas (a-z), letras maiúsculas (A-Z) e números (0-9).\n","type":"string","pattern":"[a-zA-Z0-9]{26,35}"},"revisao":{"title":"Revisão","description":"**Descrição:** Quantidade de revisões que a cobrança teve.\n\n**Observação:** Sempre começa em zero. Quando a cobrança é alterada esse valor é incrementado (sempre com acréscimos de 1).\nO incremento em uma cobrança deve ocorrer sempre que um objeto da cobrança em questão for alterado. O campo `loc` é uma exceção a esta regra.\n\nSe em uma determinada alteração em uma cobrança, o único campo alterado for o campo `loc`, então esta operação não incrementa a revisão da cobrança.\n\nO campo `loc` não ocasiona uma alteração na cobrança em si. Não é necessário armazenar histórico das alterações do campo `loc` para uma determinada cobrança. Para os outros campos da cobrança, registra-se histórico.\n\n**Tipo do campo:** integer($int32).\n","type":"integer","readOnly":true},"devedor":{"$ref":"#/components/schemas/devedor"},"recebedor":{"$ref":"#/components/schemas/recebedor"},"loc":{"$ref":"#/components/schemas/location"},"status":{"title":"Status","description":"**Descrição:** Status da cobrança. Na criação da cobrança será enviada sempre com o status \"ATIVA\". Caso tenha alterações no status desse QrCode, as opções de valor do campo são: `ATIVA`, `CONCLUIDA`, `REMOVIDA_PELO_PSP`, `REMOVIDA_PELO_USUARIO_RECEBEDOR`.\n\n**Observação:** Estado do registro da cobrança. Não se confunde com o estado da cobrança em si, ou seja, não guarda relação com o fato de a cobrança encontrar-se vencida ou expirada, por exemplo.\nOs status são assim definidos:\n`ATIVA`: indica que o registro se refere a uma cobrança que foi gerada mas ainda não foi paga nem removida.\n\n`CONCLUIDA`: indica que o registro se refere a uma cobrança que já foi paga e, por conseguinte, não pode acolher outro pagamento.\n\n`REMOVIDO_PELO_USUARIO_RECEBEDOR`: indica que o usuário recebedor solicitou a remoção do registro da cobrança.\n\n`REMOVIDO_PELO_PSP`: indica que o PSP Recebedor solicitou a remoção do registro da cobrança.\n","maxLength":31,"enum":["ATIVA","CONCLUIDA","REMOVIDA_PELO_USUARIO_RECEBEDOR","REMOVIDA_PELO_PSP"],"type":"string"},"valor":{"$ref":"#/components/schemas/cobrancaVencimentoPutRequest/properties/valor"},"pixCopiaECola":{"title":"Pix Copia e Cola","description":"**Descrição:** Este campo retorna o valor do Pix Copia e Cola correspondente à cobrança. Trata-se da sequência de caracteres que representa o BR Code.\n","type":"string","maxLength":512},"chave":{"title":"Chave DICT do Recebedor","description":"**Descrição:** Campo que contém a chave Pix registrada na DICT que será utilizada para recebimento da cobrança.\n","type":"string","maxLength":77},"solicitacaoPagador":{"title":"Solicitação ao Pagador","description":"**Descrição:** O campo `solicitacaoPagador`, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor.\n\n**Observação:** Esse texto será preenchido, na **pacs.008**, pelo PSP do pagador, no campo `RemittanceInformation`. O tamanho do campo na pacs.008 está limitado a **140 caracteres**.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"string","maxLength":140},"infoAdicionais":{"title":"Informações Adicionais","description":"**Descrição:** Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.\n\n**Observação:** Pode-se adicionar quantas informações adicionais desejar.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"array","maximum":50,"items":{"$ref":"#/components/schemas/informacaoAdicional"}}},"required":["status","txid","revisao","devedor","recebedor","valor","chave","calendario"]},"cobrancaVencimentoPutRequest":{"type":"object","title":"Cobrança com Vencimento Solicitada","description":"**Descrição**: Dados enviados para criação ou alteração da cobrança com vencimento via API Pix.\n","properties":{"calendario":{"title":"Calendário","description":"**Descrição:** Objeto que organiza informações a respeito de controle de tempo da cobrança.\n","type":"object","properties":{"dataDeVencimento":{"title":"Data de Vencimento","description":"**Descrição:** Data de vencimento da cobrança.\n\n**Observação:** Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. É a data de vencimento da cobrança. A cobrança pode ser honrada até esse dia, inclusive, em qualquer horário do dia.\n\n**Tipo do campo:** string($date).\n","type":"string"},"validadeAposVencimento":{"title":"Validade Após Vencimento","description":"**Descrição:** Trata-se da quantidade de dias corridos após calendario.dataDeVencimento, em que a cobrança poderá ser paga.\n\n**Observação:** Sempre que a data de vencimento cair em um fim de semana ou em um feriado para o usuário pagador, ela deve ser automaticamente prorrogada para o primeiro dia útil subsequente. Todos os campos que façam referência a esta data (`validadeAposVencimento`; `desconto`; `juros` e `multa`) devem assumir essa prorrogação, quando for o caso. O valor padrão é 30.\n\n**Tipo do campo:** integer($int32).\n","type":"integer"}},"required":["dataDeVencimento"]},"devedor":{"$ref":"#/components/schemas/devedor"},"loc":{"title":"Location do Payload","description":"**Descrição:** Estrutura com informações do identificador da localização do payload.\n\n**Observação:** A localização é a URL onde os dados cobrança são exibidos.\n","type":"object","properties":{"id":{"title":"Identificador da Localização do Payload","description":"**Descrição:** Identificador da localização do payload a ser informado na criação da cobrança.\n","type":"integer"}},"required":["id"]},"valor":{"type":"object","title":"Valor da Cobrança com Vencimento","description":"**Descrição:** Campo que organiza os valores monetários referentes à cobrança.\n","properties":{"original":{"title":"Valor","description":"**Descrição:** Valor nominal/original da cobrança.\n\n**Observação:** O valor deve ser maior do que zero. Todos os campos que indicam valores monetários obedecem ao formato do ID 54 da especificação EMV/BR Code para QR Codes. O separador decimal é o caractere ponto. Não é aplicável utilizar separador de milhar. Exemplos de valores aderentes ao padrão: “0.00”, “1.00”, “123.99”, “123456789.23”.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"},"multa":{"title":"Multa Aplicada","description":"**Descrição:** Multa aplicada à cobrança.\n","type":"object","properties":{"modalidade":{"title":"Modalidade da Multa","description":"**Descrição:** Modalidade da multa, conforme tabela de domínios.\n| Descrição | Domínio |\n| ---------- | ------- |\n| Valor Fixo | 1 |\n| Percentual | 2 |\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":1,"maximum":2},"valorPerc":{"title":"Valor da Multa Absoluta","description":"**Descrição:** Multa do documento em valor absoluto ou percentual, conforme `valor.multa.modalidade`.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"}},"required":["modalidade","valorPerc"]},"juros":{"title":"Juro Aplicado","description":"**Descrição:** Juros aplicado à cobrança.\n","type":"object","properties":{"modalidade":{"title":"Modalidade de Juros","description":"**Descrição:** Modalidade de juros, conforme tabela de domínios.\n\n| Descrição | Domínio |\n| --------------------------------- | ------- |\n| Valor (dias corridos) | 1 |\n| Percentual ao dia (dias corridos) | 2 |\n| Percentual ao mês (dias corridos) | 3 |\n| Percentual ao ano (dias corridos) | 4 |\n| Valor (dias úteis) | 5 |\n| Percentual ao dia (dias úteis) | 6 |\n| Percentual ao mês (dias úteis) | 7 |\n| Percentual ao ano (dias úteis) | 8 |\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":1,"maximum":8},"valorPerc":{"title":"Valor","description":"**Descrição:** Juros do documento em valor absoluto ou percentual.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"}},"required":["modalidade","valorPerc"]},"abatimento":{"title":"Abatimento Aplicado","description":"**Descrição:** Abatimento aplicado à cobrança.\n","type":"object","properties":{"modalidade":{"title":"Modalidade de Abatimentos","description":"**Descrição:** Modalidade de abatimentos, conforme tabela de domínios.\n| Descrição | Domínio |\n| ---------- | ------- |\n| Valor Fixo | 1 |\n| Percentual | 2 |\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":1,"maximum":2},"valorPerc":{"title":"Abatimentos","description":"**Descrição:** Abatimentos ou outras deduções aplicadas ao documento, em valor absoluto ou percentual do valor original do documento.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"}},"required":["modalidade","valorPerc"]},"desconto":{"title":"Descontos Aplicados","description":"**Descrição:** Descontos aplicados à cobranca.\n","type":"object","properties":{"modalidade":{"title":"Modalidade de Descontos","description":"**Descrição:** Modalidade de desconto, conforme tabela de domínios.\n| Descrição | Domínio |\n| ---------------------------------------- | ------- |\n| Valor Fixo até a[s] data[s] informada[s] | 1 |\n| Percentual até a data informada | 2 |\n| Valor por antecipação dia corrido | 3 |\n| Valor por antecipação dia útil | 4 |\n| Percentual por antecipação dia corrido | 5 |\n| Percentual por antecipação dia útil | 6 |\n\n**Tipo do campo:** integer($int32).\n","type":"integer","minimum":1,"maximum":6},"valorPerc":{"title":"Abatimentos","description":"**Descrição:** Abatimentos ou outras deduções aplicadas ao documento, em valor absoluto ou percentual do valor original do documento.\n\n**Observação:** Não deve ser enviado `valorPerc` e `descontoDataFixa` juntos.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"},"descontoDataFixa":{"title":"Lista de Descontos","description":"**Descrição:** Data limite para o desconto absoluto da cobrança.\n\n**Observação:** A data de desconto obrigatoriamente deverá ser menor que a data de vencimento da cobrança.\n","type":"array","minItems":1,"maxItems":3,"uniqueItems":true,"items":{"type":"object","description":"","properties":{"data":{"title":"Data Limite","description":"**Descrição:** Data limite para o desconto absoluto da cobrança.\n\n**Observação:** Descontos por pagamento antecipado, com data fixa. Matriz com até três elementos, sendo que cada elemento é composto por um par `data` e `valorPerc`, para estabelecer descontos percentuais ou absolutos, até aquela data de pagamento. Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. A data de desconto obrigatoriamente deverá ser menor ou igual à data de vencimento da cobrança.\n\n**Tipo do campo:** string($date).\n","type":"string"},"valorPerc":{"title":"Valor do Desconto Absoluto","description":"**Descrição:** Desconto em valor absoluto ou percentual por dia, útil ou corrido, conforme `valor.desconto.modalidade`.\n","type":"string","pattern":"\\d{1,10}\\.\\d{2}"}},"required":["data","valorPerc"]}}},"required":["modalidade","valorPerc"]}},"required":["original"]},"chave":{"title":"Chave DICT do Recebedor","description":"**Descrição:** Campo que organiza a chave Pix do cliente registrada na DICT que será utilizada para recebimento da cobrança.\n","type":"string","maxLength":77},"solicitacaoPagador":{"title":"Solicitação ao Pagador","description":"**Descrição:** O campo `solicitacaoPagador`, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor. \n\n**Observação:** Esse texto será preenchido, na **pacs.008**, pelo PSP do pagador, no campo `RemittanceInformation`. O tamanho do campo na pacs.008 está limitado a **140 caracteres**.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"string","maxLength":140},"infoAdicionais":{"title":"Informações Adicionais","description":"**Descrição:** Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.\n\n**Observação:** Pode-se adicionar quantas informações adicionais desejar.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"array","maximum":50,"items":{"$ref":"#/components/schemas/informacaoAdicional"}}},"required":["devedor","valor","chave","calendario"]},"cobrancaVencimentoPutResponse":{"type":"object","title":"Cobrança com Vencimento Gerada","description":"**Descrição:** Dados criados ou alterados da cobrança com vencimento via API Pix.\n","properties":{"calendario":{"title":"Calendário","description":"**Descrição:** Objeto que organiza informações a respeito de controle de tempo da cobrança.\n","type":"object","properties":{"criacao":{"title":"Data de Criação","description":"**Descrição:** Timestamp que indica o momento em que foi criada a cobrança.\n\n**Observação:** Respeita o RFC 3339.\n\n**Tipo do campo:** string($date-time).\n","type":"string"},"dataDeVencimento":{"title":"Data de Vencimento","description":"**Descrição:** Data de vencimento da cobrança.\n\n**Observação:** Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. É a data de vencimento da cobrança. A cobrança pode ser honrada até esse dia, inclusive, em qualquer horário do dia.\n\n**Tipo do campo:** string($date).\n","type":"string"},"validadeAposVencimento":{"title":"Validade Após Vencimento","description":"**Descrição:** Trata-se da quantidade de dias corridos após calendario.dataDeVencimento, em que a cobrança poderá ser paga.\n\n**Observação:** Sempre que a data de vencimento cair em um fim de semana ou em um feriado para o usuário pagador, ela deve ser automaticamente prorrogada para o primeiro dia útil subsequente. Todos os campos que façam referência a esta data (`validadeAposVencimento`; `desconto`; `juros` e `multa`) devem assumir essa prorrogação, quando for o caso. O valor padrão é 30.\n\n**Tipo do campo:** integer($int32).\n","type":"integer"}},"required":["criacao","dataDeVencimento","validadeAposVencimento"]},"txid":{"title":"Identificador da Cobrança","description":"**Descrição:** O campo `txid` determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.\n\n**Observação:** Na pacs.008, é referenciado como `TransactionIdentification ` ou `idConciliacaoRecebedor`.\n\nEm termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.\n\nO txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.\n\nEste código deve possuir entre 26 e 35 posições, podendo conter letras minúsculas (a-z), letras maiúsculas (A-Z) e números (0-9).\n","type":"string","pattern":"[a-zA-Z0-9]{26,35}"},"revisao":{"title":"Revisão","description":"**Descrição:** Quantidade de revisões que a cobrança teve.\n\n**Observação:** Sempre começa em zero. Quando a cobrança é alterada esse valor é incrementado (sempre com acréscimos de 1).\nO incremento em uma cobrança deve ocorrer sempre que um objeto da cobrança em questão for alterado. O campo `loc` é uma exceção a esta regra.\n\nSe em uma determinada alteração em uma cobrança, o único campo alterado for o campo `loc`, então esta operação não incrementa a revisão da cobrança.\n\nO campo `loc` não ocasiona uma alteração na cobrança em si. Não é necessário armazenar histórico das alterações do campo `loc` para uma determinada cobrança. Para os outros campos da cobrança, registra-se histórico.\n\n**Tipo do campo:** integer($int32).\n","type":"integer","readOnly":true},"devedor":{"$ref":"#/components/schemas/devedor"},"recebedor":{"$ref":"#/components/schemas/recebedor"},"loc":{"$ref":"#/components/schemas/location"},"status":{"title":"Status","description":"**Descrição:** Status da cobrança. Na criação da cobrança será enviada sempre com o status \"ATIVA\". Caso tenha alterações no status desse QrCode, as opções de valor do campo são: `ATIVA`, `CONCLUIDA`, `REMOVIDA_PELO_PSP`, `REMOVIDA_PELO_USUARIO_RECEBEDOR`.\n\n**Observação:** Estado do registro da cobrança. Não se confunde com o estado da cobrança em si, ou seja, não guarda relação com o fato de a cobrança encontrar-se vencida ou expirada, por exemplo.\nOs status são assim definidos:\n`ATIVA`: indica que o registro se refere a uma cobrança que foi gerada mas ainda não foi paga nem removida.\n\n`CONCLUIDA`: indica que o registro se refere a uma cobrança que já foi paga e, por conseguinte, não pode acolher outro pagamento.\n\n`REMOVIDO_PELO_USUARIO_RECEBEDOR`: indica que o usuário recebedor solicitou a remoção do registro da cobrança.\n\n`REMOVIDO_PELO_PSP`: indica que o PSP Recebedor solicitou a remoção do registro da cobrança.\n","maxLength":31,"enum":["ATIVA","CONCLUIDA","REMOVIDA_PELO_USUARIO_RECEBEDOR","REMOVIDA_PELO_PSP"],"type":"string"},"valor":{"$ref":"#/components/schemas/cobrancaVencimentoPutRequest/properties/valor"},"pixCopiaECola":{"title":"Pix Copia e Cola","description":"**Descrição:** Este campo retorna o valor do Pix Copia e Cola correspondente à cobrança. Trata-se da sequência de caracteres que representa o BR Code.\n","type":"string","maxLength":512},"chave":{"title":"Chave DICT do Recebedor","description":"**Descrição:** Campo que contém a chave Pix registrada na DICT que será utilizada para recebimento da cobrança.\n","type":"string","maxLength":77},"solicitacaoPagador":{"title":"Solicitação ao Pagador","description":"**Descrição:** O campo `solicitacaoPagador`, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor.\n\n**Observação:** Esse texto será preenchido, na **pacs.008**, pelo PSP do pagador, no campo `RemittanceInformation`. O tamanho do campo na pacs.008 está limitado a **140 caracteres**.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"string","maxLength":140},"infoAdicionais":{"title":"Informações Adicionais","description":"**Descrição:** Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.\n\n**Observação:** Pode-se adicionar quantas informações adicionais desejar.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"array","maximum":50,"items":{"$ref":"#/components/schemas/informacaoAdicional"}}},"required":["status","txid","revisao","devedor","recebedor","valor","chave","calendario"]},"loteCobrancaVencimentoPutRequest":{"type":"object","title":"Lote de Cobranças com Vencimento Gerado","description":"**Descrição:** Dados para geração de lote de cobranças com vencimento.\n","properties":{"descricao":{"title":"Descrição","description":"**Descrição:** Descrição do lote\n","type":"string"},"cobsv":{"title":"Cobrança com Vencimento Solicitada","description":"**Descrição:** Dados enviados para criação ou alteração da cobrança com vencimento via API Pix.\n","type":"array","items":{"type":"object","description":"","properties":{"calendario":{"title":"Calendário","description":"**Descrição:** Objeto que organiza informações a respeito de controle de tempo da cobrança.\n","type":"object","properties":{"dataDeVencimento":{"title":"Data de Vencimento","description":"**Descrição:** Data de vencimento da cobrança.\n\n**Observação:** Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. É a data de vencimento da cobrança. A cobrança pode ser honrada até esse dia, inclusive, em qualquer horário do dia.\n\n**Tipo do campo:** string($date).\n","type":"string"},"validadeAposVencimento":{"title":"Validade Após Vencimento","description":"**Descrição:** Trata-se da quantidade de dias corridos após calendario.dataDeVencimento, em que a cobrança poderá ser paga.\n\n**Observação:** Sempre que a data de vencimento cair em um fim de semana ou em um feriado para o usuário pagador, ela deve ser automaticamente prorrogada para o primeiro dia útil subsequente. Todos os campos que façam referência a esta data (`validadeAposVencimento`; `desconto`; `juros` e `multa`) devem assumir essa prorrogação, quando for o caso. O valor padrão é 30.\n\n**Tipo do campo:** integer($int32).\n","type":"integer"}},"required":["dataDeVencimento"]},"txid":{"title":"Identificador do QR Code","description":"**Descrição:** O campo `txid` determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.\n\n**Observação:** Na pacs.008, é referenciado como `TransactionIdentification ` ou `idConciliacaoRecebedor`.\n\nEm termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.\n\nO txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de um QR Code, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.\n\nEste código deve possuir entre 26 e 35 posições, podendo conter letras minúsculas (a-z), letras maiúsculas (A-Z) e números (0-9).\n","type":"string","pattern":"[a-zA-Z0-9]{26,35}"},"devedor":{"$ref":"#/components/schemas/devedor"},"valor":{"$ref":"#/components/schemas/cobrancaVencimentoPutRequest/properties/valor"},"loc":{"title":"Location do Payload","description":"**Descrição:** Estrutura com informações do identificador da localização do payload.\n\n**Observação:** A localização é a URL onde os dados cobrança são exibidos.\n","type":"object","properties":{"id":{"title":"Identificador da Localização do Payload","description":"**Descrição:** Identificador da localização do payload a ser informado na criação da cobrança.\n","type":"integer"}},"required":["id"]},"chave":{"title":"Chave DICT do Recebedor","description":"**Descrição:** Campo que contém a chave Pix registrada na DICT que será utilizada para recebimento da cobrança.\n","type":"string","maxLength":77},"solicitacaoPagador":{"title":"Solicitação ao Pagador","description":"**Descrição:** O campo `solicitacaoPagador`, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor.\n\n**Observação:** Esse texto será preenchido, na **pacs.008**, pelo PSP do pagador, no campo `RemittanceInformation`. O tamanho do campo na pacs.008 está limitado a **140 caracteres**.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"string","maxLength":140},"infoAdicionais":{"title":"Informações Adicionais","description":"**Descrição:** Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.\n\n**Observação:** Pode-se adicionar quantas informações adicionais desejar.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"array","maximum":50,"items":{"$ref":"#/components/schemas/informacaoAdicional"}}},"required":["devedor","valor","txid","chave","calendario"]}}},"required":["descricao","cobsv"]},"loteCobrancaVencimentoPatchRequest":{"type":"object","title":"Lote de Cobranças com Vencimento Revisado","description":"**Descrição:** Dados para revisão de lote de cobranças com vencimento.\n","properties":{"descricao":{"title":"Descrição","description":"**Descrição:** Descrição do lote.\n","type":"string"},"cobsv":{"title":"Cobrança com Vencimento Revisada","description":"**Descrição:** Dados enviados para criação ou alteração da cobrança com vencimento via API Pix.\n","type":"array","items":{"type":"object","description":"","properties":{"calendario":{"title":"Calendário","description":"**Descrição:** Objeto que organiza informações a respeito de controle de tempo da cobrança.\n","type":"object","properties":{"dataDeVencimento":{"title":"Data de Vencimento","description":"**Descrição:** Data de vencimento da cobrança.\n\n**Observação:** Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. É a data de vencimento da cobrança. A cobrança pode ser honrada até esse dia, inclusive, em qualquer horário do dia.\n\n**Tipo do campo:** string($date).\n","type":"string"},"validadeAposVencimento":{"title":"Validade Após Vencimento","description":"**Descrição:** Trata-se da quantidade de dias corridos após calendario.dataDeVencimento, em que a cobrança poderá ser paga.\n\n**Observação:** Sempre que a data de vencimento cair em um fim de semana ou em um feriado para o usuário pagador, ela deve ser automaticamente prorrogada para o primeiro dia útil subsequente. Todos os campos que façam referência a esta data (`validadeAposVencimento`; `desconto`; `juros` e `multa`) devem assumir essa prorrogação, quando for o caso. O valor padrão é 30.\n\n**Tipo do campo:** integer($int32).\n","type":"integer"}},"required":["dataDeVencimento"]},"txid":{"title":"Identificador do QR Code","description":"**Descrição:** O campo `txid` determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.\n\n**Observação:** Na pacs.008, é referenciado como `TransactionIdentification ` ou `idConciliacaoRecebedor`.\n\nEm termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.\n\nO txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de um QR Code, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.\n\nEste código deve possuir entre 26 e 35 posições, podendo conter letras minúsculas (a-z), letras maiúsculas (A-Z) e números (0-9).\n","type":"string","pattern":"[a-zA-Z0-9]{26,35}"},"devedor":{"$ref":"#/components/schemas/devedor"},"loc":{"title":"Location do Payload","description":"**Descrição:** Estrutura com informações do identificador da localização do payload.\n\n**Observação:** A localização é a URL onde os dados cobrança são exibidos.\n","type":"object","properties":{"id":{"title":"Identificador da Localização do Payload","description":"**Descrição:** Identificador da localização do payload a ser informado na criação da cobrança.\n","type":"integer"}},"required":["id"]},"status":{"title":"Status","description":"**Descrição:** Status da cobrança. Na alteração da cobrança será enviada sempre com o status \"REMOVIDA_PELO_USUARIO_RECEBEDOR\".\n\n**Observação:** Estado do registro da cobrança. Não se confunde com o estado da cobrança em si, ou seja, não guarda relação com o fato de a cobrança encontrar-se vencida ou expirada, por exemplo.\n","enum":["REMOVIDA_PELO_USUARIO_RECEBEDOR"],"type":"string","example":"REMOVIDA_PELO_USUARIO_RECEBEDOR"},"valor":{"$ref":"#/components/schemas/valor"},"chave":{"title":"Chave DICT do Recebedor","description":"**Descrição:** Campo que contém a chave Pix registrada na DICT que será utilizada para recebimento da cobrança.\n","type":"string","maxLength":77},"solicitacaoPagador":{"title":"Solicitação ao Pagador","description":"**Descrição:** O campo `solicitacaoPagador`, determina um texto a ser apresentado ao pagador para que ele possa digitar uma informação correlata, em formato livre, a ser enviada ao recebedor.\n\n**Observação:** Esse texto será preenchido, na **pacs.008**, pelo PSP do pagador, no campo `RemittanceInformation`. O tamanho do campo na pacs.008 está limitado a **140 caracteres**.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"string","maxLength":140},"infoAdicionais":{"title":"Informações Adicionais","description":"**Descrição:** Cada respectiva informação adicional contida na lista (nome e valor) deve ser apresentada ao pagador.\n\n**Observação:** Pode-se adicionar quantas informações adicionais desejar.\n\nCampo retornado somente se o parâmetro de entrada foi colocado na requisição.\n","type":"array","maximum":50,"items":{"$ref":"#/components/schemas/informacaoAdicional"}}},"required":["txid"]}}}},"loteCobrancaVencimentoIdGetResponse":{"type":"object","title":"Lote de Solicitações de Alteração ou Criação de Cobranças com Vencimento","description":"**Descrição:** Dados para a consulta de lotes de cobranças com vencimento.\n","properties":{"id":{"title":"Identificador do Lote","description":"**Descrição:** Identificador do lote em formato numérico.\n\n**Tipo do campo:** integer($int64).\n","type":"integer"},"descricao":{"title":"Descrição do Lote","description":"**Descrição:** Descrição do lote.\n","type":"string"},"criacao":{"title":"Data de Criação do Lote","description":"**Descrição:** Timestamp que indica o momento em que foi criado o lote. Respeita o formato definido na RFC 3339.\n\n**Tipo do campo:** string($date-time).\n","type":"string"},"cobsv":{"title":"Cobranças com Vencimento Consultadas","description":"**Descrição:** Dados enviados para criação ou alteração da cobrança com vencimento via API Pix.\n","type":"array","items":{"type":"object","title":"Lote de Cobranças com Vencimento Consultado","description":"**Descrição:** Dados retornados na consulta de um lote de cobrança com vencimento.\n","properties":{"txid":{"title":"Identificador do QR Code","description":"**Descrição:** O campo `txid` determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos.\n\n**Observação:** Na pacs.008, é referenciado como `TransactionIdentification ` ou `idConciliacaoRecebedor`.\n\nEm termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado.\n\nO txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de um QR Code, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix.\n\nEste código deve possuir entre 26 e 35 posições, podendo conter letras minúsculas (a-z), letras maiúsculas (A-Z) e números (0-9).\n","type":"string","pattern":"[a-zA-Z0-9]{26,35}"},"status":{"title":"Status","description":"**Descrição:** Status da solicitação de criação/alteração da cobrança no contexto de criação via lote.\n","enum":["EM_PROCESSAMENTO","CRIADA","NEGADA"],"type":"string"},"criacao":{"title":"Data de Criação","description":"**Descrição:** Timestamp que indica o momento em que foi criada a cobrança.\n\n**Observação:** Respeita o RFC 3339.\n\n**Tipo do campo:** string($date-time).\n","type":"string","readOnly":true},"problema":{"$ref":"#/components/schemas/cobrancaVencimento_400"}},"required":["txid","status"]}}},"required":["id","criacao","descricao","cobsv"]},"loteCobrancaVencimentoGetResponse":{"type":"object","title":"Lotes de Solicitações de QR Codes com Vencimento","description":"**Descrição:** Dados retornados nos lotes de solicitações de QR Codes com vencimento.\n","properties":{"parametros":{"$ref":"#/components/schemas/parametros"},"lotes":{"title":"Lotes de QR Codes com Vencimento","description":"**Descrição:** Lotes de solicitações de criação/alteração de QR Codes com vencimento.\n","type":"array","items":{"$ref":"#/components/schemas/lotes"}}},"required":["parametros","lotes"]},"parametros":{"type":"object","title":"Parâmetros de Consulta de Lotes de QR Code com Vencimento","description":"**Descrição:** Parâmetros utilizados para a realização de uma consulta de lote de QR Codes com vencimento.\n","properties":{"inicio":{"title":"Data de Início","description":"**Descrição:** Data inicial utilizada na consulta. Respeita RFC 3339.\n\n**Tipo do campo:** string($date-time).\n","type":"string"},"fim":{"title":"Data de Fim","description":"**Descrição:** Data de fim utilizada na consulta. Respeita RFC 3339.\n\n**Tipo do campo:** string($date-time).\n","type":"string"},"paginacao":{"title":"Paginação","description":"**Descrição:** Os dados sobre a paginação.\n","type":"object","properties":{"paginaAtual":{"title":"Página Atual","description":"**Descrição:** Número da página recuperada.\n","type":"integer","minimum":0},"itensPorPagina":{"title":"Itens por Página","description":"**Descrição:** Quantidade de registros retornado na página.\n","type":"integer","minimum":1},"quantidadeDePaginas":{"title":"Quantidade de Páginas","description":"**Descrição:** Quantidade de páginas disponíveis para consulta.\n","type":"integer","minimum":1},"quantidadeTotalDeItens":{"title":"Quantidade Total de Itens","description":"**Descrição:** Quantidade total de itens disponíveis de acordo com os parâmetros informados.\n","type":"integer","minimum":0}},"required":["paginaAtual","itensPorPagina","quantidadeDePaginas","quantidadeTotalDeItens"]}},"required":["inicio","fim","paginacao"]},"lotes":{"type":"object","title":"Lotes de Solicitações de Criação/Alteração de QR Code com Vencimento","description":"**Descrição:** Dados retornados na consulta de lotes de solicitações de criação/alteração de QR Code com vencimento.\n","properties":{"id":{"title":"Identificador do Lote","description":"**Descrição:** Identificador do lote em formato numérico.\n\n**Tipo do campo:** integer($int64).\n","type":"integer"},"descricao":{"title":"Descrição do Lote","description":"**Descrição:** Descrição do lote.\n","type":"string"},"criacao":{"title":"Data de Criação do Lote","description":"**Descrição:** Timestamp que indica o momento em que foi criado o lote. Respeita o formato definido na RFC 3339.\n\n**Tipo do campo:** string($date-time).\n","type":"string"},"cobsv":{"title":"QR Codes com Vencimento Consultados","description":"**Descrição:** Dados enviados para criação ou alteração de QR Codes com vencimento via API Pix.\n","type":"array","items":{"$ref":"#/components/schemas/cobrancaVencimento"}}},"required":["id","criacao","descricao","cobsv"]},"locationPostRequest":{"type":"object","title":"Location do Payload Solicitada","description":"**Descrição:** Identificador da localização do payload solicitada.\n","properties":{"tipoCob":{"title":"Tipo da Cobrança","description":"**Descrição:** Tipo da cobrança\n","enum":["cob","cobv"],"type":"string"}},"required":["tipoCob"]},"locationPostResponse":{"type":"object","title":"Location do Payload","description":"Identificador da localização do payload.","properties":{"id":{"title":"Identificador da Localização do Payload","description":"**Descrição:** Identificador da URL do PIX para consulta do payload criptografado - pix link BACEN.\n\n**Tipo do campo:** integer($int64).\n","type":"integer","readOnly":true},"location":{"title":"Localização do Payload","description":"**Descrição:** URL do PIX para consulta do payload criptografado - pix link BACEN.\n\n**Tipo do campo:** string($uri).\n","type":"string","maxLength":77,"readOnly":true},"tipoCob":{"title":"Tipo da Cobrança","description":"**Descrição:** Define se o tipo do documento é imediata ou vencimento.\n","enum":["cob","cobv"],"type":"string"},"criacao":{"title":"Data de Criação","description":"**Descrição:** Data e hora de criação da localização da cobrança.\n\n**Observação:** Respeita RFC 3339.\n\n**Tipo do campo:** string($date-time).\n","type":"string","readOnly":true}},"required":["id","location","tipoCob","criacao"]},"locationIdGetResponse":{"type":"object","description":"","properties":{"id":{"description":"Identificador da location a ser informada na criação da cobrança.","type":"integer","example":7743},"location":{"description":"URL com a localização do payload informado na criação da cobrança","type":"string","example":"pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002"},"txid":{"description":"O campo txid determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite a conciliação de pagamentos. O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. Deve ser único por CNPJ do recebedor. Para Code dinâmico o campo deve possuir de 26 posição até 35 posições. Os caracteres permitidos no contexto do Pix para o campo txId são: Letras minúsculas, de ‘a’ a ‘z’, Letras maiúsculas, de ‘A’ a ‘Z’, Dígitos decimais, de ‘0’ a ‘9’","type":"string","example":"7978c0c97ea847e78e88496344"},"tipoCob":{"description":"Tipo da cobrança
ENUM
cob
cobv
\n","type":"string","example":"cobv"},"criacao":{"description":"Data e hora em que a location foi criada. Respeita RFC 3339.","type":"string","example":"2020-01-01T00:00:00Z"}},"required":["id","location","txid","tipoCob","criacao"]},"cobrancaImediata_400":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/CobOperacaoInvalida"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Cobrança inválida."},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":400},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"A requisição que busca alterar ou criar uma cobrança para pagamento imediato não respeita o schema ou está semanticamente errada."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string","example":"O objeto cob.devedor não respeita o schema."},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string","example":"cob.devedor.cnpj"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string","example":1234}}}}},"required":["type","title","status"]},"cobrancaImediata_403":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/AcessoNegado"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Acesso Negado"},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":403},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"Requisição de participante autenticado que viola alguma regra de autorização."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"cobrancaImediata_404":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Não Encontrado"},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":404},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"Entidade não encontrada."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"cobrancaImediata_503":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Serviço Indisponível"},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":503},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"cobrancaVencimento_400":{"type":"object","title":"Problema","description":"","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/CobOperacaoInvalida"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Cobrança inválida."},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":400},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"A requisição que busca alterar ou criar uma cobrança para pagamento imediato não respeita o schema ou está semanticamente errada."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string","example":"O objeto cobv.devedor não respeita o schema."},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string","example":"cobv.devedor.cnpj"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string","example":1234}}}}},"required":["type","title","status"]},"cobrancaVencimento_403":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/AcessoNegado"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Acesso Negado"},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":403},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"Requisição de participante autenticado que viola alguma regra de autorização."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"cobrancaVencimento_404":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Não Encontrado"},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":404},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"Entidade não encontrada."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"cobrancaVencimento_503":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Serviço Indisponível"},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":503},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"location_400":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/PayloadLocationOperacaoInvalida"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"PayloadLocation inválido."},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":400},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"A presente requisição busca criar uma location sem respeitar o _schema_ estabelecido."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"location_403":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/AcessoNegado"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Acesso Negado"},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":403},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"Requisição de participante autenticado que viola alguma regra de autorização."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"location_404":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Não Encontrado"},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":404},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"Entidade não encontrada."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"location_503":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Serviço Indisponível"},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":503},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"lotecobv_400":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/LoteCobVOperacaoInvalida"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Lote de cobranças inválido."},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":400},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"A requisição que busca alterar ou criar um lote de cobranças com vencimento não respeita o _schema_ ou está semanticamente errada."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"lotecobv_403":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/AcessoNegado"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Acesso Negado"},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":403},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"Requisição de participante autenticado que viola alguma regra de autorização."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"lotecobv_404":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Não Encontrado"},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":404},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"Entidade não encontrada."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"lotecobv_503":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Serviço Indisponível"},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":503},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"devolucao_400":{"type":"object","title":"Problema","description":"","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/PixDevolucaoInvalida"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Devolução inválida."},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":400},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"A presente requisição de devolução não respeita o _schema_ ou não faz sentido semanticamente."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"devolucao_403":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/AcessoNegado"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Acesso Negado"},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":403},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"Requisição de participante autenticado que viola alguma regra de autorização."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"devolucao_404":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Não Encontrado"},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":404},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"Entidade não encontrada."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]},"devolucao_503":{"type":"object","title":"Problema","properties":{"type":{"title":"Tipo","description":"**Descrição:** URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.\n\n**Tipo do campo:** string($uri).\n","type":"string","example":"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel"},"title":{"title":"Descrição","description":"**Descrição:** Descrição resumida do problema.\n","type":"string","example":"Serviço Indisponível"},"status":{"title":"Status","description":"**Descrição:** Código HTTP do status retornado.\n","type":"integer","example":503},"detail":{"title":"Detalhes","description":"**Descrição:** Descrição completa do problema.\n","type":"string","example":"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento."},"correlationId":{"title":"CorrelationId","description":"**Descrição:** Identificador de correlação do problema para fins de suporte.\n","type":"string","example":"0756d096-c900-4d4b-a0b1-d9c13004f29d"},"violacoes":{"title":"Violações","description":"**Descrição:** Violações registradas no documento.\n","type":"array","items":{"type":"object","description":"","properties":{"razao":{"title":"Razão","description":"**Descrição:** Descrição do erro.\n","type":"string"},"propriedade":{"title":"Propriedade","description":"**Descrição:** Nome da propriedade.\n","type":"string"},"valor":{"title":"Valor","description":"**Descrição:** Valor da propriedade.\n","type":"string"}}}}},"required":["type","title","status"]}},"securitySchemes":{"OAuth2":{"type":"oauth2","description":"Modelo de segurança aplicado a API.\n","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://oauthd.itau/identity/connect/token"}}},"APIGatewaySTSAuthorizer":{"type":"http","description":"Modelo de segurança usando STS Corporativo.\n","scheme":"basic"}},"x-metadata":{"versao":2,"info":"Metadados das APIs do Domínio Cash Management","categoria":"pix","rotas":[{"rota":"/cob/{txid}","metodos":[{"metodo":"put","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Especificação","link":"https://confluence-itau.tecnologia.prod.ops.aws.cloud.ihf/x/fJz6L"}],"contatos":[{"tipo":"RECEBIMENTOS PIX 1 - EMISSAO E DECODIFICACAO QR CODE (S002530)","contato":"CI_Cash_Squad_Pix1_Estend@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"},{"metodo":"patch","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Especificação","link":"https://confluence-itau.tecnologia.prod.ops.aws.cloud.ihf/x/fJz6L"}],"contatos":[{"tipo":"RECEBIMENTOS PIX 1 - EMISSAO E DECODIFICACAO QR CODE (S002530)","contato":"CI_Cash_Squad_Pix1_Estend@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"},{"metodo":"get","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Comunidade de Cash - Contratacao e Emissao","link":"https://confluencecorp.ctsp.prod.cloud.ihf/x/_fURG"}],"contatos":[{"tipo":"Equipe de Projeto: 'Equipe de Projeto: Comunidade Cash Management Squad Gestao e Conciliacao 2'","contato":"Cash_Squad_Pix_3@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"}]},{"rota":"/cob","metodos":[{"metodo":"post","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Especificação","link":"https://confluence-itau.tecnologia.prod.ops.aws.cloud.ihf/x/fJz6L"}],"contatos":[{"tipo":"RECEBIMENTOS PIX 1 - EMISSAO E DECODIFICACAO QR CODE (S002530)","contato":"CI_Cash_Squad_Pix1_Estend@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"},{"metodo":"get","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Comunidade de Cash - Contratacao e Emissao","link":"https://confluencecorp.ctsp.prod.cloud.ihf/x/_fURG"}],"contatos":[{"tipo":"Equipe de Projeto: 'Equipe de Projeto: Comunidade Cash Management Squad Gestao e Conciliacao 2'","contato":"Cash_Squad_Pix_3@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"}]},{"rota":"/cob/{txid}/qrcode","metodos":[{"metodo":"get","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Especificação","link":"https://confluence-itau.tecnologia.prod.ops.aws.cloud.ihf/x/fJz6L"}],"contatos":[{"tipo":"RECEBIMENTOS PIX 1 - EMISSAO E DECODIFICACAO QR CODE (S002530)","contato":"CI_Cash_Squad_Pix1_Estend@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"}]},{"rota":"/cobv/{txid}","metodos":[{"metodo":"put","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Especificação","link":"https://confluence-itau.tecnologia.prod.ops.aws.cloud.ihf/x/fJz6L"}],"contatos":[{"tipo":"RECEBIMENTOS PIX 1 - EMISSAO E DECODIFICACAO QR CODE (S002530)","contato":"CI_Cash_Squad_Pix1_Estend@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"},{"metodo":"patch","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Especificação","link":"https://confluence-itau.tecnologia.prod.ops.aws.cloud.ihf/x/fJz6L"}],"contatos":[{"tipo":"RECEBIMENTOS PIX 1 - EMISSAO E DECODIFICACAO QR CODE (S002530)","contato":"CI_Cash_Squad_Pix1_Estend@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"},{"metodo":"get","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Comunidade de Cash - Contratacao e Emissao","link":"https://confluencecorp.ctsp.prod.cloud.ihf/x/_fURG"}],"contatos":[{"tipo":"Equipe de Projeto: 'Equipe de Projeto: Comunidade Cash Management Squad Gestao e Conciliacao 2'","contato":"Cash_Squad_Pix_3@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"}]},{"rota":"/cobv","metodos":[{"metodo":"get","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Comunidade de Cash - Contratacao e Emissao","link":"https://confluencecorp.ctsp.prod.cloud.ihf/x/_fURG"}],"contatos":[{"tipo":"Equipe de Projeto: 'Equipe de Projeto: Comunidade Cash Management Squad Gestao e Conciliacao 2'","contato":"Cash_Squad_Pix_3@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"}]},{"rota":"/cobv/{txid}/qrcode","metodos":[{"metodo":"get","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Especificação","link":"https://confluence-itau.tecnologia.prod.ops.aws.cloud.ihf/x/fJz6L"}],"contatos":[{"tipo":"RECEBIMENTOS PIX 1 - EMISSAO E DECODIFICACAO QR CODE (S002530)","contato":"CI_Cash_Squad_Pix1_Estend@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"}]},{"rota":"/lotecobv/{id}","metodos":[{"metodo":"put","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Especificação","link":"https://confluence-itau.tecnologia.prod.ops.aws.cloud.ihf/x/fJz6L"}],"contatos":[{"tipo":"RECEBIMENTOS PIX 1 - EMISSAO E DECODIFICACAO QR CODE (S002530)","contato":"CI_Cash_Squad_Pix1_Estend@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"},{"metodo":"patch","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Especificação","link":"https://confluence-itau.tecnologia.prod.ops.aws.cloud.ihf/x/fJz6L"}],"contatos":[{"tipo":"RECEBIMENTOS PIX 1 - EMISSAO E DECODIFICACAO QR CODE (S002530)","contato":"CI_Cash_Squad_Pix1_Estend@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"},{"metodo":"get","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Especificação","link":"https://confluence-itau.tecnologia.prod.ops.aws.cloud.ihf/x/fJz6L"}],"contatos":[{"tipo":"RECEBIMENTOS PIX 1 - EMISSAO E DECODIFICACAO QR CODE (S002530)","contato":"CI_Cash_Squad_Pix1_Estend@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"}]},{"rota":"/lotecobv","metodos":[{"metodo":"get","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Especificação","link":"https://confluence-itau.tecnologia.prod.ops.aws.cloud.ihf/x/fJz6L"}],"contatos":[{"tipo":"RECEBIMENTOS PIX 1 - EMISSAO E DECODIFICACAO QR CODE (S002530)","contato":"Cash_Squad_Pix_3@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"}]},{"rota":"/loc","metodos":[{"metodo":"post","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Especificação","link":"https://confluence-itau.tecnologia.prod.ops.aws.cloud.ihf/x/fJz6L"}],"contatos":[{"tipo":"RECEBIMENTOS PIX 1 - EMISSAO E DECODIFICACAO QR CODE (S002530)","contato":"CI_Cash_Squad_Pix1_Estend@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"},{"metodo":"get","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Especificação","link":"https://confluence-itau.tecnologia.prod.ops.aws.cloud.ihf/x/fJz6L"}],"contatos":[{"tipo":"RECEBIMENTOS PIX 1 - EMISSAO E DECODIFICACAO QR CODE (S002530)","contato":"Cash_Squad_Pix_3@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"}]},{"rota":"/loc/{id}","metodos":[{"metodo":"get","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Especificação","link":"https://confluence-itau.tecnologia.prod.ops.aws.cloud.ihf/x/fJz6L"}],"contatos":[{"tipo":"RECEBIMENTOS PIX 1 - EMISSAO E DECODIFICACAO QR CODE (S002530)","contato":"Cash_Squad_Pix_3@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"}]},{"rota":"/loc/{id}/txid","metodos":[{"metodo":"delete","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Especificação","link":"https://confluence-itau.tecnologia.prod.ops.aws.cloud.ihf/x/fJz6L"}],"contatos":[{"tipo":"RECEBIMENTOS PIX 1 - EMISSAO E DECODIFICACAO QR CODE (S002530)","contato":"CI_Cash_Squad_Pix1_Estend@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"}]},{"rota":"/pix/{e2eid}","metodos":[{"metodo":"get","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Comunidade de Cash - Contratacao e Emissao","link":"https://confluencecorp.ctsp.prod.cloud.ihf/x/_fURG"}],"contatos":[{"tipo":"Equipe de Projeto: 'Equipe de Projeto: Comunidade Cash Management Squad Gestao e Conciliacao 2'","contato":"Cash_Squad_Pix_3@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"}]},{"rota":"/pix","metodos":[{"metodo":"get","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Comunidade de Cash - Contratacao e Emissao","link":"https://confluencecorp.ctsp.prod.cloud.ihf/x/_fURG"}],"contatos":[{"tipo":"Equipe de Projeto: 'Equipe de Projeto: Comunidade Cash Management Squad Gestao e Conciliacao 2'","contato":"Cash_Squad_Pix_3@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"}]},{"rota":"/pix/{e2eid}/devolucao/{id}","metodos":[{"metodo":"put","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Especificação","link":"https://confluence-itau.tecnologia.prod.ops.aws.cloud.ihf/x/fJz6L"}],"contatos":[{"tipo":"RECEBIMENTOS PIX 1 - EMISSAO E DECODIFICACAO QR CODE (S002530)","contato":"CI_Cash_Squad_Pix1_Estend@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"},{"metodo":"get","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Comunidade de Cash - Contratacao e Emissao","link":"https://confluencecorp.ctsp.prod.cloud.ihf/x/_fURG"}],"contatos":[{"tipo":"Equipe de Projeto: 'Equipe de Projeto: Comunidade Cash Management Squad Gestao e Conciliacao 2'","contato":"Cash_Squad_Gestao_Conciliacao_2@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"}]},{"rota":"/webhook/{chave}","metodos":[{"metodo":"put","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Comunidade de Cash - Contratacao e Emissao","link":"https://confluencecorp.ctsp.prod.cloud.ihf/x/_fURG"}],"contatos":[{"tipo":"Equipe de Projeto: 'Equipe de Projeto: Comunidade Cash Management Squad Gestao e Conciliacao 2'","contato":"Cash_Squad_Gestao_Conciliacao_2@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"},{"metodo":"get","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Comunidade de Cash - Contratacao e Emissao","link":"https://confluencecorp.ctsp.prod.cloud.ihf/x/_fURG"}],"contatos":[{"tipo":"Equipe de Projeto: 'Equipe de Projeto: Comunidade Cash Management Squad Gestao e Conciliacao 2'","contato":"Cash_Squad_Gestao_Conciliacao_2@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"},{"metodo":"delete","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Comunidade de Cash - Contratacao e Emissao","link":"https://confluencecorp.ctsp.prod.cloud.ihf/x/_fURG"}],"contatos":[{"tipo":"Equipe de Projeto: 'Equipe de Projeto: Comunidade Cash Management Squad Gestao e Conciliacao 2'","contato":"Cash_Squad_Gestao_Conciliacao_2@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"}]},{"rota":"/webhook","metodos":[{"metodo":"get","sigla":"EP9","tempo_desenvolvimento":350,"tags":["pix"],"documentos":[{"titulo":"Comunidade de Cash - Contratacao e Emissao","link":"https://confluencecorp.ctsp.prod.cloud.ihf/x/_fURG"}],"contatos":[{"tipo":"Equipe de Projeto: 'Equipe de Projeto: Comunidade Cash Management Squad Gestao e Conciliacao 2'","contato":"Cash_Squad_Gestao_Conciliacao_2@correio.itau.com.br"}],"comunidade":"CASH MANAGEMENT - RECEBIMENTOS E PAGAMENTOS PJ"}]}]}},"x-metadata":{"$ref":"#/components/x-metadata"}} \ No newline at end of file diff --git a/itau.http b/itau.http new file mode 100644 index 0000000..273802d --- /dev/null +++ b/itau.http @@ -0,0 +1,26 @@ +@SECRET=8d11daa0-abd1-430e-8c2c-002d84073f0e +@CLIENT_ID=9b21f47d-a2f1-46f3-8771-746496a01041 + + +#pega token +# @name pegaToken +POST https://sts.itau.com.br/api/oauth/token +Content-Type: application/x-www-form-urlencoded + +grant_type=client_credentials&client_id={{CLIENT_ID}}&client_secret={{SECRET}} + +### +@token={{pegaToken.response.body.access_token}} + +### +# Pega lista PIX + GET https://secure.api.itau/pix_recebimentos/v2/pix?inicio=2024-11-20T00:00:00.000Z&fim=2024-11-28T00:00:00.000Z +Authorization: Bearer {{token}} +x-itau-apikey: {{CLIENT_ID}} + + +#### +# Detalhe pix +GET https://secure.api.itau/pix_recebimentos/v2/pix/E60701190202411222200DY5Z9L1DY5D +Authorization: Bearer {{token}} +x-itau-apikey: {{CLIENT_ID}} diff --git a/tests/autoconfig/ini/project/subdir/empty.py b/itauapipix/__init__.py similarity index 100% rename from tests/autoconfig/ini/project/subdir/empty.py rename to itauapipix/__init__.py diff --git a/itauapipix/consulta_pix.py b/itauapipix/consulta_pix.py new file mode 100644 index 0000000..a299340 --- /dev/null +++ b/itauapipix/consulta_pix.py @@ -0,0 +1,55 @@ +import env_itauapipix as env +from itauapipix.itau_api_pix import ItauClient + + +def pega_lista_pix(credentials, dthr_ini, dthr_fim): + + client = ItauClient.from_credentials( + **credentials + ) + + resp = client.received_pixs(dthr_ini, dthr_fim) + + return resp.json() + + +def trata_resp_pix(json_resp): + dados_pix = [] + for pix in json_resp['pix']: + dados = { + 'valor': pix['valor'], + 'horario': pix['horario'], + 'id': pix['endToEndId'], + 'msg': pix.get('infoPagador', ''), + } + #pagador = pix['chave'] + #dados['cpf/cnpj'] = pagador.get('cnpj', pagador.get('cpf')) + #dados['nome'] = pagador.get('nome') + + dados_pix.append(dados) + + return dados_pix + + +def consuta_pix(credentials, dthr_ini, dthr_fim): + resp_json = pega_lista_pix(credentials, dthr_ini, dthr_fim) + dados = trata_resp_pix(resp_json) + return dados + + +if __name__ == '__main__': + from pprint import pprint + + + def teste01(): + dthr_ini = '2024-11-20T00:00:01Z' + dthr_fim = '2024-11-27T23:59:59Z' + key_credentials = 'coralli' + + credentials = env.credenciais[key_credentials] + + dados = consuta_pix(credentials, dthr_ini, dthr_fim) + + pprint(dados) + + teste01() \ No newline at end of file diff --git a/itauapipix/itau_api_pix.py b/itauapipix/itau_api_pix.py new file mode 100644 index 0000000..40f658c --- /dev/null +++ b/itauapipix/itau_api_pix.py @@ -0,0 +1,162 @@ +from datetime import datetime, timedelta +import os +import requests +from requests.auth import AuthBase + +import env_itauapipix as env + +class BadCredentials(Exception): + ... + + +class EmptyPixList(Exception): + ... + + +if hasattr(env, 'PATH_SERVER_CERTS'): + PATH_SERVER_CERTS = env.PATH_SERVER_CERTS +else: + LIBPATH = os.path.dirname(os.path.abspath(__file__)) + PATH_SERVER_CERTS = LIBPATH+'/server_certs/' + +PATH_CLIENT_CERTS = env.PATH_CLIENT_CERTS +SERVERS_CONF = { + 'PROD': { + 'auth': { + 'endpoint': 'https://sts.itau.com.br/api/oauth/token', + }, + 'api': { + 'endpoint': 'https://secure.api.itau/pix_recebimentos/v2/', + }, + }, + +} + + +class ItauAUTH(AuthBase): + + def __init__(self, client_id, client_secret, client_certificate, endpoint, server_cert=None): + self.credentials = (client_id, client_secret) + self.certificate = env.PATH_CLIENT_CERTS + client_certificate + self._token = None + self.expires_in = None + + print("CLIENT_CERT", self.certificate) + self.endpoint = endpoint + + @property + def is_valid(self): + now = datetime.now() + if not self._token or not self.expires_in or self.expires_in <= now: + return False + return True + + @property + def token(self): + if not self.is_valid: + self.renew() + return self._token + + @token.setter + def token(self, token): + type_, value = token + self._token = f'{type_} {value}' + + def handle_401(self, r, **kwargs): + if r.status_code != 401: + return r + + # force token renew + self.renew() + + # Consume content and release the original connection + # to allow our new request to reuse the same one. + r.content + r.close() + prep = r.request.copy() + + prep.headers['Authorization'] = self.token + prep.headers['x-itau-apikey'] = self.credentials[0] + _r = r.connection.send(prep, **kwargs) + _r.history.append(r) + _r.request = prep + + return _r + + def renew(self): + data = f"grant_type=client_credentials&client_id={self.credentials[0]}&client_secret={self.credentials[1]}" + + header= { + 'Content-Type': 'application/x-www-form-urlencoded' + } + + resp = requests.post(self.endpoint, headers=header, cert=self.certificate, data=data) + + if resp.status_code == 401: + raise BadCredentials() + + if resp.status_code == 400: + raise RuntimeError(resp.json()) + + json = resp.json() + self.token = "Bearer", json['access_token'] + + self.expires_in = datetime.now() + timedelta(seconds=json['expires_in']) + + def __call__(self, r): + r.headers['Authorization'] = self.token + r.headers['x-itau-apikey'] = self.credentials[0] + + r.register_hook("response", self.handle_401) + return r + + +class ItauSession(requests.Session): + + def __init__(self, auth, endpoint, server_cert=None): + super().__init__() + self.auth = auth + self.endpoint = endpoint + #self.server_cert = PATH_SERVER_CERTS + server_cert + + def request(self, method: str, path='', *args, **kwargs): + url = self.endpoint + path + # print(url) + resp = super().request(method, url, *args, cert=self.auth.certificate, **kwargs) + return resp + + +class ItauClient: + AUTH = ItauAUTH + SESSION = ItauSession + + def __init__(self, session): + self.session = session + + @classmethod + def from_credentials(cls, client_id: str, + client_secret: str, client_certificate: str, enviroment: str): + server_auth = SERVERS_CONF[enviroment]['auth'] + auth = cls.AUTH(client_id, client_secret, client_certificate, **server_auth) + server_api = SERVERS_CONF[enviroment]['api'] + session = cls.SESSION(auth, **server_api) + return cls(session) + + def request(self, method, path='', params=None, data=None, *args, **kwargs): + resp = self.session.request(method, path=path, params=params, data=data, *args, **kwargs) + if resp.status_code == 404: + raise EmptyPixList + + resp.raise_for_status() + return resp + + # init_datetime: '2023-09-01T00:00:01UTC-3' + def received_pixs(self, init_datetime, end_datetime): + params = { + 'inicio': init_datetime, + 'fim': end_datetime + } + + resp = self.request('get', path='pix', params=params) + + return resp diff --git a/requirements.txt b/requirements.txt index b47df22..a15517c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,9 @@ -mock==2.0.0 -pytest==3.2.0 -tox==2.7.0 -docutils==0.14 -Pygments>=2.7.4 -twine +certifi==2023.7.22 +cffi==1.15.1 +charset-normalizer==3.2.0 +cryptography>=43.0.1 +idna==3.4 +pycparser==2.21 +pyOpenSSL>=24.2.1 +requests>=2.31.0 +urllib3==2.0.4 diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 6372926..0000000 --- a/setup.cfg +++ /dev/null @@ -1,2 +0,0 @@ -[metadata] -license-file = LICENSE diff --git a/setup.py b/setup.py index e972783..34f043b 100644 --- a/setup.py +++ b/setup.py @@ -1,30 +1,13 @@ -# coding: utf-8 -from setuptools import setup -import os +from setuptools import setup, find_packages -README = os.path.join(os.path.dirname(__file__), 'README.rst') - -setup(name='python-decouple', - version='3.8', - description='Strict separation of settings from code.', - long_description=open(README).read(), - author="Henrique Bastos", author_email="henrique@bastos.net", - license="MIT", - py_modules=['decouple'], - zip_safe=False, - platforms='any', - include_package_data=True, - classifiers=[ - 'Development Status :: 5 - Production/Stable', - 'Framework :: Django', - 'Framework :: Flask', - 'Intended Audience :: Developers', - 'License :: OSI Approved :: MIT License', - 'Natural Language :: English', - 'Operating System :: OS Independent', - 'Programming Language :: Python', - 'Programming Language :: Python :: 3', - 'Topic :: Software Development :: Libraries', - ], - url='http://github.com/henriquebastos/python-decouple/',) +setup( + name=itauapipix', + version='0.4', + packages=find_packages(), + #package_data={'itauapipix': ['server_certs/*.cer']}, + install_requires=[ + 'pyOpenSSL >= 24.2.1', + 'requests == 2.31.0', + ], +) diff --git a/tests/__init__.py b/tests/__init__.py deleted file mode 100644 index 57d631c..0000000 --- a/tests/__init__.py +++ /dev/null @@ -1 +0,0 @@ -# coding: utf-8 diff --git a/tests/autoconfig/env/.env b/tests/autoconfig/env/.env deleted file mode 100644 index cf2315a..0000000 --- a/tests/autoconfig/env/.env +++ /dev/null @@ -1 +0,0 @@ -KEY=ENV diff --git a/tests/autoconfig/env/custom-path/.env b/tests/autoconfig/env/custom-path/.env deleted file mode 100644 index 1124b51..0000000 --- a/tests/autoconfig/env/custom-path/.env +++ /dev/null @@ -1 +0,0 @@ -KEY=CUSTOMPATH diff --git a/tests/autoconfig/ini/project/settings.ini b/tests/autoconfig/ini/project/settings.ini deleted file mode 100644 index 3104068..0000000 --- a/tests/autoconfig/ini/project/settings.ini +++ /dev/null @@ -1,2 +0,0 @@ -[settings] -KEY=INI diff --git a/tests/autoconfig/no_repository/empty.txt b/tests/autoconfig/no_repository/empty.txt deleted file mode 100644 index e69de29..0000000 diff --git a/tests/secrets/db_password b/tests/secrets/db_password deleted file mode 100644 index 04fea06..0000000 --- a/tests/secrets/db_password +++ /dev/null @@ -1 +0,0 @@ -world \ No newline at end of file diff --git a/tests/secrets/db_user b/tests/secrets/db_user deleted file mode 100644 index b6fc4c6..0000000 --- a/tests/secrets/db_user +++ /dev/null @@ -1 +0,0 @@ -hello \ No newline at end of file diff --git a/tests/test_autoconfig.py b/tests/test_autoconfig.py deleted file mode 100644 index 94af7cc..0000000 --- a/tests/test_autoconfig.py +++ /dev/null @@ -1,109 +0,0 @@ -# coding: utf-8 -import os -import pytest -from mock import patch, mock_open -from decouple import AutoConfig, UndefinedValueError, RepositoryEmpty, DEFAULT_ENCODING - - -def test_autoconfig_env(): - config = AutoConfig() - path = os.path.join(os.path.dirname(__file__), 'autoconfig', 'env', 'project') - with patch.object(config, '_caller_path', return_value=path): - assert 'ENV' == config('KEY') - - -def test_autoconfig_ini(): - config = AutoConfig() - path = os.path.join(os.path.dirname(__file__), 'autoconfig', 'ini', 'project') - with patch.object(config, '_caller_path', return_value=path): - assert 'INI' == config('KEY') - - -def test_autoconfig_ini_in_subdir(): - """ - When `AutoConfig._find_file()` gets a relative path from - `AutoConfig._caller_path()`, it will not properly search back to parent - dirs. - - This is a regression test to make sure that when - `AutoConfig._caller_path()` finds something like `./config.py` it will look - for settings.ini in parent directories. - """ - config = AutoConfig() - subdir = os.path.join(os.path.dirname(__file__), 'autoconfig', 'ini', - 'project', 'subdir') - os.chdir(subdir) - path = os.path.join(os.path.curdir, 'empty.py') - with patch.object(config, '_caller_path', return_value=path): - assert 'INI' == config('KEY') - - -def test_autoconfig_none(): - os.environ['KeyFallback'] = 'On' - config = AutoConfig() - path = os.path.join(os.path.dirname(__file__), 'autoconfig', 'none') - with patch('os.path.isfile', return_value=False): - assert True is config('KeyFallback', cast=bool) - del os.environ['KeyFallback'] - - -def test_autoconfig_exception(): - os.environ['KeyFallback'] = 'On' - config = AutoConfig() - with patch('os.path.isfile', side_effect=Exception('PermissionDenied')): - assert True is config('KeyFallback', cast=bool) - del os.environ['KeyFallback'] - - -def test_autoconfig_is_not_a_file(): - os.environ['KeyFallback'] = 'On' - config = AutoConfig() - with patch('os.path.isfile', return_value=False): - assert True is config('KeyFallback', cast=bool) - del os.environ['KeyFallback'] - - -def test_autoconfig_search_path(): - path = os.path.join(os.path.dirname(__file__), 'autoconfig', 'env', 'custom-path') - config = AutoConfig(path) - assert 'CUSTOMPATH' == config('KEY') - - -def test_autoconfig_empty_repository(): - path = os.path.join(os.path.dirname(__file__), 'autoconfig', 'env', 'custom-path') - config = AutoConfig(path) - - with pytest.raises(UndefinedValueError): - config('KeyNotInEnvAndNotInRepository') - - assert isinstance(config.config.repository, RepositoryEmpty) - -def test_autoconfig_ini_default_encoding(): - config = AutoConfig() - path = os.path.join(os.path.dirname(__file__), 'autoconfig', 'ini', 'project') - filename = os.path.join(os.path.dirname(__file__), 'autoconfig', 'ini', 'project', 'settings.ini') - with patch.object(config, '_caller_path', return_value=path): - with patch('decouple.open', mock_open(read_data='')) as mopen: - assert config.encoding == DEFAULT_ENCODING - assert 'ENV' == config('KEY', default='ENV') - mopen.assert_called_once_with(filename, encoding=DEFAULT_ENCODING) - -def test_autoconfig_env_default_encoding(): - config = AutoConfig() - path = os.path.join(os.path.dirname(__file__), 'autoconfig', 'env', 'project') - filename = os.path.join(os.path.dirname(__file__), 'autoconfig', 'env', '.env') - with patch.object(config, '_caller_path', return_value=path): - with patch('decouple.open', mock_open(read_data='')) as mopen: - assert config.encoding == DEFAULT_ENCODING - assert 'ENV' == config('KEY', default='ENV') - mopen.assert_called_once_with(filename, encoding=DEFAULT_ENCODING) - - -def test_autoconfig_no_repository(): - path = os.path.join(os.path.dirname(__file__), 'autoconfig', 'ini', 'no_repository') - config = AutoConfig(path) - - with pytest.raises(UndefinedValueError): - config('KeyNotInEnvAndNotInRepository') - - assert isinstance(config.config.repository, RepositoryEmpty) diff --git a/tests/test_env.py b/tests/test_env.py deleted file mode 100644 index a91c95c..0000000 --- a/tests/test_env.py +++ /dev/null @@ -1,142 +0,0 @@ -# coding: utf-8 -import os -import sys -from mock import patch -import pytest -from decouple import Config, RepositoryEnv, UndefinedValueError - - -# Useful for very coarse version differentiation. -PY3 = sys.version_info[0] == 3 - -if PY3: - from io import StringIO -else: - from io import BytesIO as StringIO - - -ENVFILE = ''' -KeyTrue=True -KeyOne=1 -KeyYes=yes -KeyOn=on -KeyY=y - -KeyFalse=False -KeyZero=0 -KeyNo=no -KeyN=n -KeyOff=off -KeyEmpty= - -#CommentedKey=None -PercentNotEscaped=%% -NoInterpolation=%(KeyOff)s -IgnoreSpace = text -RespectSingleQuoteSpace = ' text' -RespectDoubleQuoteSpace = " text" -KeyOverrideByEnv=NotThis - -KeyWithSingleQuoteEnd=text' -KeyWithSingleQuoteMid=te'xt -KeyWithSingleQuoteBegin='text -KeyWithDoubleQuoteEnd=text" -KeyWithDoubleQuoteMid=te"xt -KeyWithDoubleQuoteBegin="text -KeyIsSingleQuote=' -KeyIsDoubleQuote=" -KeyHasTwoSingleQuote="'Y'" -KeyHasTwoDoubleQuote='"Y"' -KeyHasMixedQuotesAsData1="Y' -KeyHasMixedQuotesAsData2='Y" -''' - -@pytest.fixture(scope='module') -def config(): - with patch('decouple.open', return_value=StringIO(ENVFILE), create=True): - return Config(RepositoryEnv('.env')) - - -def test_env_comment(config): - with pytest.raises(UndefinedValueError): - config('CommentedKey') - - -def test_env_percent_not_escaped(config): - assert '%%' == config('PercentNotEscaped') - - -def test_env_no_interpolation(config): - assert '%(KeyOff)s' == config('NoInterpolation') - - -def test_env_bool_true(config): - assert True is config('KeyTrue', cast=bool) - assert True is config('KeyOne', cast=bool) - assert True is config('KeyYes', cast=bool) - assert True is config('KeyOn', cast=bool) - assert True is config('KeyY', cast=bool) - assert True is config('Key1int', default=1, cast=bool) - -def test_env_bool_false(config): - assert False is config('KeyFalse', cast=bool) - assert False is config('KeyZero', cast=bool) - assert False is config('KeyNo', cast=bool) - assert False is config('KeyOff', cast=bool) - assert False is config('KeyN', cast=bool) - assert False is config('KeyEmpty', cast=bool) - assert False is config('Key0int', default=0, cast=bool) - - -def test_env_os_environ(config): - os.environ['KeyOverrideByEnv'] = 'This' - assert 'This' == config('KeyOverrideByEnv') - del os.environ['KeyOverrideByEnv'] - - -def test_env_undefined_but_present_in_os_environ(config): - os.environ['KeyOnlyEnviron'] = '' - assert '' == config('KeyOnlyEnviron') - del os.environ['KeyOnlyEnviron'] - - -def test_env_undefined(config): - with pytest.raises(UndefinedValueError): - config('UndefinedKey') - - -def test_env_default_none(config): - assert None is config('UndefinedKey', default=None) - - -def test_env_empty(config): - assert '' == config('KeyEmpty', default=None) - assert '' == config('KeyEmpty') - - -def test_env_support_space(config): - assert 'text' == config('IgnoreSpace') - assert ' text' == config('RespectSingleQuoteSpace') - assert ' text' == config('RespectDoubleQuoteSpace') - - -def test_env_empty_string_means_false(config): - assert False is config('KeyEmpty', cast=bool) - -def test_env_with_quote(config): - assert "text'" == config('KeyWithSingleQuoteEnd') - assert 'text"' == config('KeyWithDoubleQuoteEnd') - assert "te'xt" == config('KeyWithSingleQuoteMid') - assert "'text" == config('KeyWithSingleQuoteBegin') - assert 'te"xt' == config('KeyWithDoubleQuoteMid') - assert '"text' == config('KeyWithDoubleQuoteBegin') - assert '"' == config('KeyIsDoubleQuote') - assert "'" == config('KeyIsSingleQuote') - assert "'Y'" == config('KeyHasTwoSingleQuote') - assert '"Y"' == config('KeyHasTwoDoubleQuote') - assert '''"Y\'''' == config('KeyHasMixedQuotesAsData1') - assert '''\'Y"''' == config('KeyHasMixedQuotesAsData2') - -def test_env_repo_keyerror(config): - with pytest.raises(KeyError): - config.repository['UndefinedKey'] diff --git a/tests/test_helper_choices.py b/tests/test_helper_choices.py deleted file mode 100644 index 03a9ab2..0000000 --- a/tests/test_helper_choices.py +++ /dev/null @@ -1,103 +0,0 @@ -# coding: utf-8 -import pytest -from decouple import Choices - - -FRUIT_APPLE = 'apple' -FRUIT_BANANA = 'banana' -FRUIT_COCONUT = 'coconut' - -ALLOWED_FRUITS = ( - (FRUIT_APPLE, 'Apple'), - (FRUIT_BANANA, 'Banana'), - (FRUIT_COCONUT, 'Coconut'), - ) - -ZERO = 0 -THREE = 3 -SEVEN = 7 - -ALLOWED_NUMBERS = ( - (ZERO, 'Zero'), - (THREE, 'Three'), - (SEVEN, 'Seven'), - ) - - -def test_default_cast_with_flat_list(): - """Default cast with a flat list.""" - choices = Choices(['a', 'b', 'c']) - assert 'a' == choices('a') - assert 'b' == choices('b') - assert 'c' == choices('c') - - with pytest.raises(ValueError): - choices('d') - - -def test_cast_to_int_with_flat_list(): - """Cast to int with a flat list.""" - choices = Choices([3, 5, 7], cast=int) - assert 3 == choices('3') - assert 5 == choices('5') - assert 7 == choices('7') - - with pytest.raises(ValueError): - choices(1) - - -def test_default_with_django_like_choices(): - """Default cast with a Django-like choices tuple.""" - choices = Choices(choices=ALLOWED_FRUITS) - assert 'apple' == choices('apple') - assert 'banana' == choices('banana') - assert 'coconut' == choices('coconut') - - with pytest.raises(ValueError): - choices('strawberry') - - -def test_cast_to_int_with_django_like_choices(): - """Cast to int with a Django-like choices tuple.""" - choices = Choices(cast=int, choices=ALLOWED_NUMBERS) - assert 0 == choices('0') - assert 3 == choices('3') - assert 7 == choices('7') - - with pytest.raises(ValueError): - choices(1) - - -def test_default_cast_with_booth_flat_list_and_django_like_choices(): - """Default cast with booth flat list and Django-like choices tuple.""" - choices = Choices(['a', 'b', 'c'], choices=ALLOWED_FRUITS) - assert 'a' == choices('a') - assert 'b' == choices('b') - assert 'c' == choices('c') - assert 'apple' == choices('apple') - assert 'banana' == choices('banana') - assert 'coconut' == choices('coconut') - - with pytest.raises(ValueError): - choices('d') - - with pytest.raises(ValueError): - choices('watermelon') - - -def test_cast_to_int_with_booth_flat_list_and_django_like_choices(): - """Cast to int with booth flat list and Django-like choices tuple.""" - choices = Choices([7, 14, 42], cast=int, choices=ALLOWED_NUMBERS) - assert 7 == choices('7') - assert 14 == choices('14') - assert 42 == choices('42') - - assert 0 == choices('0') - assert 3 == choices('3') - assert 7 == choices('7') - - with pytest.raises(ValueError): - choices('not my fault') - - with pytest.raises(ValueError): - choices('1') diff --git a/tests/test_helper_csv.py b/tests/test_helper_csv.py deleted file mode 100644 index c5db287..0000000 --- a/tests/test_helper_csv.py +++ /dev/null @@ -1,36 +0,0 @@ -# coding: utf-8 -from decouple import Csv - - -def test_csv(): - csv = Csv() - assert ['127.0.0.1', '.localhost', '.herokuapp.com'] == \ - csv('127.0.0.1, .localhost, .herokuapp.com') - - csv = Csv(int) - assert [1, 2, 3, 4, 5] == csv('1,2,3,4,5') - - csv = Csv(post_process=tuple) - assert ('HTTP_X_FORWARDED_PROTO', 'https') == \ - csv('HTTP_X_FORWARDED_PROTO, https') - - csv = Csv(cast=lambda s: s.upper(), delimiter='\t', strip=' %*') - assert ['VIRTUAL_ENV', 'IMPORTANT STUFF', 'TRAILING SPACES'] == \ - csv('%virtual_env%\t *important stuff*\t trailing spaces ') - - -def test_csv_quoted_parse(): - csv = Csv() - - assert ['foo', 'bar, baz', 'qux'] == csv(""" foo ,'bar, baz', 'qux'""") - - assert ['foo', 'bar, baz', 'qux'] == csv(''' foo ,"bar, baz", "qux"''') - - assert ['foo', "'bar, baz'", "'qux"] == csv(''' foo ,"'bar, baz'", "'qux"''') - - assert ['foo', '"bar, baz"', '"qux'] == csv(""" foo ,'"bar, baz"', '"qux'""") - - -def test_csv_none(): - csv = Csv() - assert [] == csv(None) diff --git a/tests/test_ini.py b/tests/test_ini.py deleted file mode 100644 index f610078..0000000 --- a/tests/test_ini.py +++ /dev/null @@ -1,128 +0,0 @@ -# coding: utf-8 -import os -import sys -from mock import patch, mock_open -import pytest -from decouple import Config, RepositoryIni, UndefinedValueError - -# Useful for very coarse version differentiation. -PY3 = sys.version_info[0] == 3 - -if PY3: - from io import StringIO -else: - from io import BytesIO as StringIO - - - -INIFILE = ''' -[settings] -KeyTrue=True -KeyOne=1 -KeyYes=yes -KeyY=y -KeyOn=on - -KeyFalse=False -KeyZero=0 -KeyNo=no -KeyN=n -KeyOff=off -KeyEmpty= - -#CommentedKey=None -PercentIsEscaped=%% -Interpolation=%(KeyOff)s -IgnoreSpace = text -KeyOverrideByEnv=NotThis -''' - -@pytest.fixture(scope='module') -def config(): - with patch('decouple.open', return_value=StringIO(INIFILE), create=True): - return Config(RepositoryIni('settings.ini')) - - -def test_ini_comment(config): - with pytest.raises(UndefinedValueError): - config('CommentedKey') - - -def test_ini_percent_escape(config): - assert '%' == config('PercentIsEscaped') - - -def test_ini_interpolation(config): - assert 'off' == config('Interpolation') - - -def test_ini_bool_true(config): - assert True is config('KeyTrue', cast=bool) - assert True is config('KeyOne', cast=bool) - assert True is config('KeyYes', cast=bool) - assert True is config('KeyY', cast=bool) - assert True is config('KeyOn', cast=bool) - assert True is config('Key1int', default=1, cast=bool) - - -def test_ini_bool_false(config): - assert False is config('KeyFalse', cast=bool) - assert False is config('KeyZero', cast=bool) - assert False is config('KeyNo', cast=bool) - assert False is config('KeyOff', cast=bool) - assert False is config('KeyN', cast=bool) - assert False is config('KeyEmpty', cast=bool) - assert False is config('Key0int', default=0, cast=bool) - - -def test_init_undefined(config): - with pytest.raises(UndefinedValueError): - config('UndefinedKey') - - -def test_ini_default_none(config): - assert None is config('UndefinedKey', default=None) - - -def test_ini_default_bool(config): - assert False is config('UndefinedKey', default=False, cast=bool) - assert True is config('UndefinedKey', default=True, cast=bool) - - -def test_ini_default(config): - assert False is config('UndefinedKey', default=False) - assert True is config('UndefinedKey', default=True) - - -def test_ini_default_invalid_bool(config): - with pytest.raises(ValueError): - config('UndefinedKey', default='NotBool', cast=bool) - - -def test_ini_empty(config): - assert '' == config('KeyEmpty', default=None) - - -def test_ini_support_space(config): - assert 'text' == config('IgnoreSpace') - - -def test_ini_os_environ(config): - os.environ['KeyOverrideByEnv'] = 'This' - assert 'This' == config('KeyOverrideByEnv') - del os.environ['KeyOverrideByEnv'] - - -def test_ini_undefined_but_present_in_os_environ(config): - os.environ['KeyOnlyEnviron'] = '' - assert '' == config('KeyOnlyEnviron') - del os.environ['KeyOnlyEnviron'] - - -def test_ini_empty_string_means_false(config): - assert False is config('KeyEmpty', cast=bool) - - -def test_ini_repo_keyerror(config): - with pytest.raises(KeyError): - config.repository['UndefinedKey'] diff --git a/tests/test_secrets.py b/tests/test_secrets.py deleted file mode 100644 index 7d6185b..0000000 --- a/tests/test_secrets.py +++ /dev/null @@ -1,38 +0,0 @@ -# coding: utf-8 -import os -import pytest - -from decouple import Config, RepositorySecret - - -def test_secrets(): - path = os.path.join(os.path.dirname(__file__), 'secrets') - config = Config(RepositorySecret(path)) - - assert 'hello' == config('db_user') - assert 'world' == config('db_password') - - -def test_no_secret_but_present_in_os_environ(): - path = os.path.join(os.path.dirname(__file__), 'secrets') - config = Config(RepositorySecret(path)) - - os.environ['KeyOnlyEnviron'] = 'SOMETHING' - assert 'SOMETHING' == config('KeyOnlyEnviron') - del os.environ['KeyOnlyEnviron'] - - -def test_secret_overriden_by_environ(): - path = os.path.join(os.path.dirname(__file__), 'secrets') - config = Config(RepositorySecret(path)) - - os.environ['db_user'] = 'hi' - assert 'hi' == config('db_user') - del os.environ['db_user'] - -def test_secret_repo_keyerror(): - path = os.path.join(os.path.dirname(__file__), 'secrets') - repo = RepositorySecret(path) - - with pytest.raises(KeyError): - repo['UndefinedKey'] diff --git a/tests/test_strtobool.py b/tests/test_strtobool.py deleted file mode 100644 index ba39930..0000000 --- a/tests/test_strtobool.py +++ /dev/null @@ -1,18 +0,0 @@ -import pytest -from decouple import strtobool - - -@pytest.mark.parametrize("value", ("Y", "YES", "T", "TRUE", "ON", "1")) -def test_true_values(value): - assert strtobool(value) - - -@pytest.mark.parametrize("value", ("N", "NO", "F", "FALSE", "OFF", "0")) -def test_false_values(value): - assert strtobool(value) is False - - -def test_invalid(): - with pytest.raises(ValueError, match="Invalid truth value"): - strtobool("MAYBE") - diff --git a/tox.ini b/tox.ini deleted file mode 100644 index 3210f2f..0000000 --- a/tox.ini +++ /dev/null @@ -1,8 +0,0 @@ -[tox] -envlist = py2, py3 - -[testenv] -deps = - mock - pytest -commands=py.test