Skip to content

Latest commit

 

History

History
122 lines (89 loc) · 4.38 KB

README.md

File metadata and controls

122 lines (89 loc) · 4.38 KB

swagger-client

APIs da plataforma de Ressarcimento do Open Banking Brasil para a comunicação online com a plaforma. Através da documentação das APIs abaixo é possível realizar os devidos testes de integração.

This Python package is automatically generated by the Swagger Codegen project:

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import swagger_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RefundAPIV1Api(swagger_client.ApiClient(configuration))
process_id = 'process_id_example' # str | 

try:
    # Operação de consulta de processos de transações
    api_response = api_instance.find_notification_by_id(process_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RefundAPIV1Api->find_notification_by_id: %s\n" % e)

# create an instance of the API class
api_instance = swagger_client.RefundAPIV1Api(swagger_client.ApiClient(configuration))

try:
    # Operação de consulta de monitoramento de processos de transações
    api_response = api_instance.healthcheck()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RefundAPIV1Api->healthcheck: %s\n" % e)

# create an instance of the API class
api_instance = swagger_client.RefundAPIV1Api(swagger_client.ApiClient(configuration))
body = swagger_client.RefundNotification() # RefundNotification | 

try:
    # Operação de registro unitário de transação 
    api_response = api_instance.notification(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RefundAPIV1Api->notification: %s\n" % e)

# create an instance of the API class
api_instance = swagger_client.RefundAPIV1Api(swagger_client.ApiClient(configuration))
body = [swagger_client.RefundNotification()] # list[RefundNotification] | 

try:
    # Operação de registro em massa de uma transação
    api_response = api_instance.notifications(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RefundAPIV1Api->notifications: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://ressarcimento.opbkdev.smartfylabs.com

Class Method HTTP request Description
RefundAPIV1Api find_notification_by_id GET /apis/v1/refund/notifications/{processId} Operação de consulta de processos de transações
RefundAPIV1Api healthcheck GET /apis/v1/refund/notifications/healthcheck Operação de consulta de monitoramento de processos de transações
RefundAPIV1Api notification POST /apis/v1/refund/notifications/ Operação de registro unitário de transação
RefundAPIV1Api notifications PATCH /apis/v1/refund/notifications/ Operação de registro em massa de uma transação

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

suporte-ressarcimento@openbankingbrasil.org.br