Get a cycle's reconciliation result

curl --request GET \
  --url https://api.example.com/api/v1/siloc/cycles/{cycleId}/reconciliation \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/siloc/cycles/{cycleId}/reconciliation"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/siloc/cycles/{cycleId}/reconciliation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/v1/siloc/cycles/{cycleId}/reconciliation"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "cycleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "matched": true,
  "reason": "SOURCE_MISSING",
  "reconciledAt": "2023-11-07T05:31:56Z",
  "clearingAmount": "<string>",
  "mismatchDetail": "<string>",
  "resultNoticeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "settledAmount": "<string>"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

GET

api

siloc

cycles

{cycleId}

reconciliation

Get a cycle's reconciliation result

curl --request GET \
  --url https://api.example.com/api/v1/siloc/cycles/{cycleId}/reconciliation \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/siloc/cycles/{cycleId}/reconciliation"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/v1/siloc/cycles/{cycleId}/reconciliation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/v1/siloc/cycles/{cycleId}/reconciliation"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "cycleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "matched": true,
  "reason": "SOURCE_MISSING",
  "reconciledAt": "2023-11-07T05:31:56Z",
  "clearingAmount": "<string>",
  "mismatchDetail": "<string>",
  "resultNoticeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "settledAmount": "<string>"
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizações

Authorization

string

header

obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

cycleId

string<uuid>

obrigatório

Cycle id.

Resposta

cycleId

string<uuid>

obrigatório

Reconciled cycle id.

matched

boolean

obrigatório

True iff reason == MATCHED.

reason

enum<string>

obrigatório

Deterministic outcome class.

Opções disponíveis:

SOURCE_MISSING,

MATCHED,

SIDE_MISMATCH,

AMOUNT_MISMATCH

reconciledAt

string<date-time>

obrigatório

Reconciliation instant.

clearingAmount

string

The GEN0015 result's VlrMultlatBco in canonical form (evidence); omitted when it is not a readable Valor.

mismatchDetail

string

Explanation for a non-MATCHED outcome.

resultNoticeId

string<uuid>

The GEN0015 notice whose multilateral result was compared; omitted for SOURCE_MISSING.

settledAmount

string

The obligation's canonical magnitude (evidence).

Integração

Conectividade

Homologação

Participantes

Ciclos e liquidação

Transferências

Garantias

Rota de cartões

Lançamentos e extratos

Avisos e notificações

Alertas e auditoria

Agendamento

Tratamento de erros

Get a cycle's reconciliation result

Autorizações

Parâmetros de caminho

Resposta