Get Acquisition CNAB
Returns the subscription's acquisition CNAB, in the 444-character fixed-width layout, Base64 encoded.
The file is generated at request time, from the operation's current data. It is not stored, so two requests made on different days return different file names and recording dates. Use this endpoint to resend the file to its destination, not as a record of what was sent previously.
Get Acquisition CNAB (GET)
Request
ENDPOINT
/integralization/integralization_process/INTEGRALIZATION-KEY/subscription/SUBSCRIPTION-KEY/acquisition_cnabMETHOD
GETPath Params
| Field | Type | Description | Characters |
|---|---|---|---|
INTEGRALIZATION-KEY | string | Unique integralization process key (UUID v4). | 36 |
SUBSCRIPTION-KEY | string | Unique subscription key (UUID v4). | 36 |
Response
STATUS
200Response Body
{
"file_name": "CBNC210900.REM",
"document_base64": "MDFSRU1FU1NBMDFDT0JSQU5DQSAgICAgICAwMDAwMDAwMDAwMDAwMDAxMjM1NEZVTkRPIEhN..."
}
Response Body Params
| Field | Type | Description |
|---|---|---|
file_name | string | File name, in the CBNC<DDMM>00.REM format. Day and month are the generation date. |
document_base64 | string | File content, Base64 encoded. |
note
Decoding the Base64 yields a text file, not a PDF: one 444-character line per record, with a header, one detail line per installment, and a trailer.
Errors
| HTTP | Code | When |
|---|---|---|
| 400 | INT000005 (SubscriptionNotLinked) | The subscription does not belong to the given integralization process. |
| 403 | INT000003 (IntegralizationNotBelongToTenant) | The integralization process does not belong to the requesting client. |
| 404 | INT000004 (SubscriptionNotFound) | Subscription not found. |
| 422 | INT000036 (FinancialIndexNotSupported) | The operation's index is not supported for CNAB generation. |
| 422 | INT000043 (AcquisitionCnabNumeroDocumentoDoesNotFit) | The contract number does not fit in the document number field. |
| 422 | INT000044 (TenantInvestorNameMissing) | The subscription's investor has no registered name. |