Skip to content

Latest commit

 

History

History
195 lines (141 loc) · 6.3 KB

RefundAPIV1Api.md

File metadata and controls

195 lines (141 loc) · 6.3 KB
Raw

RefundAPIV1Api

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

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

findNotificationById

RefundProcess findNotificationById(processId)

Operação de consulta de processos de transações

Método da API de Consulta de processos de transações de APIs do Open Banking Brasil. O sistema utilizará essas informações para consultar processos que podem ter uma ou mais transações dentro da plataformas dos participantes. <br> Para a utilização deste método é necessário gerar um Token de Acesso na plataforma central do Diretório do Open Banking Brasil.

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.swagger.client.models.*;

val apiInstance = RefundAPIV1Api()
val processId : kotlin.String = processId_example // kotlin.String | 
try {
    val result : RefundProcess = apiInstance.findNotificationById(processId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling RefundAPIV1Api#findNotificationById")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling RefundAPIV1Api#findNotificationById")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
processId kotlin.String

Return type

RefundProcess

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

healthcheck

RefundProcess healthcheck()

Operação de consulta de monitoramento de processos de transações

Método da API de Consulta de Monitoramento de processos de transações para verificar o status das APIs do Open Banking Brasil.O sistema utilizará essas informações para monitorar os processos e transações dentro das plataformas dos participantes. <br> Para a utilização deste método é necessário gerar um Token de Acesso na plataforma central do Diretório do Open Banking Brasil.

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.swagger.client.models.*;

val apiInstance = RefundAPIV1Api()
try {
    val result : RefundProcess = apiInstance.healthcheck()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling RefundAPIV1Api#healthcheck")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling RefundAPIV1Api#healthcheck")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

RefundProcess

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

notification

RefundProcess notification(body)

Operação de registro unitário de transação

Método da API de Reporte unitário de consumo de APIs do Open Banking Brasil. O sistema utilizará essas informações para conciliar e contabilizar os custos das plataformas dos participantes. <br> Para a utilização deste método é necessário gerar um Token de Acesso na plataforma central do Diretório do Open Banking Brasil.

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.swagger.client.models.*;

val apiInstance = RefundAPIV1Api()
val body : RefundNotification =  // RefundNotification | 
try {
    val result : RefundProcess = apiInstance.notification(body)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling RefundAPIV1Api#notification")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling RefundAPIV1Api#notification")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
body RefundNotification

Return type

RefundProcess

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

notifications

RefundProcess notifications(body)

Operação de registro em massa de uma transação

Método da API de Reporte de atualização em massa de APIs do Open Banking Brasil. O sistema utilizará essas informações para conciliar e contabilizar os custos das plataformas dos participantes. <br> Para a utilização deste método é necessário gerar um Token de Acesso na plataforma central do Diretório do Open Banking Brasil.

Example

// Import classes:
//import io.swagger.client.infrastructure.*
//import io.swagger.client.models.*;

val apiInstance = RefundAPIV1Api()
val body : kotlin.Array<RefundNotification> =  // kotlin.Array<RefundNotification> | 
try {
    val result : RefundProcess = apiInstance.notifications(body)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling RefundAPIV1Api#notifications")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling RefundAPIV1Api#notifications")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
body kotlin.Array<RefundNotification>

Return type

RefundProcess

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json