v1

latestOpenAPI 3.1.12026-07-2371254470.9 KB
Títulos bancários

Emissão de título bancário em lote (TB001)

Registra a emissão de um título bancário com alocação ao investidor. Encaminhado ao serviço tio-external-api (tio-csd-external-api), path canónico /csd-assets/v1/tb/issue.

post/v1/api/tb/issue

Request body

externalReferencestring required

Unique event code generated by the participant's system, used for operation traceability.

assetIdstring nullable

Asset identifier generated by CERC, used for allocations after the asset has been registered. Leave blank when creating a new asset.

assetType'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' required

Type of financial asset to be issued.

  • 1 = CDB (Certificate of Bank Deposit)
  • 2 = RDB (Bank Deposit Receipt)
  • 3 = LC (Bill of Exchange)
  • 4 = LF (Financial Bill)
  • 5 = LFSC (Convertible Subordinated Financial Bill)
  • 6 = LFSN (Non-Convertible Subordinated Financial Bill)
  • 7 = LCI (Real Estate Credit Bill)
  • 8 = LCA (Agribusiness Credit Bill)
settlementAgentExternalRefstring nullable

External reference of the issuer's settlement institution in the settlement system.

  • Required when settlementType = 2 or 3
  • Must be omitted when settlementType = 1
repurchaseAllowed'1' | '2' nullable

Indicates whether the security allows repurchase by the issuer. Required for assetType = 5 or 6.

  • 1 = Repurchase allowed — repurchaseStartDate may be provided
  • 2 = Repurchase not allowed — repurchaseStartDate must be omitted
repurchaseStartDatestring date nullable

Earliest date from which the issuer may exercise the repurchase option (yyyy-MM-dd).

  • Must be between issueDate and dueDate
  • Must be omitted when repurchaseAllowed = 2
portfolioIdstring nullable

Identifier of the collateral portfolio linked to the security.

  • Required for assetType = 7 (LCI) or 8 (LCA)
  • Must be omitted for assetType other than 7 or 8
modalityType'1' | '2' | '3' nullable

Regulatory modality type of the Financial Bill. Required for assetType = 4 (LF).

  • 1 = Linked — linkedAsset is required
  • 2 = Simple — linkedAsset must be omitted
  • 3 = Subordinated — linkedAsset must be omitted
linkedAssetstring nullable

Identifier of the asset to which the Financial Bill is linked.

  • Required when modalityType = 1
  • Must be omitted when modalityType = 2 or 3
conversionClause'1' | '2' nullable

Indicates the existence of a conversion or extinction clause. Required for assetType = 5 (LFSC) or 6 (LFSN).

  • 1 = Extinguishable — maxConvertibilityLimit and convertibilityCriteria must be omitted
  • 2 = Convertible — maxConvertibilityLimit and convertibilityCriteria are required
maxConvertibilityLimitinteger nullable

Maximum number of securities eligible for conversion into shares.

  • Required when conversionClause = 2
  • Must be omitted when conversionClause = 1
convertibilityCriteriastring nullable

Description of the rules and conditions governing the conversion of securities into shares. Required when conversionClause = 2.

Response

Multi-Status

externalReferencestring required

Unique reference code generated by the participant's system, echoed from the request.

operationDatestring date-time required

Date and time of operation processing in yyyy-MM-ddThh:mm:ss.sss format.

protocolstring required

Internal tracking identifier generated by the CERC system, used for processing traceability.

assetIdstring nullable

Asset identifier generated by CERC. Populated only when the operation results in the creation of a new asset.

status'1' | '2' required

Operation processing status.

  • 1 = ACCEPTED
  • 2 = REJECTED