Skip to main content

SmartRoutingReportResponse

amounts object[]required
  • Array [
  • authorizationEvidenceStatusSmartRoutingGapEvidenceStatusrequired

    Possible values: [COMPLETE, PARTIAL, UNKNOWN]

    authorizedMinorinteger<int64>nullable
    captureEvidenceStatusSmartRoutingGapEvidenceStatusrequired

    Possible values: [COMPLETE, PARTIAL, UNKNOWN]

    capturedMinorinteger<int64>nullable
    currencystringrequired
    netCapturedMinorinteger<int64>nullable
    recoveredAuthorizationEvidenceStatusSmartRoutingGapEvidenceStatusrequired

    Possible values: [COMPLETE, PARTIAL, UNKNOWN]

    recoveredAuthorizedMinorinteger<int64>nullable
    recoveredCaptureEvidenceStatusSmartRoutingGapEvidenceStatusrequired

    Possible values: [COMPLETE, PARTIAL, UNKNOWN]

    recoveredCapturedMinorinteger<int64>nullable
    recoveredNetCapturedMinorinteger<int64>nullable
    recoveredRefundEvidenceStatusSmartRoutingGapEvidenceStatusrequired

    Possible values: [COMPLETE, PARTIAL, UNKNOWN]

    recoveredRefundedMinorinteger<int64>nullable
    recoveredSettledMinorinteger<int64>nullable
    recoveredSettlementEvidenceStatusSmartRoutingGapEvidenceStatusrequired

    Possible values: [COMPLETE, PARTIAL, UNKNOWN]

    refundEvidenceStatusSmartRoutingGapEvidenceStatusrequired

    Possible values: [COMPLETE, PARTIAL, UNKNOWN]

    refundedMinorinteger<int64>nullable
    settledMinorinteger<int64>nullable
    settlementEvidenceStatusSmartRoutingGapEvidenceStatusrequired

    Possible values: [COMPLETE, PARTIAL, UNKNOWN]

    sourceCoverage objectrequired
    assignedPurchasesinteger<int64>nullable
    censusAvailablebooleanrequired
    completeCashPurchasesinteger<int64>nullable
    completeFeePurchasesinteger<int64>nullable
    contiguousCompleteThroughstring<date-time>nullable
    feeCoverageReasonstringnullable
    missingActualAmountsinteger<int64>nullable
    unknownHorizonTimesinteger<int64>nullable
    unresolvedOwnedObligationsinteger<int64>nullable
    unresolvedSettlementMembershipsinteger<int64>nullable
    unsupportedCashSourcesinteger<int64>nullable
    unsupportedFeeSourcesinteger<int64>nullable
  • ]
  • breakdowns object[]required
  • Array [
  • bucketstringrequired
    dimensionstringrequired
    recoveredAuthorizationsinteger<int64>required
    sessionsinteger<int64>required
  • ]
  • coverageEvidence objectrequired
    evidenceStatusSmartRoutingGapEvidenceStatusrequired

    Possible values: [COMPLETE, PARTIAL, UNKNOWN]

    groups object[]required
  • Array [
  • asOfstring<date-time>nullable
    distinctCertifiedPairsinteger<int64>nullable
    eligibleMidsinteger<int64>nullable
    excludedProfilesByReason object[]required
  • Array [
  • codestringrequired
    countinteger<int64>required
    labelstringrequired
  • ]
  • segmentLabelstringrequired
    sessionsinteger<int64>required
    useCaseLabelstringrequired
    verifiedIndependentFamiliesinteger<int64>nullable
  • ]
  • freshness objectrequired
    dirtySessionsinteger<int64>required
    projectedThroughstring<date-time>nullable
    fromstring<date>required
    generatedAtstring<date-time>required
    independentRouteCoverage object[]required
  • Array [
  • codestringrequired
    countinteger<int64>required
    labelstringrequired
  • ]
  • locationIdstringnullable
    nextTimelineCursorstringnullable
    outcomes object[]required
  • Array [
  • codestringrequired
    countinteger<int64>required
    labelstringrequired
  • ]
  • processorAvailability objectrequired
    observedAtstring<date-time>nullable
    statusSmartRoutingProcessorAvailabilityStatusrequired

    Possible values: [UNKNOWN]

    windowSecondsinteger<int64>nullable
    recoveryGaps object[]required
  • Array [
  • codestringrequired
    countinteger<int64>required
    declinedAmounts object[]nullable
  • Array [
  • amountMinorinteger<int64>required
    currencystringrequired
  • ]
  • declinedAmountsEvidenceStatusSmartRoutingGapEvidenceStatusrequired

    Possible values: [COMPLETE, PARTIAL, UNKNOWN]

    labelstringrequired
    merchantActionstringnullable
    reasonEvidenceStatusSmartRoutingGapEvidenceStatusrequired

    Possible values: [COMPLETE, PARTIAL, UNKNOWN]

    sourceCoverageEvidenceStatusSmartRoutingGapEvidenceStatusrequired

    Possible values: [COMPLETE, PARTIAL, UNKNOWN]

  • ]
  • recoveryGapsEvidenceStatusSmartRoutingGapEvidenceStatusrequired

    Possible values: [COMPLETE, PARTIAL, UNKNOWN]

    summary objectrequired
    awaitingRetryOrAuthenticationinteger<int64>required
    cancelledinteger<int64>nullable
    definitiveFirstApprovalCountinteger<int64>required
    definitiveFirstApprovalRatenumber<double>nullable
    definitiveFirstSessionsinteger<int64>required
    exhaustedWithoutApprovalinteger<int64>required
    firstApprovalCountinteger<int64>required
    firstApprovalRatenumber<double>nullable
    firstDispatchSessionsinteger<int64>required
    initialPendingSessionsinteger<int64>required
    matureFinalApprovalCountinteger<int64>required
    matureFinalAuthorizationRatenumber<double>nullable
    matureFinalSessionsinteger<int64>required
    noCurrentAlternateinteger<int64>required
    pendingSessionsinteger<int64>required
    provisionalFinalApprovalCountinteger<int64>required
    provisionalFinalAuthorizationRatenumber<double>nullable
    provisionalPendingUnknownSessionsinteger<int64>required
    provisionalSessionsinteger<int64>required
    recoveredAuthorizationsinteger<int64>required
    recoveredEligibleinteger<int64>nullable
    routedSessionsinteger<int64>required
    safeRecoveryEligibleinteger<int64>nullable
    unknownFirstSessionsinteger<int64>required
    timeline object[]required
  • Array [
  • atstring<date-time>required
    attemptOrdinalinteger<int32>nullable
    evidenceStatusDecisionTimelineEvidenceStatus

    Possible values: [UNKNOWN, HISTORICAL_UNCLASSIFIED, RECORDED]

    messagestringrequired
    outcomeCodeSmartRoutingMerchantOutcomenullable

    Possible values: [FIRST_ATTEMPT_APPROVAL, RECOVERED_SALE, SMART_RECOVERY_IN_PROGRESS, NO_RECOVERY_ROUTE_AVAILABLE, AUTHENTICATION_REQUIRED, PROCESSOR_TEMPORARILY_UNAVAILABLE, DECLINED, PENDING]

    outcomeLabelstringnullable
    processorAccountDisplayNamestringnullable
  • ]
  • tostring<date>required
    SmartRoutingReportResponse
    {
    "amounts": [
    {
    "authorizationEvidenceStatus": "COMPLETE",
    "authorizedMinor": 0,
    "captureEvidenceStatus": "COMPLETE",
    "capturedMinor": 0,
    "currency": "string",
    "netCapturedMinor": 0,
    "recoveredAuthorizationEvidenceStatus": "COMPLETE",
    "recoveredAuthorizedMinor": 0,
    "recoveredCaptureEvidenceStatus": "COMPLETE",
    "recoveredCapturedMinor": 0,
    "recoveredNetCapturedMinor": 0,
    "recoveredRefundEvidenceStatus": "COMPLETE",
    "recoveredRefundedMinor": 0,
    "recoveredSettledMinor": 0,
    "recoveredSettlementEvidenceStatus": "COMPLETE",
    "refundEvidenceStatus": "COMPLETE",
    "refundedMinor": 0,
    "settledMinor": 0,
    "settlementEvidenceStatus": "COMPLETE",
    "sourceCoverage": {
    "assignedPurchases": 0,
    "censusAvailable": true,
    "completeCashPurchases": 0,
    "completeFeePurchases": 0,
    "contiguousCompleteThrough": "2024-07-29T15:51:28.071Z",
    "feeCoverageReason": "string",
    "missingActualAmounts": 0,
    "unknownHorizonTimes": 0,
    "unresolvedOwnedObligations": 0,
    "unresolvedSettlementMemberships": 0,
    "unsupportedCashSources": 0,
    "unsupportedFeeSources": 0
    }
    }
    ],
    "breakdowns": [
    {
    "bucket": "string",
    "dimension": "string",
    "recoveredAuthorizations": 0,
    "sessions": 0
    }
    ],
    "coverageEvidence": {
    "evidenceStatus": "COMPLETE",
    "groups": [
    {
    "asOf": "2024-07-29T15:51:28.071Z",
    "distinctCertifiedPairs": 0,
    "eligibleMids": 0,
    "excludedProfilesByReason": [
    {
    "code": "string",
    "count": 0,
    "label": "string"
    }
    ],
    "segmentLabel": "string",
    "sessions": 0,
    "useCaseLabel": "string",
    "verifiedIndependentFamilies": 0
    }
    ]
    },
    "freshness": {
    "dirtySessions": 0,
    "projectedThrough": "2024-07-29T15:51:28.071Z"
    },
    "from": "2024-07-29",
    "generatedAt": "2024-07-29T15:51:28.071Z",
    "independentRouteCoverage": [
    {
    "code": "string",
    "count": 0,
    "label": "string"
    }
    ],
    "locationId": "string",
    "nextTimelineCursor": "string",
    "outcomes": [
    {
    "code": "string",
    "count": 0,
    "label": "string"
    }
    ],
    "processorAvailability": {
    "observedAt": "2024-07-29T15:51:28.071Z",
    "status": "UNKNOWN",
    "windowSeconds": 0
    },
    "recoveryGaps": [
    {
    "code": "string",
    "count": 0,
    "declinedAmounts": [
    {
    "amountMinor": 0,
    "currency": "string"
    }
    ],
    "declinedAmountsEvidenceStatus": "COMPLETE",
    "label": "string",
    "merchantAction": "string",
    "reasonEvidenceStatus": "COMPLETE",
    "sourceCoverageEvidenceStatus": "COMPLETE"
    }
    ],
    "recoveryGapsEvidenceStatus": "COMPLETE",
    "summary": {
    "awaitingRetryOrAuthentication": 0,
    "cancelled": 0,
    "definitiveFirstApprovalCount": 0,
    "definitiveFirstApprovalRate": 0,
    "definitiveFirstSessions": 0,
    "exhaustedWithoutApproval": 0,
    "firstApprovalCount": 0,
    "firstApprovalRate": 0,
    "firstDispatchSessions": 0,
    "initialPendingSessions": 0,
    "matureFinalApprovalCount": 0,
    "matureFinalAuthorizationRate": 0,
    "matureFinalSessions": 0,
    "noCurrentAlternate": 0,
    "pendingSessions": 0,
    "provisionalFinalApprovalCount": 0,
    "provisionalFinalAuthorizationRate": 0,
    "provisionalPendingUnknownSessions": 0,
    "provisionalSessions": 0,
    "recoveredAuthorizations": 0,
    "recoveredEligible": 0,
    "routedSessions": 0,
    "safeRecoveryEligible": 0,
    "unknownFirstSessions": 0
    },
    "timeline": [
    {
    "at": "2024-07-29T15:51:28.071Z",
    "attemptOrdinal": 0,
    "evidenceStatus": "UNKNOWN",
    "message": "string",
    "outcomeCode": "FIRST_ATTEMPT_APPROVAL",
    "outcomeLabel": "string",
    "processorAccountDisplayName": "string"
    }
    ],
    "to": "2024-07-29"
    }