Enrollment Journey Sessions

Lists enrollment journey sessions.

Method for listing all enrollment journey sessions created by an application. The ID of the journey must be passed for the sessions to be listed.

get/baas/v1/open/itp/enrollments/journeys-sessions

Request

  • Base URL
    https://sandbox.openfinance.celcoin.dev
  • URL
    https://sandbox.openfinance.celcoin.dev/baas/v1/open/itp/enrollments/journeys-sessions
  • Auth
    OAuth 2
    Client credentials
    Token URL: http://localhost:8080/auth/realms/master/protocol/openid-connect/token scopes: app

Query parameters

pagestring

Page number.

pageSizestring

Size of a page.

Response

Successful return of the paginated list.

Example response

{
  "data": [
    {
      "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"
      }
    }
  ],
  "meta": {
    "total": 0.123,
    "page": 0.123,
    "pageSize": 0.123,
    "totalPages": 0.123
  }
}

Changes

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