Sign in

v1

latestOpenAPI 3.0.12026-07-245303882.5 MB
Enrollment Journey Sessions

Updates the enrollment journey session.

Method to update the enrollment journey session. At this point it is possible to update only the status, being used for the cancellation of the session.

patch/baas/v1/open/itp/enrollments/journeys-sessions/{id}

Path parameters

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

ID is the unique identifier of the journey

Request body

status'CANCELLED' required

Status da sessão da jornada.

Example request

{
  "status": "CANCELLED"
}

Response

Return in case of successful update.

idstring required

ID is the unique identifier of journey

createdAtstring required

Record creation date and time

updatedAtstring required

Record last update date and time

deletedAtstring required

Record deletion date and time (soft delete)

journeyIdstring required

ID is the unique identifier of journey

redirectUrlstring uri

The redirect address for the journey after the flow of the journey.It needs to be one of the registered in the application.

brandIdstring

ID is the unique identifier of brand

externalIdstring

ID is the unique identifier of journey

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

The application clientId.

applicationIdstring required

The application ID. It is an exclusive number that identifies the application.

tokenIdstring required

The token id.It is an exclusive number that identifies the token.

journeySessionUrlstring uri required

The URL of the Journey Session that must be opened to the user.

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

Status of the Journey Session.

journeySessionStageIdstring

ID is the unique identifier of the stage of the Journey Session

paymentInitiationIdstring

ID is the unique identifier of ITP

paymentInitiationApi'ENROLLMENTS_V2' | 'PAYMENTS_V4' required

Payment initiation API used in the journey session. ENROLLMENTS_V2 for simple enrollments, PAYMENTS_V4 for PIX payments through enrollment.

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",
  "paymentInitiationData": {
    "loggedUser": {
      "document": {
        "identification": "11122233344",
        "rel": "CPF"
      }
    },
    "businessEntity": {
      "document": {
        "identification": "00000000000191",
        "rel": "CNPJ"
      }
    },
    "creditor": {
      "cpfCnpj": "12345678000199",
      "personType": "PESSOA_JURIDICA",
      "name": "João da Silva Santos"
    },
    "payment": {
      "type": "PIX",
      "schedule": {
        "single": {
          "date": "2023-08-23"
        },
        "daily": {
          "startDate": "2023-08-23"
        },
        "weekly": {
          "dayOfWeek": "QUINTA_FEIRA",
          "startDate": "2023-08-23"
        },
        "monthly": {
          "startDate": "2023-08-23"
        },
        "custom": {
          "additionalInformation": "Todas quintas e domingos por 6 meses"
        }
      },
      "date": "2024-03-05",
      "currency": "BRL",
      "amount": "1.12",
      "ibgeTownCode": "5300108",
      "details": {
        "localInstrument": "DICT",
        "qrCode": "\n\t\t\t\t\t\t  00020104141234567890123426660014BR.GOV.BCB.PIX014466756C616E6F32303139406578616D706C652E636F6D27300012\n\t\t\t\t\t\t  BR.COM.OUTRO011001234567895204000053039865406123.455802BR5915NOMEDORECEBEDOR6008BRASILIA61087007490062\n\t\t\t\t\t\t  530515RP12345678-201950300017BR.GOV.BCB.BRCODE01051.0.080450014BR.GOV.BCB.PIX0123PADRAO.URL.PIX/0123AB\n\t\t\t\t\t\t  CD81390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304EB76",
        "proxy": "11223344556",
        "creditorAccount": {
          "accountType": "CACC",
          "ispb": "00000000",
          "issuer": "0001",
          "number": "0001234567"
        }
      }
    },
    "debtorAccount": {
      "accountType": "CACC",
      "ispb": "00000000",
      "issuer": "0001",
      "number": "0001234567"
    },
    "remittanceInformation": "Pagamento da nota XPTO035-002"
  }
}