Skip to main content

FraudApprovalRateProtection

configuredbooleanrequired
currentMetrics objectrequired
approvalRateBasisPointsinteger<int32>nullablerequired

Possible values: >= 0 and <= 10000

approvedAttemptsinteger<int64>required

Possible values: >= 0

declinedAttemptsinteger<int64>required

Possible values: >= 0

periodFraudApprovalRateProtectionEvaluationPeriodrequired

Possible values: [HOURLY, DAILY, WEEKLY, MONTHLY]

qualifyingAttemptsinteger<int64>required

Possible values: >= 0

windowEndedAtstring<date-time>required
windowMinutesinteger<int64>required

Possible values: >= 1

windowStartedAtstring<date-time>required
enabledbooleanrequired
evaluationPeriodFraudApprovalRateProtectionEvaluationPeriodrequired

Possible values: [HOURLY, DAILY, WEEKLY, MONTHLY]

idstring<uuid>nullablerequired
minimumApprovalRateBasisPointsinteger<int32>required
minimumTransactionsinteger<int32>required
mutationActionFraudApprovalRateProtectionHistoryActionnullablerequired

Possible values: [CONFIG_CREATED, CONFIG_CHANGED, ENABLED, DISABLED, RESTRICTED, RESTORED]

mutationIdstringnullablerequired
mutationVersioninteger<int64>nullablerequired
organizationIdstringrequired
pastDay objectrequired
approvalRateBasisPointsinteger<int32>nullablerequired

Possible values: >= 0 and <= 10000

approvedAttemptsinteger<int64>required

Possible values: >= 0

declinedAttemptsinteger<int64>required

Possible values: >= 0

periodFraudApprovalRateProtectionEvaluationPeriodrequired

Possible values: [HOURLY, DAILY, WEEKLY, MONTHLY]

qualifyingAttemptsinteger<int64>required

Possible values: >= 0

windowEndedAtstring<date-time>required
windowMinutesinteger<int64>required

Possible values: >= 1

windowStartedAtstring<date-time>required
pastHour objectrequired
approvalRateBasisPointsinteger<int32>nullablerequired

Possible values: >= 0 and <= 10000

approvedAttemptsinteger<int64>required

Possible values: >= 0

declinedAttemptsinteger<int64>required

Possible values: >= 0

periodFraudApprovalRateProtectionEvaluationPeriodrequired

Possible values: [HOURLY, DAILY, WEEKLY, MONTHLY]

qualifyingAttemptsinteger<int64>required

Possible values: >= 0

windowEndedAtstring<date-time>required
windowMinutesinteger<int64>required

Possible values: >= 1

windowStartedAtstring<date-time>required
pastMonth objectrequired
approvalRateBasisPointsinteger<int32>nullablerequired

Possible values: >= 0 and <= 10000

approvedAttemptsinteger<int64>required

Possible values: >= 0

declinedAttemptsinteger<int64>required

Possible values: >= 0

periodFraudApprovalRateProtectionEvaluationPeriodrequired

Possible values: [HOURLY, DAILY, WEEKLY, MONTHLY]

qualifyingAttemptsinteger<int64>required

Possible values: >= 0

windowEndedAtstring<date-time>required
windowMinutesinteger<int64>required

Possible values: >= 1

windowStartedAtstring<date-time>required
pastWeek objectrequired
approvalRateBasisPointsinteger<int32>nullablerequired

Possible values: >= 0 and <= 10000

approvedAttemptsinteger<int64>required

Possible values: >= 0

declinedAttemptsinteger<int64>required

Possible values: >= 0

periodFraudApprovalRateProtectionEvaluationPeriodrequired

Possible values: [HOURLY, DAILY, WEEKLY, MONTHLY]

qualifyingAttemptsinteger<int64>required

Possible values: >= 0

windowEndedAtstring<date-time>required
windowMinutesinteger<int64>required

Possible values: >= 1

windowStartedAtstring<date-time>required
policySummary objectrequired
qualifyingOperationsFraudApprovalRateProtectionQualifyingOperation[]required

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

