Transfer funds on behalf of a non-account holder

curl --request POST \
  --url https://api.example.com/api/v1/siloc/outbound/non-account-holder-transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "AgDebtd": "<string>",
  "CNPJ_CPFDestinatario": "<string>",
  "CNPJ_CPFRemet": "<string>",
  "DtMovto": "<string>",
  "FinlddCli": "<string>",
  "ISPBIFCredtd": "<string>",
  "NomDestinatario": "<string>",
  "NomRemet": "<string>",
  "TpPessoaDestinatario": "<string>",
  "TpPessoaRemet": "<string>",
  "VlrLanc": "<string>",
  "AgCredtd": "<string>",
  "CodDocFis": "<string>",
  "CtCredtd": "<string>",
  "CtPgtoCredtd": "<string>",
  "DtAgendt": "<string>",
  "Hist": "<string>",
  "NivelPrefPAG": "<string>",
  "TpCtCredtd": "<string>",
  "VlrCBS": "<string>",
  "VlrIBS": "<string>"
}
'

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/outbound/non-account-holder-transfers"

	payload := strings.NewReader("{\n  \"AgDebtd\": \"<string>\",\n  \"CNPJ_CPFDestinatario\": \"<string>\",\n  \"CNPJ_CPFRemet\": \"<string>\",\n  \"DtMovto\": \"<string>\",\n  \"FinlddCli\": \"<string>\",\n  \"ISPBIFCredtd\": \"<string>\",\n  \"NomDestinatario\": \"<string>\",\n  \"NomRemet\": \"<string>\",\n  \"TpPessoaDestinatario\": \"<string>\",\n  \"TpPessoaRemet\": \"<string>\",\n  \"VlrLanc\": \"<string>\",\n  \"AgCredtd\": \"<string>\",\n  \"CodDocFis\": \"<string>\",\n  \"CtCredtd\": \"<string>\",\n  \"CtPgtoCredtd\": \"<string>\",\n  \"DtAgendt\": \"<string>\",\n  \"Hist\": \"<string>\",\n  \"NivelPrefPAG\": \"<string>\",\n  \"TpCtCredtd\": \"<string>\",\n  \"VlrCBS\": \"<string>\",\n  \"VlrIBS\": \"<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_CPFDestinatario: '<string>',
    CNPJ_CPFRemet: '<string>',
    DtMovto: '<string>',
    FinlddCli: '<string>',
    ISPBIFCredtd: '<string>',
    NomDestinatario: '<string>',
    NomRemet: '<string>',
    TpPessoaDestinatario: '<string>',
    TpPessoaRemet: '<string>',
    VlrLanc: '<string>',
    AgCredtd: '<string>',
    CodDocFis: '<string>',
    CtCredtd: '<string>',
    CtPgtoCredtd: '<string>',
    DtAgendt: '<string>',
    Hist: '<string>',
    NivelPrefPAG: '<string>',
    TpCtCredtd: '<string>',
    VlrCBS: '<string>',
    VlrIBS: '<string>'
  })
};

