1. Credit Portability API
PCM-OpenApi
  • Private API
    • Inclusão de reports
      POST
    • Consulta um report em específico usando um identificador
      GET
  • Hybrid Flow API
    • Inclusão de report Hybrid Flow de redirecionamento para o servidor (papel client)
      POST
    • Inclusão de report Hybrid Flow de redirecionamento para o destino (papel server)
      POST
    • Inclusão de report Hybrid Flow de autenticação (papel server)
      POST
    • Inclusão de report Hybrid Flow de redirecionamento para o cliente (papel server)
      POST
    • Inclusão de report Hybrid Flow de redirecionamento com erro para o destino (papel client)
      POST
    • Inclusão de report Hybrid Flow de redirecionamento sem erro para o destino (papel client)
      POST
  • Opendata API
    • Inclusão de reports
      POST
  • Consents API
    • Inclusão de report de consent stock
      POST
  • Credit Portability API
    • Inclusão de reports de credit portability para client
      POST
    • Inclusão de reports de credit portability para server
      POST
    • Consulta de um report de credit portability
      GET
  • Security API
    • Geração de novo Token de autênticação
      POST
    • Obtenção de Token de autênticação ativo
      POST
  • Payment Status API
    • Inclusão de reports de payment status
      POST
    • Consulta de um report específico usando identificador
      GET
  • Schemas
    • Opendata
      • OpendataReportRequest
      • OpendataReportModel
    • Private
      • ClientReportRequest
      • ServerReportRequest
      • ReportResponse
      • ReportModel
    • Consents
      • ConsentsStockRequest
      • ConsentStockResponse
    • CreditPortability
      • CreditPortabilityClientRequest
      • CreditPortabilityServerRequest
      • CreditPortabilityModel
    • HybridFlow
      • HybridFlowClientRedirectToServerReportRequest
      • HybridFlowServerRedirectTargetReportRequest
      • HybridFlowServerAuthenticatedRequest
      • HybridFlowServerRedirectTargetWithoutErrorsRequest
      • HybridFlowServerRedirectTargetWithErrorsRequest
      • HybridFlowServerRedirectToClientRequest
      • HybridFlowReportResponse
    • Commons
      • GenericError
    • Security
      • SecurityResponse
    • PaymentStatus
      • PaymentStatusRequest
      • PaymentStatusGetResponse
      • PaymentStatusResponse
  1. Credit Portability API

Inclusão de reports de credit portability para client

