BCTT Partners Portal API - Developer Portal
  • Documentation
  • API Reference
Authentication
    Authenticatepost
Partners
    Callback UpdateputCallback DeletedeleteCallback ListgetCallback Echopost
Processes
    Process DetailgetProcess UpdateputProcess ListgetProcess CreatepostProcess SubmitpostProcess Canceldelete
ProcessesBorrower
    Borrower GetgetBorrower UpdateputBorrower DeletedeleteBorrower ListgetBorrower Createpost
ProcessesDocument
    Document GetgetDocument UpdateputDocument DeletedeleteDocument ListgetDocument Createpost
ProcessesESIS
    Process ESIS GetgetProcess ESIS Emailget
ProcessesMessage
    Processes Message ListgetProcesses Message Createpost
ProcessesProperty
    Property ListgetProperty Updateput
Simulations
    Simulation ListgetSimulation CreatepostSimulation DetailgetSimulation CanceldeleteSimulation UpdatepatchSimulation Validatepost
SimulationsESIS
    Simulation ESIS GetgetSimulation ESIS Emailget
SimulationsMessages
    Simulations Message ListgetSimulations Message Createpost
Taxonomy
    Broker Types GetgetBroker Sub Types GetgetBroker Classifications GetgetBroker Fee Types GetgetBroker Statuses GetgetBroker IVA Regimes GetgetBroker Retention Regimes GetgetBroker Extract Periodicity GetgetCountries GetgetCountry With Districts GetgetDistricts GetgetDistricts With Counties GetgetCounties GetgetCounty With Parishes GetgetParishes GetgetDocument Types GetgetDocument Categories GetgetProduct Purposes GetgetLoan Purposes GetgetProduct Schemes GetgetIndex Type Sub Categories GetgetIndex Types GetgetIndex Type List Mixed GetgetFixed Fixed Period GetgetMixed Fixed Period GetgetBank Charge Types GetgetProperty Typologies GetgetEntity Types GetgetIdentification Documents GetgetMarital Statuses GetgetMatrimonial Regimes GetgetResidence Types GetgetGenders GetgetProfessions GetgetEmployment Contract Types GetgetEmployment Situations GetgetEmployment Department Positions GetgetKey Borrower Relations GetgetProposal Cancel Reasons GetgetProposal Reject Reasons GetgetSimulation Reject Reasons GetgetWorkflow Phases GetgetWorkflow States Simulation GetgetWorkflow States Proposal GetgetRetrieves a paginated list of notification typesget
Schemas
Partners Portal API
Partners Portal API

ProcessesMessage

Endpointhttps://api-qua-portalparceiros.bancoctt.pt

Processes Message List

GET
https://api-qua-portalparceiros.bancoctt.pt
/v1/processes/{processUniqueId}/message

Retrieves all messages associated with a process. This endpoint returns all messages linked to the specified mortgage process. It validates that the process exists and belongs to the current broker before retrieving message data.

Processes Message List › path Parameters

processUniqueId
string · uuid · required

Unique identifier of the mortgage process.

Processes Message List › query Parameters

pageNumber
integer · int32

Page number for pagination (default is 1).

Default: 1
pageSize
integer · int32

Number of items per page for pagination (default is 20).

Default: 20

Processes Message List › Headers

Authorization
string · required

Bearer token for authentication. Format: Bearer {token}

Processes Message List › Responses

The list of messages was successfully retrieved.

object[]
totalCount
integer · int32

Total number of messages associated with the process

count
integer · int32

Number of messages in the current response

GET/v1/processes/{processUniqueId}/message
curl --request GET \
  --url https://api-qua-portalparceiros.bancoctt.pt/v1/processes/:processUniqueId/message \
  --header 'Authorization: <string>'
shell
Example Responses
{
  "messages": [
    {
      "username": "[email protected]",
      "subject": "Simulation status inquiry",
      "text": "Please review the attached documents and update the process status.",
      "creationDate": "2026-01-01T00:00:00Z"
    }
  ],
  "totalCount": "50",
  "count": "10"
}
json
application/json

Processes Message Create

POST
https://api-qua-portalparceiros.bancoctt.pt
/v1/processes/{processUniqueId}/message

Creates a new message associated with a process. This endpoint creates a new message for the specified mortgage process. The request payload is validated against the process and broker context before being persisted. The message is attributed to the authenticated user and stored for future retrieval.

Processes Message Create › path Parameters

processUniqueId
string · uuid · required

Unique identifier of the mortgage process.

Processes Message Create › Headers

Authorization
string · required

Bearer token for authentication. Format: Bearer {token}

Processes Message Create › Request Body

subject
string

Subject of the message

text
string

Body text of the message

Processes Message Create › Responses

The message was successfully created.

object
POST/v1/processes/{processUniqueId}/message
curl --request POST \
  --url https://api-qua-portalparceiros.bancoctt.pt/v1/processes/:processUniqueId/message \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subject": "Status inquiry",
  "text": "Please review the attached documents and update the status."
}
'
shell
Example Request Body
{
  "subject": "Status inquiry",
  "text": "Please review the attached documents and update the status."
}
json
Example Responses
{
  "operationStatus": {
    "operationStatusCode": "020101",
    "operationStatusMessage": "Process Updated successfully"
  }
}
json
application/json

ProcessesESISProcessesProperty