Ask the câmara to accept a collateral withdrawal

curl --request POST \
  --url https://api.example.com/api/v1/siloc/outbound/withdrawal-acceptance-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "CNPJEntRespons": "<string>",
  "DtMovto": "<string>",
  "Grupo_LDL1006_Atv": [
    {
      "CodTitlar": "<string>",
      "FinlddCob": "<string>",
      "NumCtrlReqIF": "<string>",
      "TpTitlar": "<string>",
      "CodProdt": "<string>",
      "CodSubTitlar": "<string>",
      "DtVenc": "<string>",
      "NumAtv": "<string>",
      "TpSubTitlar": "<string>"
    }
  ],
  "ISPBLDL": "<string>",
  "TpAtv": "<string>",
  "TpReq": "<string>",
  "NumCtrlLDLOr": "<string>"
}
'

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/outbound/withdrawal-acceptance-requests"

	payload := strings.NewReader("{\n  \"CNPJEntRespons\": \"<string>\",\n  \"DtMovto\": \"<string>\",\n  \"Grupo_LDL1006_Atv\": [\n    {\n      \"CodTitlar\": \"<string>\",\n      \"FinlddCob\": \"<string>\",\n      \"NumCtrlReqIF\": \"<string>\",\n      \"TpTitlar\": \"<string>\",\n      \"CodProdt\": \"<string>\",\n      \"CodSubTitlar\": \"<string>\",\n      \"DtVenc\": \"<string>\",\n      \"NumAtv\": \"<string>\",\n      \"TpSubTitlar\": \"<string>\"\n    }\n  ],\n  \"ISPBLDL\": \"<string>\",\n  \"TpAtv\": \"<string>\",\n  \"TpReq\": \"<string>\",\n  \"NumCtrlLDLOr\": \"<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({
    CNPJEntRespons: '<string>',
    DtMovto: '<string>',
    Grupo_LDL1006_Atv: [
      {
        CodTitlar: '<string>',
        FinlddCob: '<string>',
        NumCtrlReqIF: '<string>',
        TpTitlar: '<string>',
        CodProdt: '<string>',
        CodSubTitlar: '<string>',
        DtVenc: '<string>',
        NumAtv: '<string>',
        TpSubTitlar: '<string>'
      }
    ],
    ISPBLDL: '<string>',
    TpAtv: '<string>',
    TpReq: '<string>',
    NumCtrlLDLOr: '<string>'
  })
};

