Confirm or diverge from an announced LBTR result

curl --request POST \
  --url https://api.example.com/api/v1/siloc/outbound/ltr-result-decisions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "decidedAt": "2023-11-07T05:31:56Z",
  "movementDate": "2023-12-25",
  "numCtrlLTROr": "<string>",
  "tpConfDivg": "<string>"
}
'

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/outbound/ltr-result-decisions"

	payload := strings.NewReader("{\n  \"decidedAt\": \"2023-11-07T05:31:56Z\",\n  \"movementDate\": \"2023-12-25\",\n  \"numCtrlLTROr\": \"<string>\",\n  \"tpConfDivg\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    decidedAt: '2023-11-07T05:31:56Z',
    movementDate: '2023-12-25',
    numCtrlLTROr: '<string>',
    tpConfDivg: '<string>'
  })
};

fetch('https://api.example.com/api/v1/siloc/outbound/ltr-result-decisions', 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/outbound/ltr-result-decisions"

payload = {
    "decidedAt": "2023-11-07T05:31:56Z",
    "movementDate": "2023-12-25",
    "numCtrlLTROr": "<string>",
    "tpConfDivg": "<string>"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "attempts": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "numCtrlIF": "<string>",
  "nuop": "<string>",
  "request": "<unknown>",
  "status": "SUBMITTED",
  "submittedAt": "2023-11-07T05:31:56Z",
  "answer": {
    "dtMovto": "<string>",
    "positions": [
      {
        "cnpjNLiqdant": "<string>",
        "dtHrSit": "<string>",
        "ispbIFLiqdant": "<string>",
        "numCtrlLTROr": "<string>",
        "sitLancLTR": "<string>",
        "tpDebCred": "<string>",
        "vlrLanc": "<string>",
        "hist": "<string>",
        "identdPartCamr": "<string>",
        "numOpLTR": "<string>",
        "vlrCredNLiqdant": "<string>",
        "vlrDebNLiqdant": "<string>"
      }
    ],
    "dtHrLTR": "<string>",
    "dtHrSit": "<string>",
    "dtLiquid": "<string>",
    "numCtrlSLC": "<string>",
    "sitLancSLC": "<string>"
  },
  "answerAbsent": true,
  "answeredAt": "2023-11-07T05:31:56Z",
  "dispatchedAt": "2023-11-07T05:31:56Z",
  "lastError": "<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"
  }
}

Confirm or diverge from an announced LBTR result

Issues an LTR0002 “IF informa Resultado da negociação confirmado ou divergente” to the câmara (Catálogo de Serviços do SFN v5.13, Vol II), answering the LTR0001 it announced. The request is minted, built, signed, encrypted and durably recorded before anything reaches the queue: this returns 202 with the control number the câmara will echo, and the answer (LTR0002R1) arrives asynchronously. tpConfDivg is C (Confirma) or D (Diverge), the BACEN Dicionário de Domínios TpConfDivg values. When the LBTR cycle of the movementDate it carries is closed (from 17h30 Brasília or the later LBTR close an operator recorded for that day at recordScheduleChange, or all day on a non-business day), it answers 422 with SILOC-0025 and stores nothing; a movementDate later than today’s in Brasília answers no announced LTR0001 and is refused 422 with SILOC-0022. An operation whose earlier answer is SUBMITTED, DISPATCHED or ANSWERED takes no second one: 409 with SILOC-0026, nothing stored; after that answer FAILED or was REFUSED a new one is accepted, and an answered confirmation (C) still takes a divergence (D).

POST

api

siloc

outbound

ltr-result-decisions

Confirm or diverge from an announced LBTR result

curl --request POST \
  --url https://api.example.com/api/v1/siloc/outbound/ltr-result-decisions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "decidedAt": "2023-11-07T05:31:56Z",
  "movementDate": "2023-12-25",
  "numCtrlLTROr": "<string>",
  "tpConfDivg": "<string>"
}
'

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/outbound/ltr-result-decisions"

	payload := strings.NewReader("{\n  \"decidedAt\": \"2023-11-07T05:31:56Z\",\n  \"movementDate\": \"2023-12-25\",\n  \"numCtrlLTROr\": \"<string>\",\n  \"tpConfDivg\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Idempotency", "<x-idempotency>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {
    'X-Idempotency': '<x-idempotency>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    decidedAt: '2023-11-07T05:31:56Z',
    movementDate: '2023-12-25',
    numCtrlLTROr: '<string>',
    tpConfDivg: '<string>'
  })
};

