Transfer funds to settle a barcoded document

curl --request POST \
  --url https://api.example.com/api/v1/siloc/outbound/barcode-document-settlements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "AgDebtd": "<string>",
  "CNPJ_CPFCed": "<string>",
  "CNPJ_CPFSacd": "<string>",
  "CanPgto": "<string>",
  "DtMovto": "<string>",
  "ISPBIFCredtd": "<string>",
  "NumCodBarras": "<string>",
  "TpDocBarras": "<string>",
  "TpPessoaCed": "<string>",
  "TpPessoaSacd": "<string>",
  "VlrLanc": "<string>",
  "AgCredtd": "<string>",
  "CodIdentdTransf": "<string>",
  "DtAgendt": "<string>",
  "Hist": "<string>",
  "NivelPrefPAG": "<string>",
  "VlrDesct_Abatt": "<string>",
  "VlrDoc": "<string>",
  "VlrJuros": "<string>",
  "VlrMulta": "<string>",
  "VlrOtrAcresc": "<string>"
}
'

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/outbound/barcode-document-settlements"

	payload := strings.NewReader("{\n  \"AgDebtd\": \"<string>\",\n  \"CNPJ_CPFCed\": \"<string>\",\n  \"CNPJ_CPFSacd\": \"<string>\",\n  \"CanPgto\": \"<string>\",\n  \"DtMovto\": \"<string>\",\n  \"ISPBIFCredtd\": \"<string>\",\n  \"NumCodBarras\": \"<string>\",\n  \"TpDocBarras\": \"<string>\",\n  \"TpPessoaCed\": \"<string>\",\n  \"TpPessoaSacd\": \"<string>\",\n  \"VlrLanc\": \"<string>\",\n  \"AgCredtd\": \"<string>\",\n  \"CodIdentdTransf\": \"<string>\",\n  \"DtAgendt\": \"<string>\",\n  \"Hist\": \"<string>\",\n  \"NivelPrefPAG\": \"<string>\",\n  \"VlrDesct_Abatt\": \"<string>\",\n  \"VlrDoc\": \"<string>\",\n  \"VlrJuros\": \"<string>\",\n  \"VlrMulta\": \"<string>\",\n  \"VlrOtrAcresc\": \"<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({
    AgDebtd: '<string>',
    CNPJ_CPFCed: '<string>',
    CNPJ_CPFSacd: '<string>',
    CanPgto: '<string>',
    DtMovto: '<string>',
    ISPBIFCredtd: '<string>',
    NumCodBarras: '<string>',
    TpDocBarras: '<string>',
    TpPessoaCed: '<string>',
    TpPessoaSacd: '<string>',
    VlrLanc: '<string>',
    AgCredtd: '<string>',
    CodIdentdTransf: '<string>',
    DtAgendt: '<string>',
    Hist: '<string>',
    NivelPrefPAG: '<string>',
    VlrDesct_Abatt: '<string>',
    VlrDoc: '<string>',
    VlrJuros: '<string>',
    VlrMulta: '<string>',
    VlrOtrAcresc: '<string>'
  })
};

