CEcelcoin
Sessões de Jornada JSR (Jornada sem Redirecionamento)

Atualiza a sessão de jornada de vínculo.

Método para atualizar a sessão de jornada de vínculo. Nesse momento é possível atualizar apenas o status, sendo utilizado para o cancelamento da sessão.

patch/open-keys/itp/api/v2/enrollments/v2/journeys-sessions/{id}

Request

  • Base URL
    http://localhost:3000
  • URL
    http://localhost:3000/open-keys/itp/api/v2/enrollments/v2/journeys-sessions/{id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://keycloak.sandbox.shared.fsapps.io/auth/realms/openkeys-itp-v2-sandbox-dev/protocol/openid-connect/token scopes: app, journey

Path parameters

idstring required
Example:f362a873-c127-4122-b711-a37b24a36914

O id é o identificador único da jornada

Request body

status'CANCELLED' required

Status da sessão da jornada.

Example request

{
  "status": "CANCELLED"
}

Response

Return in case of successful update.

idstring required

O id é o identificador único da jornada

createdAtstring required
updatedAtstring required
deletedAtstring required
journeyIdstring required

O id é o identificador único da jornada

redirectUrlstring uri

O endereço de redirecionamento para a jornada, após o fluxo da jornada. Precisa ser um dos cadastrados na aplicação.

brandIdstring

O id é o identificador único da brand

externalIdstring

O id é o identificador único da jornada

expirationDateTimestring
        Data e hora em que a jornada deve deixar de ser válido. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).
tagsstring

Tags que podem ser usadas para classificar a sessão da jornada.

webhookHeadersstring

Headers que podem ser usadas para classificar a sessão da jornada.

applicationClientIdstring required

O clientId da aplicação.

applicationIdstring required

O ID da aplicação. É um número exclusivo que identifica a aplicação.

tokenIdstring required

O ID do token. É um número exclusivo que identifica o token.

journeySessionUrlstring uri required

A url da sessão da jornada que deve ser aberta para o usuário.

status'PENDING' | 'CANCELLED' | 'EXPIRED' | 'AWAITING_AUTHORISATION' | 'AWAITING_AUTHORISATION_ACTION' | 'AUTHORISED' | 'CONSUMED' | 'REJECTED' | 'FINISHED' required

Status da sessão da jornada.

journeySessionStageIdstring

O id é o identificador único do estágio da sessão da jornada

paymentInitiationIdstring

O id é o identificador único do ITP

paymentInitiationApi'ENROLLMENTS_V2' required
paymentInitiationEnrollmentsV2JourneySessionPaymentInitiation

Example response

{
  "id": "f362a873-c127-4122-b711-a37b24a36914",
  "createdAt": "2024-01-01T20:32:44.581Z",
  "updatedAt": "2024-01-01T20:32:44.581Z",
  "deletedAt": "2024-01-01T20:32:44.581Z",
  "redirectUrl": "http://localhost:8080/callback",
  "externalId": "8cbe7dfb-40d6-4a42-9e8b-d9df88ca55f5",
  "expirationDateTime": "2021-05-21T08:30:00Z",
  "settings": [
    {
      "key": "PRIORITIES_BRANDS"
    }
  ],
  "applicationClientId": "f362a873-c127-4122-b711-a37b24a36914",
  "applicationId": "f362a873-c127-4122-b711-a37b24a36914",
  "tokenId": "f362a873-c127-4122-b711-a37b24a36914",
  "token": {
    "id": "f362a873-c127-4122-b711-a37b24a36914",
    "createdAt": "2024-01-01T20:32:44.581Z",
    "updatedAt": "2024-01-01T20:32:44.581Z",
    "deletedAt": "2024-01-01T20:32:44.581Z",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI2NWYyMjQ2MWY2ZTAxZDg5N2NkMTQ2Y2UiLCJpc3MiOiJvcGVuLWtleXMtaXRwLXYyIiwiYXpwIjoib3BlbmtleXNfNGE4M2ZkOTEtMWQ2Zi00ZTg2LTg0NDUtYWU1NWNkYjg4YjNkIiwic2NvcGUiOiJqb3VybmV5IiwiaWF0IjoxNzEwMzY3ODQxLCJleHAiOjIwNzA0Mjc4NDF9.VMobGtPbjCzwdL8HN2_26l-b4wg3Ci0P_K-TRpshiPY"
  },
  "journeySessionUrl": "http://localhost:9000?journeyId={journeyId}&id={id}&token={token}",
  "status": "PENDING",
  "statusHistory": [
    {
      "updatedAt": "2024-01-01T20:32:44.581Z",
      "status": "PENDING"
    }
  ],
  "journeySessionStageId": "f362a873-c127-4122-b711-a37b24a36914",
  "journeySessionStage": {
    "id": "f362a873-c127-4122-b711-a37b24a36914",
    "logs": [
      {
        "createdAt": "2024-01-01T20:32:44.581Z"
      }
    ]
  },
  "paymentInitiationId": "f362a873-c127-4122-b711-a37b24a36914",
  "paymentInitiationApi": "ENROLLMENTS_V2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.