Skip to main content

AgentEffectiveRateCardsResponse

agentIdstringrequired
buyRate objectnullable
assignmentSourceRateCardAssignmentSourcerequired

Possible values: [PLATFORM_TEMPLATE, EXPLICIT_AGENT_BUY, INHERITED_PARENT_DEFAULT, AGENT_DEFAULT, EXPLICIT_ORGANIZATION, INHERITED_AGENT_DEFAULT]

billingCycleDayinteger<int32>required
effectiveFromstring<date-time>required
featureFees object[]required
  • Array [
    • enablementFeeinteger<int64>required
    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]

    lifecycleFeeFixedinteger<int64>

    Integer cents per lifecycle event. Accepted only for TOKENIZATION and NETWORK_TOKENIZATION; their payment-event price is perTxnFeePercent/perTxnFeeFixed.

    monthlyFeeinteger<int64>required
    perTxnFeeFixedinteger<int64>required
    perTxnFeePercentinteger<int64>required
  • ]
    • monthlyFeeinteger<int64>required
    rateCardGroupIdstringnullable
    rateCardGroupNamestringnullable
    setByAgentIdstringnullable
    statusstringrequired
    subjectIdstringrequired
    subjectTypestringrequired
    sellRates object[]required
  • Array [
    • assignmentSourceRateCardAssignmentSourcerequired

    Possible values: [PLATFORM_TEMPLATE, EXPLICIT_AGENT_BUY, INHERITED_PARENT_DEFAULT, AGENT_DEFAULT, EXPLICIT_ORGANIZATION, INHERITED_AGENT_DEFAULT]

    billingCycleDayinteger<int32>required
    effectiveFromstring<date-time>required
    featureFees object[]required
  • Array [
    • enablementFeeinteger<int64>required
    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]

    lifecycleFeeFixedinteger<int64>

    Integer cents per lifecycle event. Accepted only for TOKENIZATION and NETWORK_TOKENIZATION; their payment-event price is perTxnFeePercent/perTxnFeeFixed.

    monthlyFeeinteger<int64>required
    perTxnFeeFixedinteger<int64>required
    perTxnFeePercentinteger<int64>required
  • ]
    • monthlyFeeinteger<int64>required
    rateCardGroupIdstringnullable
    rateCardGroupNamestringnullable
    setByAgentIdstringnullable
    statusstringrequired
    subjectIdstringrequired
    subjectTypestringrequired
  • ]
    • AgentEffectiveRateCardsResponse
    {
      "agentId": "string",
      "buyRate": {
        "assignmentSource": "PLATFORM_TEMPLATE",
        "billingCycleDay": 0,
        "effectiveFrom": "2024-07-29T15:51:28.071Z",
        "featureFees": [
          {
            "enablementFee": 0,
            "featureGroup": "FRAUD",
            "lifecycleFeeFixed": 0,
            "monthlyFee": 0,
            "perTxnFeeFixed": 0,
            "perTxnFeePercent": 0
          }
        ],
        "monthlyFee": 0,
        "rateCardGroupId": "string",
        "rateCardGroupName": "string",
        "setByAgentId": "string",
        "status": "string",
        "subjectId": "string",
        "subjectType": "string"
      },
      "sellRates": [
        {
          "assignmentSource": "PLATFORM_TEMPLATE",
          "billingCycleDay": 0,
          "effectiveFrom": "2024-07-29T15:51:28.071Z",
          "featureFees": [
            {
              "enablementFee": 0,
              "featureGroup": "FRAUD",
              "lifecycleFeeFixed": 0,
              "monthlyFee": 0,
              "perTxnFeeFixed": 0,
              "perTxnFeePercent": 0
            }
          ],
          "monthlyFee": 0,
          "rateCardGroupId": "string",
          "rateCardGroupName": "string",
          "setByAgentId": "string",
          "status": "string",
          "subjectId": "string",
          "subjectType": "string"
        }
      ]
    }