Skip to main content
POST
Receive and parse a remittance file

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
fileType
string
required

The SISBAJUD file-type code.

Example:

"REMESSA"

institutionCode
string
required

The institution's BACEN CNPJ code (8 digits) used for file header validation.

Example:

"12345678"

institutionId
string
required

The institution id the file belongs to.

Example:

"44444444-4444-4444-4444-444444444444"

objectKey
string
required

The object key of the file already present in the shared inbound bucket.

Example:

"inbound/2026/07/14/remessa-001.txt"

Response

OK

status
string
required

The reception outcome (processed or skipped).

Example:

"processed"

environment
string

The resolved SISBAJUD environment (processed outcomes only).

Example:

"production"

fileId
string

The persisted file id (processed outcomes only).

Example:

"dddddddd-dddd-dddd-dddd-dddddddddddd"

reason
string

The skip reason (skipped outcomes only).

Example:

"skipped"