fetch('https://api.example.com/api/v1/siloc/outbound/barcode-document-settlements', 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/barcode-document-settlements"

payload = {
    "AgDebtd": "<string>",
    "CNPJ_CPFCed": "<string>",
    "CNPJ_CPFSacd": "<string>",
    "CanPgto": "<string>",
    "DtMovto": "<string>",
    "ISPBIFCredtd": "<string>",
    "NumCodBarras": "<string>",
    "TpDocBarras": "<string>",
    "TpPessoaCed": "<string>",
    "TpPessoaSacd": "<string>",
    "VlrLanc": "<string>",
    "AgCredtd": "<string>",
    "CodIdentdTransf": "<string>",
    "DtAgendt": "<string>",
    "Hist": "<string>",
    "NivelPrefPAG": "<string>",
    "VlrDesct_Abatt": "<string>",
    "VlrDoc": "<string>",
    "VlrJuros": "<string>",
    "VlrMulta": "<string>",
    "VlrOtrAcresc": "<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": {
    "AgDebtd": "<string>",
    "CNPJ_CPFCed": "<string>",
    "CNPJ_CPFSacd": "<string>",
    "CanPgto": "<string>",
    "DtMovto": "<string>",
    "ISPBIFCredtd": "<string>",
    "NumCodBarras": "<string>",
    "TpDocBarras": "<string>",
    "TpPessoaCed": "<string>",
    "TpPessoaSacd": "<string>",
    "VlrLanc": "<string>",
    "AgCredtd": "<string>",
    "CodIdentdTransf": "<string>",
    "DtAgendt": "<string>",
    "Hist": "<string>",
    "NivelPrefPAG": "<string>",
    "VlrDesct_Abatt": "<string>",
    "VlrDoc": "<string>",
    "VlrJuros": "<string>",
    "VlrMulta": "<string>",
    "VlrOtrAcresc": "<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"
  }
}

Transfer funds to settle a barcoded document

Issues a PAG0122 “IF requisita Transferência de recursos para liquidação de documentos com código de barras” to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Requests a transfer of funds to settle a document carrying a barcode, naming the drawee, the assignor, the payment channel and the amount breakdown the collection carried. The instruction 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 (PAG0122R1) arrives asynchronously and is read back with getPAG0122. Every amount 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

barcode-document-settlements

Transfer funds to settle a barcoded document

curl --request POST \
  --url https://api.example.com/api/v1/siloc/outbound/barcode-document-settlements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "AgDebtd": "<string>",
  "CNPJ_CPFCed": "<string>",
  "CNPJ_CPFSacd": "<string>",
  "CanPgto": "<string>",
  "DtMovto": "<string>",
  "ISPBIFCredtd": "<string>",
  "NumCodBarras": "<string>",
  "TpDocBarras": "<string>",
  "TpPessoaCed": "<string>",
  "TpPessoaSacd": "<string>",
  "VlrLanc": "<string>",
  "AgCredtd": "<string>",
  "CodIdentdTransf": "<string>",
  "DtAgendt": "<string>",
  "Hist": "<string>",
  "NivelPrefPAG": "<string>",
  "VlrDesct_Abatt": "<string>",
  "VlrDoc": "<string>",
  "VlrJuros": "<string>",
  "VlrMulta": "<string>",
  "VlrOtrAcresc": "<string>"
}
'

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/outbound/barcode-document-settlements"

	payload := strings.NewReader("{\n  \"AgDebtd\": \"<string>\",\n  \"CNPJ_CPFCed\": \"<string>\",\n  \"CNPJ_CPFSacd\": \"<string>\",\n  \"CanPgto\": \"<string>\",\n  \"DtMovto\": \"<string>\",\n  \"ISPBIFCredtd\": \"<string>\",\n  \"NumCodBarras\": \"<string>\",\n  \"TpDocBarras\": \"<string>\",\n  \"TpPessoaCed\": \"<string>\",\n  \"TpPessoaSacd\": \"<string>\",\n  \"VlrLanc\": \"<string>\",\n  \"AgCredtd\": \"<string>\",\n  \"CodIdentdTransf\": \"<string>\",\n  \"DtAgendt\": \"<string>\",\n  \"Hist\": \"<string>\",\n  \"NivelPrefPAG\": \"<string>\",\n  \"VlrDesct_Abatt\": \"<string>\",\n  \"VlrDoc\": \"<string>\",\n  \"VlrJuros\": \"<string>\",\n  \"VlrMulta\": \"<string>\",\n  \"VlrOtrAcresc\": \"<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({
    AgDebtd: '<string>',
    CNPJ_CPFCed: '<string>',
    CNPJ_CPFSacd: '<string>',
    CanPgto: '<string>',
    DtMovto: '<string>',
    ISPBIFCredtd: '<string>',
    NumCodBarras: '<string>',
    TpDocBarras: '<string>',
    TpPessoaCed: '<string>',
    TpPessoaSacd: '<string>',
    VlrLanc: '<string>',
    AgCredtd: '<string>',
    CodIdentdTransf: '<string>',
    DtAgendt: '<string>',
    Hist: '<string>',
    NivelPrefPAG: '<string>',
    VlrDesct_Abatt: '<string>',
    VlrDoc: '<string>',
    VlrJuros: '<string>',
    VlrMulta: '<string>',
    VlrOtrAcresc: '<string>'
  })
};