fetch('https://api.example.com/api/v1/siloc/outbound/withdrawal-acceptance-requests', 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/withdrawal-acceptance-requests"

payload = {
    "CNPJEntRespons": "<string>",
    "DtMovto": "<string>",
    "Grupo_LDL1006_Atv": [
        {
            "CodTitlar": "<string>",
            "FinlddCob": "<string>",
            "NumCtrlReqIF": "<string>",
            "TpTitlar": "<string>",
            "CodProdt": "<string>",
            "CodSubTitlar": "<string>",
            "DtVenc": "<string>",
            "NumAtv": "<string>",
            "TpSubTitlar": "<string>"
        }
    ],
    "ISPBLDL": "<string>",
    "TpAtv": "<string>",
    "TpReq": "<string>",
    "NumCtrlLDLOr": "<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,
  "codMsg": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "numCtrlIF": "<string>",
  "nuop": "<string>",
  "request": {
    "CNPJEntRespons": "<string>",
    "DtMovto": "<string>",
    "Grupo_LDL1006_Atv": [
      {
        "CodTitlar": "<string>",
        "FinlddCob": "<string>",
        "NumCtrlReqIF": "<string>",
        "TpTitlar": "<string>",
        "CodProdt": "<string>",
        "CodSubTitlar": "<string>",
        "DtVenc": "<string>",
        "Grupo_LDL1006_CTP": {
          "DtEmsCTP": "<string>",
          "EmissorActtCTP": "<string>",
          "FIRCTP": "<string>",
          "IdentdCtrapartCamr": "<string>",
          "IdentdPartCamr": "<string>",
          "IdentdSistCTP": "<string>",
          "IdentdTitCTP": "<string>",
          "NumOpCTP": "<string>",
          "QtdCTP": "<string>",
          "QtdMinTitCTP": "<string>",
          "SubTpAtv": "<string>",
          "DtAquis": "<string>",
          "PUAquis": "<string>",
          "TaxCTP": "<string>"
        },
        "Grupo_LDL1006_Fianc": {
          "CNPJEmissorFianc": "<string>",
          "DtEmsFianc": "<string>",
          "VlrFaceFianc": "<string>",
          "NumCtrlEmissorFianc": "<string>"
        },
        "Grupo_LDL1006_ME": {
          "CodMoeda": "<string>",
          "VlrME": "<string>",
          "VlrMinME": "<string>"
        },
        "Grupo_LDL1006_Otr": {
          "IdentdOtrAtv": "<string>",
          "TpOtrAtv": "<string>",
          "ISPBIFLiqdant": "<string>",
          "Qtd": "<string>",
          "QtdMin": "<string>",
          "Vlr": "<string>",
          "VlrMin": "<string>"
        },
        "Grupo_LDL1006_SEL": {
          "CtCed": "<string>",
          "CtCes": "<string>",
          "IdentdTitSEL": "<string>",
          "QtdMinTit": "<string>",
          "QtdTit": "<string>",
          "ChASEL": "<string>",
          "PU": "<string>"
        },
        "NumAtv": "<string>",
        "TpSubTitlar": "<string>"
      }
    ],
    "ISPBLDL": "<string>",
    "TpAtv": "<string>",
    "TpReq": "<string>",
    "NumCtrlLDLOr": "<string>"
  },
  "status": "SUBMITTED",
  "submittedAt": "2023-11-07T05:31:56Z",
  "answer": {
    "codMsg": "<string>",
    "details": "<unknown>",
    "movementDate": "2023-12-25",
    "numCtrlLDL": "<string>",
    "camaraAt": "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"
  }
}

Ask the câmara to accept a collateral withdrawal

Issues a LDL1006 to the Câmara LDL on behalf of an Entidade Responsável (Catálogo de Serviços do SFN v5.13, Vol II). Requests the câmara’s acceptance of a withdrawal — voluntary or required — of guarantee, margin or securities (Vol II, Evento LDL1006 Descrição). The câmara answers per asset, accepting or rejecting each one it was sent (Evento LDL1006 Observação), so a single answer can carry both outcomes. The request is minted, built, signed, encrypted and durably recorded BEFORE anything reaches the queue, so this returns 202 with the control number the câmara will echo; the answer (LDL1006R1) arrives asynchronously and is read back with getLDL1006. Every amount and quantity is a decimal STRING carried to the wire exactly as written. A deployment with no send leg configured answers 503 with SILOC-0023; one whose dispatcher is not running, or whose Núclea queue manager is unreachable or refuses this rail’s configuration, answers 503 with SILOC-0024. A DtMovto whose day already ended in Brasília answers 422 with SILOC-0025; nothing is stored.

POST

api

siloc

outbound

withdrawal-acceptance-requests

Ask the câmara to accept a collateral withdrawal

curl --request POST \
  --url https://api.example.com/api/v1/siloc/outbound/withdrawal-acceptance-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "CNPJEntRespons": "<string>",
  "DtMovto": "<string>",
  "Grupo_LDL1006_Atv": [
    {
      "CodTitlar": "<string>",
      "FinlddCob": "<string>",
      "NumCtrlReqIF": "<string>",
      "TpTitlar": "<string>",
      "CodProdt": "<string>",
      "CodSubTitlar": "<string>",
      "DtVenc": "<string>",
      "NumAtv": "<string>",
      "TpSubTitlar": "<string>"
    }
  ],
  "ISPBLDL": "<string>",
  "TpAtv": "<string>",
  "TpReq": "<string>",
  "NumCtrlLDLOr": "<string>"
}
'

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/outbound/withdrawal-acceptance-requests"

	payload := strings.NewReader("{\n  \"CNPJEntRespons\": \"<string>\",\n  \"DtMovto\": \"<string>\",\n  \"Grupo_LDL1006_Atv\": [\n    {\n      \"CodTitlar\": \"<string>\",\n      \"FinlddCob\": \"<string>\",\n      \"NumCtrlReqIF\": \"<string>\",\n      \"TpTitlar\": \"<string>\",\n      \"CodProdt\": \"<string>\",\n      \"CodSubTitlar\": \"<string>\",\n      \"DtVenc\": \"<string>\",\n      \"NumAtv\": \"<string>\",\n      \"TpSubTitlar\": \"<string>\"\n    }\n  ],\n  \"ISPBLDL\": \"<string>\",\n  \"TpAtv\": \"<string>\",\n  \"TpReq\": \"<string>\",\n  \"NumCtrlLDLOr\": \"<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({
    CNPJEntRespons: '<string>',
    DtMovto: '<string>',
    Grupo_LDL1006_Atv: [
      {
        CodTitlar: '<string>',
        FinlddCob: '<string>',
        NumCtrlReqIF: '<string>',
        TpTitlar: '<string>',
        CodProdt: '<string>',
        CodSubTitlar: '<string>',
        DtVenc: '<string>',
        NumAtv: '<string>',
        TpSubTitlar: '<string>'
      }
    ],
    ISPBLDL: '<string>',
    TpAtv: '<string>',
    TpReq: '<string>',
    NumCtrlLDLOr: '<string>'
  })
};

