Create outbound transfer

Creates a new outbound transfer. The worker streams the referenced object to BACEN STA asynchronously.

POST /v1/transfers

Create outbound transfer

cURL

curl --request POST \
  --url https://sta.sandbox.lerian.net/v1/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "credentialId": "<string>",
  "documentType": "<string>",
  "fileName": "<string>",
  "fileRef": "<string>",
  "sourceProduct": "<string>"
}
'

201

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

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency · string

Idempotency key. A repeat with the same key within the dedup window replays the original 201 outcome.

Body

application/json

Outbound transfer creation payload

credentialId · string · required

documentType · string · required

fileName · string · required

fileRef · string · required

sourceProduct · string · required

Response

201

application/json

Created

bytesDownloaded · integer<int64> · required

bytesUploaded · integer<int64> · required

createdAt · string<date-time> · required

credentialId · string · required

currentState · string · required

currentStateCode · integer<int64> · required

direction · string · required

documentType · string · required

downloadAttempts · integer<int64> · required

expired · boolean · required

fileName · string · required

fileSizeBytes · integer<int64> · required

hashMismatchAttempts · integer<int64> · required

id · string · required

secondsRemaining · integer<int64> · required

transmissionAttempts · integer<int64> · required

updatedAt · string<date-time> · required

uploadAttempts · integer<int64> · required

errorCode · string

expiresAt · string<date-time>

fileRef · string

lastTransitError · string

protocolGeneratedAt · string<date-time>

protocolNumber · string

sourceProduct · string

urgentRequestedAt · string<date-time>