Payments V4 - Get Journey Session API

Visão Geral

Esta API permite obter uma sessão específica de jornada de payments.

Endpoint

GET /open-keys/itp/api/v2/payments/v4/journeys-sessions/{id}

Autenticação

A API requer autenticação OAuth2 com as seguintes permissões:

• app: Para integrações diretas via API
• journey: Para acesso a jornadas específicas

O token de acesso deve ser enviado no header:

Authorization: Bearer {access_token}

Estrutura da Requisição

Parâmetros que podem ser enviados

{
  "id": "{id}"
}

Campos da Requisição

Nível Raiz

Exemplo de Requisição (cURL)

curl --location 'https://api.exemplo.com/open-keys/itp/api/v2/payments/v4/journeys-sessions/{id}' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--header 'Content-Type: application/json'

Resposta da API

Sucesso (200 OK)

A API retorna um objeto contendo:

{
    "journeyId": "{journeyId}",
    "paymentInitiationApi": "PAYMENTS_V4",
    "applicationId": "{applicationId}",
    "tokenId": "{tokenId}",
    "journeySessionStageId": "{journeySessionStageId}",
    "journeySessionUrl": "{url}",
    "status": "PENDING",
    "id": "{id}",
    "application": {},
    "journey": {},
    "token": {},
    "..."
}

Erros Comuns

401 Unauthorized

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

Solução: Verifique se o token de acesso é válido e possui as permissões necessárias (app, journey).

404 Not Found

{
    "error": "Not Found",
    "message": "Sessão de jornada não encontrada"
}

Solução: Verifique se o ID da sessão é válido e existe.