fetch('https://api.example.com/api/v1/siloc/outbound/withdrawal-acceptance-requests', 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/withdrawal-acceptance-requests"

payload = {
    "CNPJEntRespons": "<string>",
    "DtMovto": "<string>",
    "Grupo_LDL1006_Atv": [
        {
            "CodTitlar": "<string>",
            "FinlddCob": "<string>",
            "NumCtrlReqIF": "<string>",
            "TpTitlar": "<string>",
            "CodProdt": "<string>",
            "CodSubTitlar": "<string>",
            "DtVenc": "<string>",
            "NumAtv": "<string>",
            "TpSubTitlar": "<string>"
        }
    ],
    "ISPBLDL": "<string>",
    "TpAtv": "<string>",
    "TpReq": "<string>",
    "NumCtrlLDLOr": "<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,
  "codMsg": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "numCtrlIF": "<string>",
  "nuop": "<string>",
  "request": {
    "CNPJEntRespons": "<string>",
    "DtMovto": "<string>",
    "Grupo_LDL1006_Atv": [
      {
        "CodTitlar": "<string>",
        "FinlddCob": "<string>",
        "NumCtrlReqIF": "<string>",
        "TpTitlar": "<string>",
        "CodProdt": "<string>",
        "CodSubTitlar": "<string>",
        "DtVenc": "<string>",
        "Grupo_LDL1006_CTP": {
          "DtEmsCTP": "<string>",
          "EmissorActtCTP": "<string>",
          "FIRCTP": "<string>",
          "IdentdCtrapartCamr": "<string>",
          "IdentdPartCamr": "<string>",
          "IdentdSistCTP": "<string>",
          "IdentdTitCTP": "<string>",
          "NumOpCTP": "<string>",
          "QtdCTP": "<string>",
          "QtdMinTitCTP": "<string>",
          "SubTpAtv": "<string>",
          "DtAquis": "<string>",
          "PUAquis": "<string>",
          "TaxCTP": "<string>"
        },
        "Grupo_LDL1006_Fianc": {
          "CNPJEmissorFianc": "<string>",
          "DtEmsFianc": "<string>",
          "VlrFaceFianc": "<string>",
          "NumCtrlEmissorFianc": "<string>"
        },
        "Grupo_LDL1006_ME": {
          "CodMoeda": "<string>",
          "VlrME": "<string>",
          "VlrMinME": "<string>"
        },
        "Grupo_LDL1006_Otr": {
          "IdentdOtrAtv": "<string>",
          "TpOtrAtv": "<string>",
          "ISPBIFLiqdant": "<string>",
          "Qtd": "<string>",
          "QtdMin": "<string>",
          "Vlr": "<string>",
          "VlrMin": "<string>"
        },
        "Grupo_LDL1006_SEL": {
          "CtCed": "<string>",
          "CtCes": "<string>",
          "IdentdTitSEL": "<string>",
          "QtdMinTit": "<string>",
          "QtdTit": "<string>",
          "ChASEL": "<string>",
          "PU": "<string>"
        },
        "NumAtv": "<string>",
        "TpSubTitlar": "<string>"
      }
    ],
    "ISPBLDL": "<string>",
    "TpAtv": "<string>",
    "TpReq": "<string>",
    "NumCtrlLDLOr": "<string>"
  },
  "status": "SUBMITTED",
  "submittedAt": "2023-11-07T05:31:56Z",
  "answer": {
    "codMsg": "<string>",
    "details": "<unknown>",
    "movementDate": "2023-12-25",
    "numCtrlLDL": "<string>",
    "camaraAt": "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"
  }
}

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

CNPJEntRespons

string

obrigatório

CNPJ Entidade Responsável (CNPJ, [1..1]). The responsible entity this institution acts for.

DtMovto

string

obrigatório

Data Movimento (Data, [1..1]), as YYYY-MM-DD.

Grupo_LDL1006_Atv

object[] | null

obrigatório

Grupo Ativo ([1..n]): one entry per asset. An empty list is refused — a request naming no asset would look, to the operator who sent it, like a withdrawal in flight.

Show child attributes

ISPBLDL

string

obrigatório

ISPB LDL: the câmara addressed (ISPB, [1..1]).

TpAtv

string

obrigatório

Tipo Ativo (TpAtv, [1..1]).

TpReq

string

obrigatório

Tipo Requisição (TpReq, [1..1]): whether the withdrawal is voluntary or required.

NumCtrlLDLOr

string

Número Controle LDL Original (ControleIF, [0..1]): the câmara demand this withdrawal answers.

Resposta

Accepted

attempts

integer<int64>

obrigatório

Queue-put attempts made so far.

codMsg

string

obrigatório

The SFN request code this row carries, e.g. LDL1002.

string<uuid>

obrigatório

Outbound 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

object

obrigatório

The request exactly as it was submitted, projected verbatim.

Show child attributes

status

enum<string>

obrigatório

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

Opções disponíveis:

SUBMITTED,

DISPATCHED,

ANSWERED,

REFUSED,

FAILED

submittedAt

string<date-time>

obrigatório

When the request was recorded.

answer

object

What the câmara answered; omitted until it has answered. 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. 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, 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, or — on REFUSED — the CodErro values the câmara marked, verbatim. Omitted when neither 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

Ask the câmara to accept a collateral withdrawal

Autorizações

Cabeçalhos

Corpo

Resposta