Read a transfer

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

package main

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

func main() {

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

{
  "bytesDownloaded": 123,
  "bytesUploaded": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "credentialId": "<string>",
  "currentState": "<string>",
  "currentStateCode": 123,
  "direction": "<string>",
  "documentType": "<string>",
  "expired": true,
  "fileName": "<string>",
  "fileSizeBytes": 123,
  "hashMismatchAttempts": 123,
  "id": "<string>",
  "secondsRemaining": 123,
  "transmissionAttempts": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "uploadAttempts": 123,
  "documentCode": "<string>",
  "errorCode": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "fileRef": "<string>",
  "lastTransitError": "<string>",
  "originProtocolNumber": "<string>",
  "protocolGeneratedAt": "2023-11-07T05:31:56Z",
  "protocolNumber": "<string>",
  "sourceProduct": "<string>",
  "urgentRequestedAt": "2023-11-07T05:31:56Z"
}

{
  "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

transfers

{id}

Read a transfer

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

package main

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

func main() {

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

{
  "bytesDownloaded": 123,
  "bytesUploaded": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "credentialId": "<string>",
  "currentState": "<string>",
  "currentStateCode": 123,
  "direction": "<string>",
  "documentType": "<string>",
  "expired": true,
  "fileName": "<string>",
  "fileSizeBytes": 123,
  "hashMismatchAttempts": 123,
  "id": "<string>",
  "secondsRemaining": 123,
  "transmissionAttempts": 123,
  "updatedAt": "2023-11-07T05:31:56Z",
  "uploadAttempts": 123,
  "documentCode": "<string>",
  "errorCode": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "fileRef": "<string>",
  "lastTransitError": "<string>",
  "originProtocolNumber": "<string>",
  "protocolGeneratedAt": "2023-11-07T05:31:56Z",
  "protocolNumber": "<string>",
  "sourceProduct": "<string>",
  "urgentRequestedAt": "2023-11-07T05:31:56Z"
}

{
  "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"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

string

requerido

Transfer UUID

Ejemplo:

"018f3b2a-0c1d-7a2b-9e4f-1a2b3c4d5e6f"

Respuesta

bytesDownloaded

integer<int64>

requerido

bytesUploaded

integer<int64>

requerido

createdAt

string<date-time>

requerido

credentialId

string

requerido

currentState

string

requerido

currentStateCode

integer<int64>

requerido

direction

string

requerido

documentType

string

requerido

Document type in the MNEMONIC vocabulary (ACCS002) whenever it is known. Outbound: always the mnemonic the caller supplied, unchanged. Inbound: the mnemonic BACEN sent in , published only when the de-para table agrees it names the code that arrived with it. ⚠️ Inbound transfers created before this field was recorded — and BACEN's legacy query envelopes, which omit the element — have no mnemonic stored and are NOT backfilled: those rows answer with the numeric code here, the same value they have always returned. Compare against documentCode to tell the two vocabularies apart.

expired

boolean

requerido

fileName

string

requerido

fileSizeBytes

integer<int64>

requerido

hashMismatchAttempts

integer<int64> | null

requerido

Inbound only: count of downloads whose SHA-256 did not match BACEN's, driving the Inconsistent terminal. null for outbound transfers.

string

requerido

secondsRemaining

integer<int64>

requerido

transmissionAttempts

integer<int64> | null

requerido

Inbound only: count of non-hash download failures, driving the Canceled / DOWNLOAD_FAILED terminal. null for outbound transfers.

updatedAt

string<date-time>

requerido

uploadAttempts

integer<int64> | null

requerido

Count of FAILED outbound transmission attempts, and the value the retry budget consumes: the worker stops retrying once it reaches 5. It counts failures, not attempts, so a transfer that succeeded on the first try reports 0. null for inbound transfers, which have no upload leg.

documentCode

string

BACEN identifier for the same document (6002). Its provenance differs by direction: on an inbound transfer it is OBSERVED — the BACEN delivered — while on an outbound transfer it is DERIVED from the CURRENT de-para table at read time — it is what that table resolves the mnemonic to today, NOT a persisted record of the identifier that went on the wire. The two coincide while the table is unchanged; if an entry is ever corrected, this field answers the new value for an old transfer. The identifier actually sent is recorded in the log line and, on a BACEN rejection, in the terminal reason. Treat it as an opaque token, not a number: some documents resolve to a non-numeric identifier (ARQTEST resolves to TEST). Omitted entirely when neither source resolves it, which is a valid state for an outbound document type absent from the table — an empty string is never published, because it would be indistinguishable from a genuinely empty code.

errorCode

string

expiresAt

string<date-time>

fileRef

string

lastTransitError

string

originProtocolNumber

string

protocolGeneratedAt

string<date-time>

protocolNumber

string

sourceProduct

string

urgentRequestedAt

string<date-time>

Credenciales

Configuraciones de fuentes entrantes

Transferencias

Auditoría

Manejo de errores

Read a transfer

Autorizaciones

Parámetros de ruta

Respuesta