sentencestringrequired
stickyRestrictionbooleanrequired
processorProfileIdstring<uuid>nullablerequired
recentDeclineContributors object[]required
  • Array [
  • countinteger<int64>required

    Possible values: >= 1

    reasonCodestringrequired
    shareBasisPointsinteger<int32>required

    Possible values: >= 0 and <= 10000

  • ]
  • recentDeclines object[]required
  • Array [
  • amountMinorinteger<int64>nullablerequired

    Possible values: >= 0

    currencystringnullablerequired
    occurredAtstring<date-time>required
    processorPlatformFraudApprovalRateProtectionProcessorPlatformnullablerequired

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

    processorProfileIdstring<uuid>nullablerequired
    processorTypeFraudApprovalRateProtectionProcessorTypenullablerequired

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

    reasonCodestringrequired
    transactionIdstring<uuid>nullablerequired
  • ]
  • replayedbooleanrequired
    restoredAtstring<date-time>nullablerequired
    restriction objectnullablerequired
    approvalRateBasisPointsinteger<int32>required

    Possible values: >= 0 and <= 10000

    approvedAttemptsinteger<int64>required

    Possible values: >= 0

    declinedAttemptsinteger<int64>required

    Possible values: >= 0

    evaluationPeriodFraudApprovalRateProtectionEvaluationPeriodrequired

    Possible values: [HOURLY, DAILY, WEEKLY, MONTHLY]

    qualifyingAttemptsinteger<int64>required

    Possible values: >= 0

    restrictedAtstring<date-time>required
    thresholdBasisPointsinteger<int32>required

    Possible values: >= 1 and <= 10000

    scopeFraudApprovalRateProtectionScoperequired

    Possible values: [ORGANIZATION, PROCESSOR_PROFILE]

    statusFraudApprovalRateProtectionStatusrequired

    Possible values: [HEALTHY, RESTRICTED]

    updatedAtstring<date-time>nullablerequired
    updatedBystringnullablerequired
    versioninteger<int64>required
    FraudApprovalRateProtection
    {
    "configured": true,
    "currentMetrics": {
    "approvalRateBasisPoints": 0,
    "approvedAttempts": 0,
    "declinedAttempts": 0,
    "period": "HOURLY",
    "qualifyingAttempts": 0,
    "windowEndedAt": "2024-07-29T15:51:28.071Z",
    "windowMinutes": 0,
    "windowStartedAt": "2024-07-29T15:51:28.071Z"
    },
    "enabled": true,
    "evaluationPeriod": "HOURLY",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "minimumApprovalRateBasisPoints": 0,
    "minimumTransactions": 0,
    "mutationAction": "CONFIG_CREATED",
    "mutationId": "string",
    "mutationVersion": 0,
    "organizationId": "string",
    "pastDay": {
    "approvalRateBasisPoints": 0,
    "approvedAttempts": 0,
    "declinedAttempts": 0,
    "period": "HOURLY",
    "qualifyingAttempts": 0,
    "windowEndedAt": "2024-07-29T15:51:28.071Z",
    "windowMinutes": 0,
    "windowStartedAt": "2024-07-29T15:51:28.071Z"
    },
    "pastHour": {
    "approvalRateBasisPoints": 0,
    "approvedAttempts": 0,
    "declinedAttempts": 0,
    "period": "HOURLY",
    "qualifyingAttempts": 0,
    "windowEndedAt": "2024-07-29T15:51:28.071Z",
    "windowMinutes": 0,
    "windowStartedAt": "2024-07-29T15:51:28.071Z"
    },
    "pastMonth": {
    "approvalRateBasisPoints": 0,
    "approvedAttempts": 0,
    "declinedAttempts": 0,
    "period": "HOURLY",
    "qualifyingAttempts": 0,
    "windowEndedAt": "2024-07-29T15:51:28.071Z",
    "windowMinutes": 0,
    "windowStartedAt": "2024-07-29T15:51:28.071Z"
    },
    "pastWeek": {
    "approvalRateBasisPoints": 0,
    "approvedAttempts": 0,
    "declinedAttempts": 0,
    "period": "HOURLY",
    "qualifyingAttempts": 0,
    "windowEndedAt": "2024-07-29T15:51:28.071Z",
    "windowMinutes": 0,
    "windowStartedAt": "2024-07-29T15:51:28.071Z"
    },
    "policySummary": {
    "qualifyingOperations": [
    "processSale"
    ],
    "sentence": "string",
    "stickyRestriction": true
    },
    "processorProfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "recentDeclineContributors": [
    {
    "count": 0,
    "reasonCode": "string",
    "shareBasisPoints": 0
    }
    ],
    "recentDeclines": [
    {
    "amountMinor": 0,
    "currency": "string",
    "occurredAt": "2024-07-29T15:51:28.071Z",
    "processorPlatform": "TRANSIT",
    "processorProfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "processorType": "TSYS",
    "reasonCode": "string",
    "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    ],
    "replayed": true,
    "restoredAt": "2024-07-29T15:51:28.071Z",
    "restriction": {
    "approvalRateBasisPoints": 0,
    "approvedAttempts": 0,
    "declinedAttempts": 0,
    "evaluationPeriod": "HOURLY",
    "qualifyingAttempts": 0,
    "restrictedAt": "2024-07-29T15:51:28.071Z",
    "thresholdBasisPoints": 0
    },
    "scope": "ORGANIZATION",
    "status": "HEALTHY",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "updatedBy": "string",
    "version": 0
    }