1. Private 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. Private API

Inclusão de reports

POST
/report-api/v1/private/report/
Inclusão de reportes na plataforma. Ao enviar um lote de reportes, a plataforma vai fazer o processo de validação de cada reporte de maneira síncrona e devolver o resultado dessa validação na resposta. O status HTTP de retorno será 200 caso todos dos reportes enviados forem aceitos. Caso pelo menos 1 reporte esteja inconsistente, o status de retorno será 207 - veja documentação de cada status de retorno para mais informações.
Os dados inseridos na API de Reporte são sempre processados de maneira assíncrona, e sua persistência se utiliza de consistência posterior (eventual consistency), portanto, um registro tem um tempo de processamento em que ele não estará disponível para consulta até que ele seja persistido.
O limite de reportes de cada envio de lote é de 5.000 entradas no array.

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/private/report/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "timestamp": "2021-11-11T18:08:08.894Z",
        "fapiInteractionId": "d78fc4e5-37ca-4da3-adf2-9b082bf92280",
        "clientSSId": "f0b5419b-2b5f-4f59-9862-6d2a8e23be26",
        "clientOrgId": "082ff90b-9d65-46bb-b123-b88eb47fd61c",
        "serverOrgId": "b8e34d5a-2ed5-451e-8ddb-45a1edc76243",
        "endpoint": "/open-banking/products-services/v1/business-financings",
        "statusCode": 200,
        "httpMethod": "GET",
        "correlationId": "wNupARo7I9E2PLJZph18a0M9y7DcUe7ITt3DqUOJd9NVjnskxf",
        "processTimespan": 120,
        "endpointUriPrefix": "https://ofin.bank.com/",
        "role": "CLIENT",
        "additionalInfo": {
            "personType": "PF",
            "consentId": "uri:bank:d1541b17-3175-477d-a52b-2813ae2c4c36"
        }
    },
    {
        "timestamp": "2021-11-11T19:22:10.334Z",
        "fapiInteractionId": "0786fce3-a36f-43f8-b66a-d26ab1dfc639",
        "clientSSId": "f0b5419b-2b5f-4f59-9862-6d2a8e23be26",
        "clientOrgId": "082ff90b-9d65-46bb-b123-b88eb47fd61c",
        "serverOrgId": "b8e34d5a-2ed5-451e-8ddb-45a1edc76243",
        "endpoint": "/open-banking/products-services/v1/business-financings",
        "statusCode": 200,
        "httpMethod": "GET",
        "correlationId": "8qPzRL4nBzesCc3H1827UlqqEuTT4F5lN82DuJllcnL5VnnY5j",
        "processTimespan": 117,
        "endpointUriPrefix": "https://ofin.bank.com/",
        "role": "CLIENT",
        "additionalInfo": {
            "personType": "PF",
            "consentId": "uri:bank:d1541b17-3175-477d-a52b-2813ae2c4c36"
        }
    },
    {
        "timestamp": "2021-11-11T19:41:41.811Z",
        "fapiInteractionId": "d1541b17-3175-477d-a52b-2813ae2c4c36",
        "clientOrgId": "082ff90b-9d65-46bb-b123-b88eb47fd61c",
        "serverOrgId": "b8e34d5a-2ed5-451e-8ddb-45a1edc76243",
        "endpoint": "/open-banking/products-services/v1/business-financings",
        "statusCode": 200,
        "httpMethod": "GET",
        "processTimespan": 125,
        "role": "SERVER"
    }
]'
Response Response Example
200 - Sucesso
{
    "reportId": "424ad55c-36cc-4077-b85e-c22ea984cc4a",
    "correlationId": "wNupARo7I9E2PLJZph18a0M9y7DcUe7ITt3DqUOJd9NVjnskxf",
    "status": "ACCEPTED"
}
Modified at 2025-10-07 20:03:52
Next
Consulta um report em específico usando um identificador
Built with