Get an OT settlement instruction

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

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/settlement-instructions/{instructionId}"

	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/settlement-instructions/{instructionId}', 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/settlement-instructions/{instructionId}"

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

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

print(response.text)

{
  "amountCanonical": "<string>",
  "amountRaw": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "cycleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "depositDeadlineAt": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "movementDate": "<string>",
  "numCtrlLdl": "<string>",
  "pendingBeyondTwoCycles": true,
  "periodCode": "<string>",
  "product": "<string>",
  "side": "DEBIT",
  "sourceNuOp": "<string>",
  "state": "RECEIVED",
  "traceabilityId": "<string>",
  "depositAdvisoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lastFundingAck": {
    "at": "2023-11-07T05:31:56Z",
    "factType": "DEPOSIT_CONFIRMED",
    "refusal": {
      "errorCode": "<string>",
      "messageCode": "LDL0022E",
      "railClose": "GRADE_CLOSED"
    },
    "sitLancLdl": "<string>"
  },
  "numCtrlStr": "<string>",
  "receivedAt": "2023-11-07T05:31:56Z",
  "terminalAt": "2023-11-07T05:31:56Z",
  "terminalSourceEventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "terminalTimestampRaw": "<string>",
  "terminalTimestampSource": "<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

settlement-instructions

{instructionId}

Get an OT settlement instruction

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

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/settlement-instructions/{instructionId}"

	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/settlement-instructions/{instructionId}', 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/settlement-instructions/{instructionId}"

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

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

print(response.text)

{
  "amountCanonical": "<string>",
  "amountRaw": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "cycleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "depositDeadlineAt": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "movementDate": "<string>",
  "numCtrlLdl": "<string>",
  "pendingBeyondTwoCycles": true,
  "periodCode": "<string>",
  "product": "<string>",
  "side": "DEBIT",
  "sourceNuOp": "<string>",
  "state": "RECEIVED",
  "traceabilityId": "<string>",
  "depositAdvisoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lastFundingAck": {
    "at": "2023-11-07T05:31:56Z",
    "factType": "DEPOSIT_CONFIRMED",
    "refusal": {
      "errorCode": "<string>",
      "messageCode": "LDL0022E",
      "railClose": "GRADE_CLOSED"
    },
    "sitLancLdl": "<string>"
  },
  "numCtrlStr": "<string>",
  "receivedAt": "2023-11-07T05:31:56Z",
  "terminalAt": "2023-11-07T05:31:56Z",
  "terminalSourceEventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "terminalTimestampRaw": "<string>",
  "terminalTimestampSource": "<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

instructionId

string<uuid>

obrigatório

Instruction id.

Resposta

amountCanonical

string

obrigatório

Canonical NUMERIC(19,2), decimal string.

amountRaw

string

obrigatório

VlrLanc verbatim (validated magnitude).

createdAt

string<date-time>

obrigatório

Row creation instant (list cursor key).

cycleId

string<uuid>

obrigatório

Correlated cycle id (1:1).

depositDeadlineAt

string<date-time>

obrigatório

Funding deadline (HrioLimDep on DtDep).

string<uuid>

obrigatório

Instruction id.

movementDate

string

obrigatório

Business (reference) date, YYYY-MM-DD.

numCtrlLdl

string

obrigatório

Câmara control number (NumCtrlLDL).

pendingBeyondTwoCycles

boolean

obrigatório

True when still non-terminal and at least two later same-product cycles have CLOSED (a chronology flag, not a position).

periodCode

string

obrigatório

Operating-period token inherited from the cycle.

product

string

obrigatório

Rail product; always OT.

side

enum<string>

obrigatório

Explicit money direction (never derived from the amount sign).

Opções disponíveis:

DEBIT,

CREDIT

sourceNuOp

string

obrigatório

LDL0021 BCMSG operation number (idempotency key).

state

enum<string>

obrigatório

Funding lifecycle state; a deposit the STR refused leaves it FUNDING_REQUIRED, a PAG0101 that puts this institution in status 2 or 8 closes an undeposited debit EXCLUDED, and a recálculo round closes an expected credit REPLACED.

Opções disponíveis:

RECEIVED,

FUNDING_REQUIRED,

CREDIT_EXPECTED,

SETTLED,

EXCLUDED,

REPLACED

traceabilityId

string

obrigatório

num_ctrl_if (siloc_ot_traceability); correlates to the STR reserve-transfer outcome.

depositAdvisoryId

string<uuid>

ce-id of the deposit-required advisory Lerian SILOC emitted for this obligation, the advisoryId the Lerian SPB deposit command names; omitted for a credit or a zero obligation.

lastFundingAck

object

The latest funding ack by STR instant; omitted until the first one lands.

Show child attributes

numCtrlStr

string

STR reserve-transfer control number; omitted until linked.

receivedAt

string<date-time>

Terminal funding-ack local ingest instant; omitted until terminal.

terminalAt

string<date-time>

Regulator-authoritative terminal instant; omitted until terminal.

terminalSourceEventId

string<uuid>

ce-id of the terminalising SPB fact; omitted until terminal.

terminalTimestampRaw

string

Terminal timestamp raw wire form; omitted until terminal.

terminalTimestampSource

string

Terminal timestamp provenance tag; omitted until terminal.

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 an OT settlement instruction

Autorizações

Parâmetros de caminho

Resposta