Pular para o conteúdo principal

ScheduleAccessOperation

operationIdstringobrigatório
optInExternalIdstring
statusstringobrigatório

Valores possíveis: [SCHEDULED, PENDING, PROCESSING, COMPLETED, PARTIALLY_COMPLETED, FAILED]

requestedAtstring<date-time>obrigatório
scheduledForstring<date-time>

Presente enquanto a operação está SCHEDULED; abertura da janela em que ela começa (ENG-1188).

companies object[]obrigatório
  • Lista [
    • agendaScope object
    queryIdstringobrigatório
    companyIdstringobrigatório
    clientIdstringobrigatório
    packageIdstring
    packageVersioninteger
    assignmentRevisioninteger
    exceptionsRevisioninteger
    migrationIdstring
    pairs object[]obrigatório
  • Lista [
    • acquirerTaxIdstringobrigatório

    Valores possíveis: O valor deve corresponder à expressão regular ^[A-Z0-9]{14}$

    paymentSchemestringobrigatório

    Valores possíveis: não vazio e <= 16 caracteres

    sourcesstring[]obrigatório

    ENG-1198: new scopes only carry PACKAGE and ADDITIONAL. CONTRACT (pairs kept by a contract protection) and LEGACY remain valid only in snapshots frozen before.

    Valores possíveis: [PACKAGE, ADDITIONAL, CONTRACT, LEGACY]

  • ]
    • resolvedAtstring<date-time>obrigatório
    legacybooleanobrigatório
    companyTaxIdstringobrigatório
    statusstringobrigatório

    Valores possíveis: [PENDING, PROCESSING, COMPLETED, PARTIALLY_COMPLETED, FAILED]

    scopes object[]obrigatório
  • Lista [
    • externalRequests object[]
  • Lista [
    • agendaScope objectobrigatório
    versionintegerobrigatório
    Valor constante 1
    queryIdstringobrigatório

    Valores possíveis: não vazio e <= 128 caracteres

    clientIdstringobrigatório

    Valores possíveis: não vazio e <= 128 caracteres

    companyIdstringobrigatório

    Valores possíveis: não vazio e <= 128 caracteres

    snapshotHashstringobrigatório

    Valores possíveis: O valor deve corresponder à expressão regular ^[0-9a-f]{64}$

    scheduleTrackingIdstringobrigatório
    requestIdstringobrigatório
    requestIdsstring[]obrigatório
    processKeystring
    providerstringobrigatório
    statusstringobrigatório
    reasonstring
    occurredAtstring<date-time>obrigatório
  • ]
    • scheduleTrackingIdstringobrigatório

    Empty while a frozen scope is awaiting consent or registration; its result remains PENDING.

    acquirerTaxIdstringobrigatório
    paymentSchemestringobrigatório
    resultStatusstringobrigatório

    CONSENTED only on the operation of a contracts relationship probe (ENG-1403) whose pair ended on the consent, without a read.

    Valores possíveis: [PENDING, PROCESSING, DATA, EMPTY, NO_ACTIVE_RELATIONSHIP, UNSUCCESSFUL, FAILED, CONSENTED]

  • ]
  • ]
    • ScheduleAccessOperation
    {
      "operationId": "string",
      "optInExternalId": "string",
      "status": "SCHEDULED",
      "requestedAt": "2024-07-29T15:51:28.071Z",
      "scheduledFor": "2024-07-29T15:51:28.071Z",
      "companies": [
        {
          "agendaScope": {
            "queryId": "string",
            "companyId": "string",
            "clientId": "string",
            "packageId": "string",
            "packageVersion": 0,
            "assignmentRevision": 0,
            "exceptionsRevision": 0,
            "migrationId": "string",
            "pairs": [
              {
                "acquirerTaxId": "string",
                "paymentScheme": "string",
                "sources": [
                  "PACKAGE"
                ]
              }
            ],
            "resolvedAt": "2024-07-29T15:51:28.071Z",
            "legacy": true
          },
          "companyTaxId": "string",
          "status": "PENDING",
          "scopes": [
            {
              "externalRequests": [
                {
                  "agendaScope": {
                    "version": 1,
                    "queryId": "string",
                    "clientId": "string",
                    "companyId": "string",
                    "snapshotHash": "string"
                  },
                  "scheduleTrackingId": "string",
                  "requestId": "string",
                  "requestIds": [
                    "string"
                  ],
                  "processKey": "string",
                  "provider": "string",
                  "status": "string",
                  "reason": "string",
                  "occurredAt": "2024-07-29T15:51:28.071Z"
                }
              ],
              "scheduleTrackingId": "string",
              "acquirerTaxId": "string",
              "paymentScheme": "string",
              "resultStatus": "PENDING"
            }
          ]
        }
      ]
    }