Read one outbound message, whatever its code

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

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/outbound/messages/{id}"

	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/outbound/messages/{id}', 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/messages/{id}"

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

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

print(response.text)

{
  "attempts": 123,
  "codMsg": "<string>",
  "heldForAnswer": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "numCtrlIF": "<string>",
  "nuop": "<string>",
  "status": "SUBMITTED",
  "submittedAt": "2023-11-07T05:31:56Z",
  "answeredAt": "2023-11-07T05:31:56Z",
  "closeRequest": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "messageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reason": "<string>",
    "requestedAt": "2023-11-07T05:31:56Z",
    "requestedBy": "<string>",
    "status": "PENDING",
    "numCtrl": "<string>",
    "outcome": "SETTLED",
    "parkedAnswerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "settledAt": "2023-11-07T05:31:56Z",
    "situation": "<string>"
  },
  "codProdt": "<string>",
  "dispatchedAt": "2023-11-07T05:31:56Z",
  "lastError": "<string>",
  "nextAttemptAt": "2023-11-07T05:31:56Z",
  "parkedAnswers": [
    {
      "codMsg": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payload": "<string>",
      "status": "PENDING",
      "rejectReason": "<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

outbound

messages

{id}

Read one outbound message, whatever its code

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

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/outbound/messages/{id}"

	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/outbound/messages/{id}', 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/messages/{id}"

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

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

print(response.text)

{
  "attempts": 123,
  "codMsg": "<string>",
  "heldForAnswer": true,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "numCtrlIF": "<string>",
  "nuop": "<string>",
  "status": "SUBMITTED",
  "submittedAt": "2023-11-07T05:31:56Z",
  "answeredAt": "2023-11-07T05:31:56Z",
  "closeRequest": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "messageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reason": "<string>",
    "requestedAt": "2023-11-07T05:31:56Z",
    "requestedBy": "<string>",
    "status": "PENDING",
    "numCtrl": "<string>",
    "outcome": "SETTLED",
    "parkedAnswerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "settledAt": "2023-11-07T05:31:56Z",
    "situation": "<string>"
  },
  "codProdt": "<string>",
  "dispatchedAt": "2023-11-07T05:31:56Z",
  "lastError": "<string>",
  "nextAttemptAt": "2023-11-07T05:31:56Z",
  "parkedAnswers": [
    {
      "codMsg": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payload": "<string>",
      "status": "PENDING",
      "rejectReason": "<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

string

obrigatório

Outbound message id.

Resposta

attempts

integer<int64>

obrigatório

Queue-put attempts made so far.

codMsg

string

obrigatório

The SFN message code this row carries, e.g. LDL0023.

heldForAnswer

boolean

obrigatório

True when the câmara's answer may never come and two operators can close the message as failed (see requestOutboundMessageClose): its time ran out after a put whose outcome is unknown (SUBMITTED), or an LTR0002 or LTR0008 was DISPATCHED and its LBTR cycle ended with no R1.

string<uuid>

obrigatório

Outbound message id.

numCtrlIF

string

obrigatório

The control number this institution issued. 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.

status

enum<string>

obrigatório

Lifecycle state. REFUSED and FAILED are both terminal and are different facts: REFUSED means the câmara received the message and returned its E twin, FAILED means this rail could not deliver it and will not retry, or two operators closed a send whose outcome was unknown.

Opções disponíveis:

SUBMITTED,

DISPATCHED,

ANSWERED,

REFUSED,

FAILED

submittedAt

string<date-time>

obrigatório

When the message was recorded.

answeredAt

string<date-time>

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

closeRequest

object

The first operator's request to close this held message as failed, awaiting a second operator's approval; omitted when none awaits.

Show child attributes

codProdt

string

The SILOC product, OT or SLC; omitted when the message's layout carries no product element.

dispatchedAt

string<date-time>

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

lastError

string

Why the last attempt failed, or that an LBTR message waits unsent for its cycle to open, which counts no attempt; omitted when neither applies.

nextAttemptAt

string<date-time>

When the next queue put comes due; omitted once the row is terminal or answered.

parkedAnswers

object[]

The câmara answers parked unresolved for this held message; omitted when none. A message with one cannot be closed plainly: a SEMANTIC_REJECTED answer is declared by two operators as what its codMsg states (parkedAnswerId and outcome on the close request), any other can still replay.

Show child attributes

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

Read one outbound message, whatever its code

Autorizações

Parâmetros de caminho

Resposta