README.md

C# SDK Client - Plataforma de Ressarcimento do Open Banking Brasil

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 C# SDK is automatically generated by the Swagger Codegen project:

• API version: beta-0.0.1
• SDK version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.dotnet.CSharpClientCodegen For more information, please visit http://suporte.ressarcimento.openbankingbrasil.org.br

Frameworks supported

• .NET 4.0 or later
• Windows Phone 7.1 (Mango)

Dependencies

• RestSharp - 105.1.0 or later
• Json.NET - 7.0.0 or later
• JsonSubTypes - 1.2.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

• [Mac/Linux] /bin/sh build.sh
• [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out IO.Swagger.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Getting Started

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {
            var apiInstance = new RefundAPIV1Api();
            var processId = processId_example;  // string | 

            try
            {
                // Operação de consulta de processos de transações
                RefundProcess result = apiInstance.FindNotificationById(processId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RefundAPIV1Api.FindNotificationById: " + e.Message );
            }
        }
    }
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
RefundAPIV1Api	FindNotificationById	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

• Model.RefundNotification
• Model.RefundProcess

Documentation for Authorization

All endpoints do not require authorization.