Read one PAG0137 instruction and its answer

curl --request GET \
  --url https://siloc.sandbox.lerian.net/api/v1/siloc/outbound/salary-account-transfers/{id} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://siloc.sandbox.lerian.net/api/v1/siloc/outbound/salary-account-transfers/{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://siloc.sandbox.lerian.net/api/v1/siloc/outbound/salary-account-transfers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://siloc.sandbox.lerian.net/api/v1/siloc/outbound/salary-account-transfers/{id}"

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

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

print(response.text)

{
  "attempts": 123,
  "codMsg": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "numCtrlIF": "<string>",
  "nuop": "<string>",
  "request": {
    "CPFCliDebtd": "<string>",
    "DtMovto": "<string>",
    "ISPBIFCredtd": "<string>",
    "NomCliDebtd": "<string>",
    "TpCtCredtd": "<string>",
    "VlrLanc": "<string>",
    "AgCredtd": "<string>",
    "AgDebtd": "<string>",
    "CodIdentdTransf": "<string>",
    "CtCredtd": "<string>",
    "CtDebtd": "<string>",
    "CtPgtoCredtd": "<string>",
    "CtPgtoDebtd": "<string>",
    "Hist": "<string>",
    "NivelPrefPAG": "<string>"
  },
  "status": "SUBMITTED",
  "submittedAt": "2023-11-07T05:31:56Z",
  "answer": {
    "codMsg": "<string>",
    "movementDate": "2023-12-25",
    "numCtrlPAG": "<string>",
    "sitLancPAG": "<string>",
    "situationAt": "2023-11-07T05:31:56Z"
  },
  "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"
  }
}

Read one PAG0137 instruction and its answer

The stored PAG0137 request projected verbatim, its dispatch state, and — once the câmara has answered — the Número Controle PAG and the Situação Lançamento PAG it assigned, also verbatim. status is SUBMITTED (recorded; still queued, retried on a backoff), DISPATCHED (on the queue, awaiting the answer), ANSWERED, REFUSED (the câmara returned the PAG0137E twin; lastError carries its CodErro values) or FAILED (this rail could not deliver it). sitLancPAG is projected VERBATIM and never decoded: its values are published separately in the Dicionário de Domínios, with activation and deactivation dates per value, so what a situação means about the money is the ledger consumer’s call.

GET

api

siloc

outbound

salary-account-transfers

{id}

Read one PAG0137 instruction and its answer

curl --request GET \
  --url https://siloc.sandbox.lerian.net/api/v1/siloc/outbound/salary-account-transfers/{id} \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://siloc.sandbox.lerian.net/api/v1/siloc/outbound/salary-account-transfers/{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://siloc.sandbox.lerian.net/api/v1/siloc/outbound/salary-account-transfers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://siloc.sandbox.lerian.net/api/v1/siloc/outbound/salary-account-transfers/{id}"

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

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

print(response.text)

{
  "attempts": 123,
  "codMsg": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "numCtrlIF": "<string>",
  "nuop": "<string>",
  "request": {
    "CPFCliDebtd": "<string>",
    "DtMovto": "<string>",
    "ISPBIFCredtd": "<string>",
    "NomCliDebtd": "<string>",
    "TpCtCredtd": "<string>",
    "VlrLanc": "<string>",
    "AgCredtd": "<string>",
    "AgDebtd": "<string>",
    "CodIdentdTransf": "<string>",
    "CtCredtd": "<string>",
    "CtDebtd": "<string>",
    "CtPgtoCredtd": "<string>",
    "CtPgtoDebtd": "<string>",
    "Hist": "<string>",
    "NivelPrefPAG": "<string>"
  },
  "status": "SUBMITTED",
  "submittedAt": "2023-11-07T05:31:56Z",
  "answer": {
    "codMsg": "<string>",
    "movementDate": "2023-12-25",
    "numCtrlPAG": "<string>",
    "sitLancPAG": "<string>",
    "situationAt": "2023-11-07T05:31:56Z"
  },
  "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"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

string<uuid>

required

Outbound message id.

Response

attempts

integer<int64>

required

Queue-put attempts made so far.

codMsg

string

required

The SFN instruction code this row carries, e.g. PAG0107.

string<uuid>

required

Outbound message id.

numCtrlIF

string

required

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

nuop

string

required

The BCMSG operation number of the frame.

request

object

required

The request exactly as it was submitted, projected verbatim.

Show child attributes

status

enum<string>

required

Lifecycle state. REFUSED means the câmara received the instruction and returned its E twin; FAILED means this rail could not deliver it. Both are terminal and they are different facts.

Available options:

SUBMITTED,

DISPATCHED,

ANSWERED,

REFUSED,

FAILED

submittedAt

string<date-time>

required

When the instruction was recorded.

answer

object

What the câmara answered; omitted until it has answered.

Show child attributes

answerAbsent

boolean

True only on an ANSWERED message whose answer body this rail does not hold. The câmara did answer; what it wrote is not here, and the missing answer block is that absence, never an empty answer. Omitted otherwise.

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, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither applies.

Integration

Connectivity

Homologation

Participants

Cycles and settlement

Transfers

Collateral

Card route

Entries and statements

Advices and notices

Alerts and audit

Schedule

Error handling

Read one PAG0137 instruction and its answer

Authorizations

Path Parameters

Response