1. Private
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
    • Obtenção de Token de autênticação ativo
  • Payment Status API
    • Inclusão de reports de payment status
    • Consulta de um report específico usando identificador
  • 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. Private

ClientReportRequest

Representa os dados que deverão ser enviados para a inclusão de reportes pelo lado do Client (iniciador da chamada). Informações adicionais sobre cada campo podem ser encontradas na documentação funcional em https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/37879861/Reporte#Modelos-para-reportes-Private

{
    "fapiInteractionId": "d78fc4e5-37ca-4da3-adf2-9b082bf92280",
    "endpoint": "/open-banking/consents/v2/consents",
    "statusCode": 200,
    "httpMethod": "GET",
    "correlationId": "uGQHwNupARo7I9E2PLJZph18a0M9y7DcUe7ITt3DqUOJd9NVjnskxf2",
    "timestamp": "2021-11-11T18:08:08.278Z",
    "processTimespan": 120,
    "clientSSId": "84570da9-567b-4201-9b77-c715bc5bffde",
    "clientOrgId": "56411f7e-d58b-44a8-8a2b-ff326d3f2955",
    "serverOrgId": "c1ca8e62-9d6f-4ea3-84f2-d66bc0a8f7dc",
    "endpointUriPrefix": "https://openbanking.instituicao-1.com.br/opbk",
    "role": "CLIENT",
    "additionalInfo": {
        "consentId": "string",
        "personType": "string",
        "localInstrument": "MANU",
        "status": "string",
        "clientIp": "string",
        "rejectReason": "string",
        "errorCodes": "string",
        "webhookEnable": "string",
        "webhookInteractionId": "string",
        "enrollmentId": "string",
        "authenticatorAttachment": "string",
        "platform": "string",
        "rp": "string",
        "rejectionReasonCode": "string",
        "rejectionReasonDetail": "string",
        "authorisationFlow": "string",
        "paymentType": "IMMEDIATE",
        "dropReason": "string",
        "grantType": "AUTHORIZATION_CODE",
        "cancelledFrom": "INICIADORA",
        "interval": "string",
        "amountType": "FIXO",
        "isFirstPayment": "TRUE",
        "hasMinimumAmount": "TRUE",
        "isRetryAccepted": "string",
        "recurringPaymentId": "string",
        "paymentReference": "string",
        "originalRecurringPaymentId": "string",
        "cancellationReason": "string",
        "nfcPayment": "TRUE",
        "revocationReasonCode": "string",
        "revocationReasonDetail": "string",
        "revokedBy": "INICIADORA",
        "revokedFrom": "INICIADORA",
        "rejectedBy": "NICIADORA",
        "rejectedFrom": "INICIADORA",
        "statusSummary": {
            "available": "string",
            "unavailable": "string",
            "temporarilyUnavailable": "string",
            "pendingAuthorisation": "string"
        },
        "companyProfileInfo": {
            "naturezaJurídica": "string",
            "porteEmpresa": "string"
        },
        "paymentDate": "2025-09-01",
        "paymentSchedule": "string",
        "paymentList": [
            {
                "paymentId": "4d4dec4b-5960-4041-8099-1340b8c8a4bb",
                "consentId": "4d4dec4b-5960-4041-8099-1340b8c8a4bb",
                "statusUpdateDateTime": "2025-09-01",
                "status": "ASCS",
                "rejectionReasonCode": "001",
                "rejectionReasonDetail": "Detalhes sobre a rejeição"
            }
        ],
        "recurringPaymentDate": "string",
        "referenceStartDate": "2025-09-01",
        "recurringConsentId": "string",
        "journeyIsLinked": "string",
        "journeyLinkId": "string",
        "authorisationFlowIntent": "HYBRID_FLOW",
        "tokenId": "string"
    }
}
Built with