Inclusão de reports de credit portability para server

POST

/report-api/v1/credit-portabilities/server

A API de Portabilidade de Crédito fornece operações que permitem a inclusão de reportes relativos ao processo de solicitação de Portabilidade de Crédito entre instituições do ecossistema do Open Finance.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Responses

🟢200Correto

application/json

O status 200 representa a situação onde todos os registros enviados no lote foram validados e serão direcionados para processamento. Se pelo menos 1 registro contiver problemas de validação, o retorno será 207 (veja descrição do status).

A operação vai devolver um array com todos os resultados, e garante que ele esteja na mesma ordem do array da requisição.

Body

🟢207Multiestado

🟠400Solicitação incorreta

🟠401Não autenticado

🟠403Permissão insuficiente

🟠406Não aceitável

🟠413O corpo da solicitação é muito grande

🟠415Tipo de mídia não suportado

🟠429Solicitações demais

🔴500Erro interno do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/report-api/v1/credit-portabilities/server' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "reportId": "424ad55c-36cc-4077-b85e-c22ea984cc4a",
        "fapiInteractionId": "d78fc4e5-37ca-4da3-adf2-9b082bf92280",
        "endpoint": "/credit-operations/{contractId}/portability-eligibility",
        "httpMethod": "POST",
        "statusCode": 200,
        "timestamp": "2021-11-11T18:08:08.894Z",
        "processTimespan": 120,
        "clientOrgId": "c3779651-c918-48b1-b1fb-e36ba76cb036",
        "serverOrgId": "5ec47c83-9010-4540-91ad-b820ef0df04a",
        "role": "SERVER",
        "status": "PENDING",
        "statusUpdateDateTime": "2020-07-21T08:30:00Z",
        "rejectionReason": "CANCELED",
        "rejectedBy": "CREDORA"
    },
    {
        "reportId": "424ad55c-36cc-4077-b85e-c22ea984cc4a",
        "fapiInteractionId": "d78fc4e5-37ca-4da3-adf2-9b082bf92280",
        "endpoint": "/credit-operations/{contractId}/portability-eligibility",
        "httpMethod": "POST",
        "statusCode": 200,
        "timestamp": "2021-11-11T18:08:08.894Z",
        "processTimespan": 120,
        "clientOrgId": "c3779651-c918-48b1-b1fb-e36ba76cb036",
        "serverOrgId": "5ec47c83-9010-4540-91ad-b820ef0df04a",
        "role": "SERVER",
        "status": "PENDING",
        "statusUpdateDateTime": "2020-07-21T08:30:00Z",
        "rejectionReason": "CANCELED",
        "rejectedBy": "CREDORA"
    },
    {
        "reportId": "424ad55c-36cc-4077-b85e-c22ea984cc4a",
        "fapiInteractionId": "d78fc4e5-37ca-4da3-adf2-9b082bf92280",
        "endpoint": "/credit-operations/{contractId}/portability-eligibility",
        "httpMethod": "POST",
        "statusCode": 200,
        "timestamp": "2021-11-11T18:08:08.894Z",
        "processTimespan": 120,
        "clientOrgId": "c3779651-c918-48b1-b1fb-e36ba76cb036",
        "serverOrgId": "5ec47c83-9010-4540-91ad-b820ef0df04a",
        "role": "SERVER",
        "status": "PENDING",
        "statusUpdateDateTime": "2020-07-21T08:30:00Z",
        "rejectionReason": "CANCELED",
        "rejectedBy": "CREDORA"
    }
]'

Response Example

200 - Sucesso

{
    "reportId": "424ad55c-36cc-4077-b85e-c22ea984cc4a",
    "correlationId": "424ad55c-36cc-4077-b85e-c22ea984cc4a",
    "status": "ACCEPTED"
}

Modified at 2025-10-07 20:03:52

Inclusão de reports de credit portability para client

Consulta de um report de credit portability