POST
/report-api/v1/credit-portabilities/client
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 Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/report-api/v1/credit-portabilities/client' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "timestamp": "2021-11-11T18:08:08.278Z",
        "fapiInteractionId": "d78fc4e5-37ca-4da3-adf2-9b082bf92280",
        "clientSSId": "ca0d518b-0e95-42d4-9fc8-0598ff9023af",
        "clientOrgId": "e6e7c657-4d6d-46d9-a78b-76cc02495cf5",
        "serverOrgId": "c3779651-c918-48b1-b1fb-e36ba76cb036",
        "endpoint": "/credit-operations/{contractId}/portability-eligibility",
        "statusCode": 200,
        "httpMethod": "POST",
        "correlationId": "uGQHwNupARo7I9E2PLJZph18a0M9y7DcUe7ITt3DqUOJd9NVjnskxf2",
        "processTimespan": 120,
        "endpointUriPrefix": "https://openbanking.instituicao-1.com.br/opbk",
        "role": "CLIENT",
        "portabilityId": "54d5348c-1a3f-4ff4-a8a8-d0724fb806c6",
        "creationDateTime": "2020-07-21T08:30:00Z",
        "productSubTypeCategory": "CREDITO_PESSOAL_CLEAN",
        "originalContractCET": "0.290000",
        "originalPropositionCET": "0.290000",
        "originalContractTerm": 57,
        "propositionTerm": 30,
        "creditPortabilityStatus": "PENDING",
        "statusUpdateDateTime": "2020-07-21T08:30:00Z",
        "rejectionReason": "CANCELADO_PELO_CLIENTE",
        "rejectedBy": "PROPONENTE"
    },
    {
        "timestamp": "2021-11-11T18:08:08.278Z",
        "fapiInteractionId": "d78fc4e5-37ca-4da3-adf2-9b082bf92280",
        "clientSSId": "ca0d518b-0e95-42d4-9fc8-0598ff9023af",
        "clientOrgId": "e6e7c657-4d6d-46d9-a78b-76cc02495cf5",
        "serverOrgId": "c3779651-c918-48b1-b1fb-e36ba76cb036",
        "endpoint": "/credit-operations/{contractId}/portability-eligibility",
        "statusCode": 200,
        "httpMethod": "POST",
        "correlationId": "uGQHwNupARo7I9E2PLJZph18a0M9y7DcUe7ITt3DqUOJd9NVjnskxf2",
        "processTimespan": 120,
        "endpointUriPrefix": "https://openbanking.instituicao-1.com.br/opbk",
        "role": "CLIENT",
        "portabilityId": "54d5348c-1a3f-4ff4-a8a8-d0724fb806c6",
        "creationDateTime": "2020-07-21T08:30:00Z",
        "productSubTypeCategory": "CREDITO_PESSOAL_CLEAN",
        "originalContractCET": "0.290000",
        "originalPropositionCET": "0.290000",
        "originalContractTerm": 57,
        "propositionTerm": 30,
        "creditPortabilityStatus": "PENDING",
        "statusUpdateDateTime": "2020-07-21T08:30:00Z",
        "rejectionReason": "CANCELADO_PELO_CLIENTE",
        "rejectedBy": "PROPONENTE"
    },
    {
        "timestamp": "2021-11-11T18:08:08.278Z",
        "fapiInteractionId": "d78fc4e5-37ca-4da3-adf2-9b082bf92280",
        "clientSSId": "ca0d518b-0e95-42d4-9fc8-0598ff9023af",
        "clientOrgId": "e6e7c657-4d6d-46d9-a78b-76cc02495cf5",
        "serverOrgId": "c3779651-c918-48b1-b1fb-e36ba76cb036",
        "endpoint": "/credit-operations/{contractId}/portability-eligibility",
        "statusCode": 200,
        "httpMethod": "POST",
        "correlationId": "uGQHwNupARo7I9E2PLJZph18a0M9y7DcUe7ITt3DqUOJd9NVjnskxf2",
        "processTimespan": 120,
        "endpointUriPrefix": "https://openbanking.instituicao-1.com.br/opbk",
        "role": "CLIENT",
        "portabilityId": "54d5348c-1a3f-4ff4-a8a8-d0724fb806c6",
        "creationDateTime": "2020-07-21T08:30:00Z",
        "productSubTypeCategory": "CREDITO_PESSOAL_CLEAN",
        "originalContractCET": "0.290000",
        "originalPropositionCET": "0.290000",
        "originalContractTerm": 57,
        "propositionTerm": 30,
        "creditPortabilityStatus": "PENDING",
        "statusUpdateDateTime": "2020-07-21T08:30:00Z",
        "rejectionReason": "CANCELADO_PELO_CLIENTE",
        "rejectedBy": "PROPONENTE"
    },
    {
        "timestamp": "2021-11-11T18:08:08.278Z",
        "fapiInteractionId": "d78fc4e5-37ca-4da3-adf2-9b082bf92280",
        "clientSSId": "ca0d518b-0e95-42d4-9fc8-0598ff9023af",
        "clientOrgId": "e6e7c657-4d6d-46d9-a78b-76cc02495cf5",
        "serverOrgId": "c3779651-c918-48b1-b1fb-e36ba76cb036",
        "endpoint": "/credit-operations/{contractId}/portability-eligibility",
        "statusCode": 200,
        "httpMethod": "POST",
        "correlationId": "uGQHwNupARo7I9E2PLJZph18a0M9y7DcUe7ITt3DqUOJd9NVjnskxf2",
        "processTimespan": 120,
        "endpointUriPrefix": "https://openbanking.instituicao-1.com.br/opbk",
        "role": "CLIENT",
        "portabilityId": "54d5348c-1a3f-4ff4-a8a8-d0724fb806c6",
        "creationDateTime": "2020-07-21T08:30:00Z",
        "productSubTypeCategory": "CREDITO_PESSOAL_CLEAN",
        "originalContractCET": "0.290000",
        "originalPropositionCET": "0.290000",
        "originalContractTerm": 57,
        "propositionTerm": 30,
        "creditPortabilityStatus": "PENDING",
        "statusUpdateDateTime": "2020-07-21T08:30:00Z",
        "rejectionReason": "CANCELADO_PELO_CLIENTE",
        "rejectedBy": "PROPONENTE"
    }
]'
Response Response Example
200 - Todos processados
[
    {
        "reportId": "424ad55c-36cc-4077-b85e-c22ea984cc4a",
        "correlationId": "424ad55c-36cc-4077-b85e-c22ea984cc4a",
        "status": "ACCEPTED"
    },
    {
        "reportId": "424ad55c-36cc-4077-b85e-c22ea984cc4a",
        "correlationId": "424ad55c-36cc-4077-b85e-c22ea984cc4a",
        "status": "ACCEPTED"
    },
    {
        "reportId": "424ad55c-36cc-4077-b85e-c22ea984cc4a",
        "correlationId": "424ad55c-36cc-4077-b85e-c22ea984cc4a",
        "status": "ACCEPTED"
    }
]
Modified at 2025-11-19 22:22:19
Previous
Inclusão de report de consent stock
Next
Inclusão de reports de credit portability para server
Built with