Skip to main content

CardHistoryResponse

asOfstring<date-time>required
attempts object[]required
  • Array [
    • attemptIdstring<uuid>required
    fraudDispositionCardHistoryFraudDispositionnullable

    Possible values: [ALLOW, REVIEW, FAILED, POST_AUTH_VOID, BLOCK]

    operationApprovalRateQualifyingOperationrequired

    Possible values: [processSale, processAuth, processWalletSale, processWalletAuth, forceAuth, processRecurring]

    outcomeCategoryProcessorOutcomeCategoryrequired

    Possible values: [APPROVED, DECLINED, VALIDATION_REJECTED, HOST_VALIDATION_REJECTED, CREDENTIALS_REJECTED, NOT_FOUND, STATE_CONFLICT, NO_ELIGIBLE_ROUTE, NOT_CERTIFIED, PRE_DISPATCH_UNAVAILABLE, IN_FLIGHT, RATE_LIMITED, SOFT_DECLINE, TIMEOUT_UNKNOWN_OUTCOME, RETRYABLE_PROVIDER_ERROR, NON_RETRYABLE_PROVIDER_ERROR]

    processorPlatformProcessorPlatformnullable

    Possible values: [TRANSIT, SIERRA, RAPID_CONNECT, CARDPOINTE, EPG, ECPI, SERVER_POST, MAVERICK_ACH, TRANSIT_SIMULATOR]

    processorTypeProcessorTypenullable

    Possible values: [TSYS, FISERV, ELAVON, CHASE, WORLDPAY, HEARTLAND, EPX, MAVERICK]

    startedAtstring<date-time>required
    transactionIdstring<uuid>required
  • ]
    • availabilityCardHistoryAvailabilityrequired

    Possible values: [COMPLETE, INCOMPLETE, UNAVAILABLE]

    locationIdstring
    newestTransactions object[]required
  • Array [
    • createdAtstring<date-time>required
    fraudDispositionCardHistoryFraudDispositionnullable

    Possible values: [ALLOW, REVIEW, FAILED, POST_AUTH_VOID, BLOCK]

    locationIdstringrequired
    processorAttemptCountinteger<int64>required
    statusTransactionStatusrequired

    Possible values: [PENDING, PENDING_CONFIRMATION, EXPIRED_UNCONFIRMED, FRAUD_BLOCKED, FRAUD_HELD, APPROVED, DECLINED, CANCELLED, ERROR, VOIDED, CAPTURED, TIP_ADJUSTED, ENRICHED, SETTLED, REFUNDED, REVERSED]

    transactionIdstring<uuid>required
    transactionTypeTransactionTyperequired

    Possible values: [SALE, AUTH, CAPTURE, VOID, REFUND, REVERSAL, ADJUSTMENT, TIP_ADJUSTMENT, RECURRING, FORCE_AUTH]

  • ]
    • organizationIdstringrequired
    unavailableReasonCardHistoryUnavailableReason

    Possible values: [CARD_METADATA_UNAVAILABLE, CARD_METADATA_PAGE_INCOMPLETE, CARD_HISTORY_UNAVAILABLE]

    windows object[]required
  • Array [
    • approvalRateBasisPointsinteger<int32>nullablerequired
    approvedAttemptsinteger<int64>required
    declinedAttemptsinteger<int64>required
    qualifyingAttemptsinteger<int64>required
    windowCardHistoryWindowrequired

    Possible values: [HOURS_24, DAYS_7, DAYS_30, DAYS_365]

  • ]
    • CardHistoryResponse
    {
      "asOf": "2024-07-29T15:51:28.071Z",
      "attempts": [
        {
          "attemptId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "fraudDisposition": "ALLOW",
          "operation": "processSale",
          "outcomeCategory": "APPROVED",
          "processorPlatform": "TRANSIT",
          "processorType": "TSYS",
          "startedAt": "2024-07-29T15:51:28.071Z",
          "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        }
      ],
      "availability": "COMPLETE",
      "locationId": "string",
      "newestTransactions": [
        {
          "createdAt": "2024-07-29T15:51:28.071Z",
          "fraudDisposition": "ALLOW",
          "locationId": "string",
          "processorAttemptCount": 0,
          "status": "PENDING",
          "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "transactionType": "SALE"
        }
      ],
      "organizationId": "string",
      "unavailableReason": "CARD_METADATA_UNAVAILABLE",
      "windows": [
        {
          "approvalRateBasisPoints": 0,
          "approvedAttempts": 0,
          "declinedAttempts": 0,
          "qualifyingAttempts": 0,
          "window": "HOURS_24"
        }
      ]
    }