fetch('https://api.example.com/api/v1/siloc/outbound/barcode-document-settlements', 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/barcode-document-settlements"

payload = {
    "AgDebtd": "<string>",
    "CNPJ_CPFCed": "<string>",
    "CNPJ_CPFSacd": "<string>",
    "CanPgto": "<string>",
    "DtMovto": "<string>",
    "ISPBIFCredtd": "<string>",
    "NumCodBarras": "<string>",
    "TpDocBarras": "<string>",
    "TpPessoaCed": "<string>",
    "TpPessoaSacd": "<string>",
    "VlrLanc": "<string>",
    "AgCredtd": "<string>",
    "CodIdentdTransf": "<string>",
    "DtAgendt": "<string>",
    "Hist": "<string>",
    "NivelPrefPAG": "<string>",
    "VlrDesct_Abatt": "<string>",
    "VlrDoc": "<string>",
    "VlrJuros": "<string>",
    "VlrMulta": "<string>",
    "VlrOtrAcresc": "<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": {
    "AgDebtd": "<string>",
    "CNPJ_CPFCed": "<string>",
    "CNPJ_CPFSacd": "<string>",
    "CanPgto": "<string>",
    "DtMovto": "<string>",
    "ISPBIFCredtd": "<string>",
    "NumCodBarras": "<string>",
    "TpDocBarras": "<string>",
    "TpPessoaCed": "<string>",
    "TpPessoaSacd": "<string>",
    "VlrLanc": "<string>",
    "AgCredtd": "<string>",
    "CodIdentdTransf": "<string>",
    "DtAgendt": "<string>",
    "Hist": "<string>",
    "NivelPrefPAG": "<string>",
    "VlrDesct_Abatt": "<string>",
    "VlrDoc": "<string>",
    "VlrJuros": "<string>",
    "VlrMulta": "<string>",
    "VlrOtrAcresc": "<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.

Headers

X-Idempotency

string

required

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

Maximum string length: 255

Body

application/json

AgDebtd

string

required

Agência Debitada (Agencia, [1..1]).

CNPJ_CPFCed

string

required

CNPJ ou CPF Cedente (CNPJ_CPF, [1..1]).

CNPJ_CPFSacd

string

required

CNPJ ou CPF Sacado (CNPJ_CPF, [1..1]).

CanPgto

string

required

Canal Pagamento (CanPgto, [1..1]).

DtMovto

string

required

Data Movimento (xs:date, [1..1]).

ISPBIFCredtd

string

required

ISPB IF Creditada (ISPB, [1..1]).

NumCodBarras

string

required

Número Código Barras (NumCodBarras, [1..1]).

TpDocBarras

string

required

Tipo Documento Barras (TpDocBarras, [1..1]).

TpPessoaCed

string

required

Tipo Pessoa Cedente (TpPessoa, [1..1]).

TpPessoaSacd

string

required

Tipo Pessoa Sacado (TpPessoa, [1..1]).

VlrLanc

string

required

Valor Lançamento (Valor, [1..1]).

AgCredtd

string

Agência Creditada (Agencia, [0..1]).

CodIdentdTransf

string

Código Identificador Transferência (CodIdentdTransf, [0..1]).

DtAgendt

string

Data Agendamento (xs:date, [0..1]).

Hist

string

Histórico (Historico, [0..1]).

NivelPrefPAG

string

Nível Preferência PAG (PrefPAG, [0..1]).

VlrDesct_Abatt

string

Valor Desconto ou Abatimento (Valor, [0..1]).

VlrDoc

string

Valor Documento (Valor, [0..1]).

VlrJuros

string

Valor Juros (Valor, [0..1]).

VlrMulta

string

Valor Multa (Valor, [0..1]).

VlrOtrAcresc

string

Valor Outros Acréscimos (Valor, [0..1]).

Response

Accepted

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. 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.

Integration

Connectivity

Homologation

Participants

Cycles and settlement

Transfers

Collateral

Card route

Entries and statements

Advices and notices

Alerts and audit

Schedule

Error handling

Transfer funds to settle a barcoded document

Authorizations

Headers

Body

Response