fetch('https://api.example.com/api/v1/siloc/outbound/ltr-result-decisions', 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/outbound/ltr-result-decisions"

payload = {
    "decidedAt": "2023-11-07T05:31:56Z",
    "movementDate": "2023-12-25",
    "numCtrlLTROr": "<string>",
    "tpConfDivg": "<string>"
}
headers = {
    "X-Idempotency": "<x-idempotency>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "attempts": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "numCtrlIF": "<string>",
  "nuop": "<string>",
  "request": "<unknown>",
  "status": "SUBMITTED",
  "submittedAt": "2023-11-07T05:31:56Z",
  "answer": {
    "dtMovto": "<string>",
    "positions": [
      {
        "cnpjNLiqdant": "<string>",
        "dtHrSit": "<string>",
        "ispbIFLiqdant": "<string>",
        "numCtrlLTROr": "<string>",
        "sitLancLTR": "<string>",
        "tpDebCred": "<string>",
        "vlrLanc": "<string>",
        "hist": "<string>",
        "identdPartCamr": "<string>",
        "numOpLTR": "<string>",
        "vlrCredNLiqdant": "<string>",
        "vlrDebNLiqdant": "<string>"
      }
    ],
    "dtHrLTR": "<string>",
    "dtHrSit": "<string>",
    "dtLiquid": "<string>",
    "numCtrlSLC": "<string>",
    "sitLancSLC": "<string>"
  },
  "answerAbsent": true,
  "answeredAt": "2023-11-07T05:31:56Z",
  "dispatchedAt": "2023-11-07T05:31:56Z",
  "lastError": "<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.

Cabeçalhos

X-Idempotency

string

obrigatório

Idempotency key for this state-changing request (required, max 255 characters).

Maximum string length: 255

Corpo

application/json

decidedAt

string<date-time>

obrigatório

The deciding institution's own clock (DtHrIF).

movementDate

string<date>

obrigatório

The movement date (DtMovto), YYYY-MM-DD.

numCtrlLTROr

string

obrigatório

The câmara's control number on the LTR0001 being answered (NumCtrlLTROr).

Required string length: 1 - 20

tpConfDivg

string

obrigatório

Tipo Confirma ou Diverge: C (Confirma) or D (Diverge), the Dicionário de Domínios TpConfDivg values.

Required string length: 1

Resposta

Accepted

attempts

integer<int64>

obrigatório

Queue-put attempts made so far.

string<uuid>

obrigatório

Message id.

numCtrlIF

string

obrigatório

The control number this institution issued (NumCtrlIF). The câmara echoes it on the answer, which is what correlates the two.

nuop

string

obrigatório

The BCMSG operation number of the frame.

request

any

obrigatório

The submitted request, projected verbatim.

status

enum<string>

obrigatório

Lifecycle state. REFUSED means the câmara received the message and said no; FAILED means it never reached the wire.

Opções disponíveis:

SUBMITTED,

DISPATCHED,

ANSWERED,

REFUSED,

FAILED

submittedAt

string<date-time>

obrigatório

When the message was recorded.

answer

object

The câmara's answer body, verbatim. Omitted until the message is ANSWERED, and on an ANSWERED message whose body this rail does not hold — which answerAbsent then states. Never on the submit (POST) receipt, which states the message and its current status only: read the answer with GET.

Show child attributes

answerAbsent

boolean

True only on an ANSWERED message whose answer body this rail does not hold (answered before bodies were stored). The câmara did answer; what it wrote is not here. Omitted otherwise, and always on the submit (POST) receipt.

answeredAt

string<date-time>

When the câmara's answer was applied; omitted until it is.

dispatchedAt

string<date-time>

When the frame reached the send queue; omitted until it has.

lastError

string

Why the last queue put failed, that the message waits unsent for its LBTR cycle to open at 06h40 Brasília, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when none applies, and always on the submit (POST) receipt.

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

Confirm or diverge from an announced LBTR result

Autorizações

Cabeçalhos

Corpo

Resposta