fetch('https://api.example.com/api/v1/siloc/outbound/non-account-holder-transfers', 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/non-account-holder-transfers"

payload = {
    "AgDebtd": "<string>",
    "CNPJ_CPFDestinatario": "<string>",
    "CNPJ_CPFRemet": "<string>",
    "DtMovto": "<string>",
    "FinlddCli": "<string>",
    "ISPBIFCredtd": "<string>",
    "NomDestinatario": "<string>",
    "NomRemet": "<string>",
    "TpPessoaDestinatario": "<string>",
    "TpPessoaRemet": "<string>",
    "VlrLanc": "<string>",
    "AgCredtd": "<string>",
    "CodDocFis": "<string>",
    "CtCredtd": "<string>",
    "CtPgtoCredtd": "<string>",
    "DtAgendt": "<string>",
    "Hist": "<string>",
    "NivelPrefPAG": "<string>",
    "TpCtCredtd": "<string>",
    "VlrCBS": "<string>",
    "VlrIBS": "<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_CPFDestinatario": "<string>",
    "CNPJ_CPFRemet": "<string>",
    "DtMovto": "<string>",
    "FinlddCli": "<string>",
    "ISPBIFCredtd": "<string>",
    "NomDestinatario": "<string>",
    "NomRemet": "<string>",
    "TpPessoaDestinatario": "<string>",
    "TpPessoaRemet": "<string>",
    "VlrLanc": "<string>",
    "AgCredtd": "<string>",
    "CodDocFis": "<string>",
    "CtCredtd": "<string>",
    "CtPgtoCredtd": "<string>",
    "DtAgendt": "<string>",
    "Hist": "<string>",
    "NivelPrefPAG": "<string>",
    "TpCtCredtd": "<string>",
    "VlrCBS": "<string>",
    "VlrIBS": "<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 on behalf of a non-account holder

Issues a PAG0107 “IF requisita Transferência de recursos por conta de não-correntistas” to the Câmara PAG (Catálogo de Serviços do SFN v5.13, Vol II). Requests a transfer of funds on behalf of a party that holds no account at this institution, for credit to a client or non-account-holder account at another one. 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 (PAG0107R1) arrives asynchronously and is read back with getPAG0107. 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

non-account-holder-transfers

Transfer funds on behalf of a non-account holder

curl --request POST \
  --url https://api.example.com/api/v1/siloc/outbound/non-account-holder-transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Idempotency: <x-idempotency>' \
  --data '
{
  "AgDebtd": "<string>",
  "CNPJ_CPFDestinatario": "<string>",
  "CNPJ_CPFRemet": "<string>",
  "DtMovto": "<string>",
  "FinlddCli": "<string>",
  "ISPBIFCredtd": "<string>",
  "NomDestinatario": "<string>",
  "NomRemet": "<string>",
  "TpPessoaDestinatario": "<string>",
  "TpPessoaRemet": "<string>",
  "VlrLanc": "<string>",
  "AgCredtd": "<string>",
  "CodDocFis": "<string>",
  "CtCredtd": "<string>",
  "CtPgtoCredtd": "<string>",
  "DtAgendt": "<string>",
  "Hist": "<string>",
  "NivelPrefPAG": "<string>",
  "TpCtCredtd": "<string>",
  "VlrCBS": "<string>",
  "VlrIBS": "<string>"
}
'

package main

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

func main() {

	url := "https://api.example.com/api/v1/siloc/outbound/non-account-holder-transfers"

	payload := strings.NewReader("{\n  \"AgDebtd\": \"<string>\",\n  \"CNPJ_CPFDestinatario\": \"<string>\",\n  \"CNPJ_CPFRemet\": \"<string>\",\n  \"DtMovto\": \"<string>\",\n  \"FinlddCli\": \"<string>\",\n  \"ISPBIFCredtd\": \"<string>\",\n  \"NomDestinatario\": \"<string>\",\n  \"NomRemet\": \"<string>\",\n  \"TpPessoaDestinatario\": \"<string>\",\n  \"TpPessoaRemet\": \"<string>\",\n  \"VlrLanc\": \"<string>\",\n  \"AgCredtd\": \"<string>\",\n  \"CodDocFis\": \"<string>\",\n  \"CtCredtd\": \"<string>\",\n  \"CtPgtoCredtd\": \"<string>\",\n  \"DtAgendt\": \"<string>\",\n  \"Hist\": \"<string>\",\n  \"NivelPrefPAG\": \"<string>\",\n  \"TpCtCredtd\": \"<string>\",\n  \"VlrCBS\": \"<string>\",\n  \"VlrIBS\": \"<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_CPFDestinatario: '<string>',
    CNPJ_CPFRemet: '<string>',
    DtMovto: '<string>',
    FinlddCli: '<string>',
    ISPBIFCredtd: '<string>',
    NomDestinatario: '<string>',
    NomRemet: '<string>',
    TpPessoaDestinatario: '<string>',
    TpPessoaRemet: '<string>',
    VlrLanc: '<string>',
    AgCredtd: '<string>',
    CodDocFis: '<string>',
    CtCredtd: '<string>',
    CtPgtoCredtd: '<string>',
    DtAgendt: '<string>',
    Hist: '<string>',
    NivelPrefPAG: '<string>',
    TpCtCredtd: '<string>',
    VlrCBS: '<string>',
    VlrIBS: '<string>'
  })
};

fetch('https://api.example.com/api/v1/siloc/outbound/non-account-holder-transfers', 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/non-account-holder-transfers"

payload = {
    "AgDebtd": "<string>",
    "CNPJ_CPFDestinatario": "<string>",
    "CNPJ_CPFRemet": "<string>",
    "DtMovto": "<string>",
    "FinlddCli": "<string>",
    "ISPBIFCredtd": "<string>",
    "NomDestinatario": "<string>",
    "NomRemet": "<string>",
    "TpPessoaDestinatario": "<string>",
    "TpPessoaRemet": "<string>",
    "VlrLanc": "<string>",
    "AgCredtd": "<string>",
    "CodDocFis": "<string>",
    "CtCredtd": "<string>",
    "CtPgtoCredtd": "<string>",
    "DtAgendt": "<string>",
    "Hist": "<string>",
    "NivelPrefPAG": "<string>",
    "TpCtCredtd": "<string>",
    "VlrCBS": "<string>",
    "VlrIBS": "<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_CPFDestinatario": "<string>",
    "CNPJ_CPFRemet": "<string>",
    "DtMovto": "<string>",
    "FinlddCli": "<string>",
    "ISPBIFCredtd": "<string>",
    "NomDestinatario": "<string>",
    "NomRemet": "<string>",
    "TpPessoaDestinatario": "<string>",
    "TpPessoaRemet": "<string>",
    "VlrLanc": "<string>",
    "AgCredtd": "<string>",
    "CodDocFis": "<string>",
    "CtCredtd": "<string>",
    "CtPgtoCredtd": "<string>",
    "DtAgendt": "<string>",
    "Hist": "<string>",
    "NivelPrefPAG": "<string>",
    "TpCtCredtd": "<string>",
    "VlrCBS": "<string>",
    "VlrIBS": "<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"
  }
}

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

AgDebtd

string

obrigatório

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

CNPJ_CPFDestinatario

string

obrigatório

CNPJ ou CPF Destinatário (CNPJ_CPF, [1..1]).

CNPJ_CPFRemet

string

obrigatório

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

DtMovto

string

obrigatório

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

FinlddCli

string

obrigatório

Finalidade Cliente (FinlddCli, [1..1]).

ISPBIFCredtd

string

obrigatório

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

NomDestinatario

string

obrigatório

Nome Destinatário (Nome, [1..1]).

NomRemet

string

obrigatório

Nome Remetente (Nome, [1..1]).

TpPessoaDestinatario

string

obrigatório

Tipo Pessoa Destinatário (TpPessoa, [1..1]).

TpPessoaRemet

string

obrigatório

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

VlrLanc

string

obrigatório

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

AgCredtd

string

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

CodDocFis

string

Código Documento Fiscal (CodDocFis, [0..1]). Required when the Grupo_PAG0107_Split group is supplied; omit the whole group otherwise.

CtCredtd

string

Conta Creditada (CtBancaria, [0..1]). At most one of CtCredtd or CtPgtoCredtd.

CtPgtoCredtd

string

Conta Pagamento Creditada (CtPgto, [0..1]). At most one of CtCredtd or CtPgtoCredtd.

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

TpCtCredtd

string

Tipo Conta Creditada (TpCt, [0..1]).

VlrCBS

string

Valor CBS (VlrNNegtv, [0..1]). Required when the Grupo_PAG0107_Split group is supplied; omit the whole group otherwise.

VlrIBS

string

Valor IBS (VlrNNegtv, [0..1]). Required when the Grupo_PAG0107_Split group is supplied; omit the whole group otherwise.

Resposta

Accepted

attempts

integer<int64>

obrigatório

Queue-put attempts made so far.

codMsg

string

obrigatório

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

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

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

Transfer funds on behalf of a non-account holder

Autorizações

Cabeçalhos

Corpo

Resposta