Skip to main content

MerchantFeeInvoice

attempts object[]required
  • Array [
    • attemptinteger<int32>required
    externalReferenceIdstringnullable
    outcomeMerchantFeeInvoiceAttemptOutcomerequired

    Possible values: [APPROVED, DECLINED, UNKNOWN, BLOCKED, RETURNED]

    responseCodestringnullable
    responseMessagestringnullable
    startedAtstring<date-time>required
    transactionIdstringnullable
  • ]
    • blockedReasonstringnullable
    createdAtstring<date-time>required
    dunningAttemptsinteger<int32>nullable
    featureFeeTotalinteger<int64>nullable
    featureLines object[]required
  • Array [
    • amountinteger<int64>required
    chargeKindInvoiceFeatureChargeKindrequired

    Possible values: [ENABLEMENT, MONTHLY, PER_TRANSACTION]

    featureGroupBillingFeatureGrouprequired

    Possible values: [FRAUD, TOKENIZATION, NETWORK_TOKENIZATION, ACCOUNT_UPDATER, SMART_ROUTING, CARD_NOT_PRESENT, THREE_DS, APPLE_PAY, GOOGLE_PAY, ACH_TENDER, EBT_TENDER, AGENTIC_CHECKOUT, SMART_POS, TTP_IOS_NATIVE, TTP_IOS_NEARPAY, TTP_ANDROID_NEARPAY, TTP_ANDROID_NATIVE]

    lineIdstringnullable
    occurredAtstring<date-time>nullable
    quantityinteger<int64>required
    rateCardVersionIdstringnullable
    unitFixedinteger<int64>required
    unitPercentinteger<int64>required
    volumeinteger<int64>required
  • ]
    • gatewayChargeIdstringnullable
    idstringrequired
    issuedAtstring<date-time>nullable
    locationUsage object[]nullable
  • Array [
    • channelBillingChannelrequired

    Possible values: [CARD_PRESENT, CARD_NOT_PRESENT, ACH]

    credentialProfileIdstring<uuid>nullable
    locationIdstringrequired
    settledCountinteger<int64>required
    settledVolumeinteger<int64>required
  • ]
    • monthlyFeeinteger<int64>nullable
    nextAttemptAtstring<date-time>nullable
    organizationIdstringrequired
    paidinteger<int64>nullable
    paidAtstring<date-time>nullable
    periodstringrequired
    periodEndExclusivestring<date-time>nullable
    periodStartstring<date-time>nullable
    pricingGaps object[]required
  • Array [
    • currencystringnullable
    excludedSaleAmountMinorUnitsinteger<int64>nullable

    Feature-attributed settled sale amount excluded from USD billing, in currency minor units.

    excludedSaleCountinteger<int64>nullable

    Feature-attributed settled sale count excluded from USD billing for featureGroup and currency.

    featureGroupBillingFeatureGrouprequired

    Possible values: [FRAUD, TOKENIZATION, NETWORK_TOKENIZATION, ACCOUNT_UPDATER, SMART_ROUTING, CARD_NOT_PRESENT, THREE_DS, APPLE_PAY, GOOGLE_PAY, ACH_TENDER, EBT_TENDER, AGENTIC_CHECKOUT, SMART_POS, TTP_IOS_NATIVE, TTP_IOS_NEARPAY, TTP_ANDROID_NEARPAY, TTP_ANDROID_NATIVE]

    reasonstringrequired
  • ]
    • rateCardVersionIdstringnullable
    statusMerchantFeeInvoiceStatusnullable

    Possible values: [draft, issued, collecting, paid, past_due, blocked, void]

    totalinteger<int64>nullable
    unclassifiedPricingGaps object[]
  • Array [
    • currencystringnullable
    reasonstringrequired
    unattributedSaleAmountMinorUnitsinteger<int64>nullable
    unattributedSaleCountinteger<int64>nullable
  • ]
    • updatedAtstring<date-time>required
    voidReasonstringnullable
    voidedAtstring<date-time>nullable
    voidedBystringnullable
    MerchantFeeInvoice
    {
      "attempts": [
        {
          "attempt": 0,
          "externalReferenceId": "string",
          "outcome": "APPROVED",
          "responseCode": "string",
          "responseMessage": "string",
          "startedAt": "2024-07-29T15:51:28.071Z",
          "transactionId": "string"
        }
      ],
      "blockedReason": "string",
      "createdAt": "2024-07-29T15:51:28.071Z",
      "dunningAttempts": 0,
      "featureFeeTotal": 0,
      "featureLines": [
        {
          "amount": 0,
          "chargeKind": "ENABLEMENT",
          "featureGroup": "FRAUD",
          "lineId": "string",
          "occurredAt": "2024-07-29T15:51:28.071Z",
          "quantity": 0,
          "rateCardVersionId": "string",
          "unitFixed": 0,
          "unitPercent": 0,
          "volume": 0
        }
      ],
      "gatewayChargeId": "string",
      "id": "string",
      "issuedAt": "2024-07-29T15:51:28.071Z",
      "locationUsage": [
        {
          "channel": "CARD_PRESENT",
          "credentialProfileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "locationId": "string",
          "settledCount": 0,
          "settledVolume": 0
        }
      ],
      "monthlyFee": 0,
      "nextAttemptAt": "2024-07-29T15:51:28.071Z",
      "organizationId": "string",
      "paid": 0,
      "paidAt": "2024-07-29T15:51:28.071Z",
      "period": "string",
      "periodEndExclusive": "2024-07-29T15:51:28.071Z",
      "periodStart": "2024-07-29T15:51:28.071Z",
      "pricingGaps": [
        {
          "currency": "string",
          "excludedSaleAmountMinorUnits": 0,
          "excludedSaleCount": 0,
          "featureGroup": "FRAUD",
          "reason": "string"
        }
      ],
      "rateCardVersionId": "string",
      "status": "draft",
      "total": 0,
      "unclassifiedPricingGaps": [
        {
          "currency": "string",
          "reason": "string",
          "unattributedSaleAmountMinorUnits": 0,
          "unattributedSaleCount": 0
        }
      ],
      "updatedAt": "2024-07-29T15:51:28.071Z",
      "voidReason": "string",
      "voidedAt": "2024-07-29T15:51:28.071Z",
      "voidedBy": "string"
    }