Enrollments V2 - List Journey Session API

Visão Geral

Esta API permite a listagem de sessões de jornada de enrollments.

Endpoint

GET /open-keys/itp/api/v2/enrollments/v2/journeys-sessions

Autenticação

A API requer autenticação OAuth2 com a seguinte permissão:

app: Para integrações diretas via API

O token de acesso deve ser enviado no header:

Authorization: Bearer {access_token}

Estrutura da Requisição

Parâmetros que podem ser enviados

{
  "query[cpf]": "12345678909",
  "query[status]": "AUTHORISED",
  "initialDate": "2025-12-01",
  "finalDate": "2025-12-30",
  "pageSize": 10,
  "page": 1
}

Campos da Requisição

Nível Raiz

Campo	Tipo	Obrigatório	Descrição
`query[cpf]`	String	Não	CPF para filtrar as sessões
`query[status]`	String	Não	Status para filtrar as sessões
`initialDate`	String	Não	Data inicial para filtrar
`finalDate`	String	Não	Data final para filtrar
`pageSize`	Number	Não	Quantidade de itens por página
`page`	Number	Não	Página atual da listagem

Exemplo de Requisição (cURL)

curl --location 'https://api.exemplo.com/open-keys/itp/api/v2/enrollments/v2/journeys-sessions?query%5Bcpf%5D=12345678909&query%5Bstatus%5D=AUTHORISED&initialDate=2025-12-01&finalDate=2025-12-30&pageSize=10&page=1' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Resposta da API

Sucesso (200 OK)

A API retorna um objeto contendo:

{
    "data": [
        {
            "journeyId": "{journeyId}",
            "paymentInitiationData": {},
            "paymentInitiationApi": "ENROLLMENTS_V2",
            "tokenId": "{tokenId}",
            "journeySessionStageId": "{journeySessionStageId}",
            "journeySessionUrl": "{url}",
            "status": "PENDING",
            "id": "{id}",
            "paymentInitiation": {},
            "..."
        }
    ],
    "meta": {
        "total": 242,
        "page": 1,
        "pageSize": 10,
        "totalPages": 25
    }
}

Erros Comuns

401 Unauthorized

{
    "error": "Unauthorized",
    "message": "Token inválido ou expirado"
}

Solução: Verifique se o token de acesso é válido e possui a permissão necessária (app).