Get fees in a billing statement

get/billing_statements/{id}/fees_summary

The GET /billing_statements/{id}/fees_summary call allows your platform to look up fees associated with a merchant's billing statement. Fees are organized in the response based on fee type and fee category. Be sure to subscribe to the billing_statements.created Notification event topic to programmatically incorporate new Billing Statements. Learn more about MIC+.

SecurityappIdAuth and appTokenAuth
Request
path Parameters
id
required
string [ 1 .. 255 ] characters
query Parameters
page
string

Return elements starting from this page. If specified, no other query parameters can be specified.

page_size
integer [ 1 .. 500 ]
Default: 10

Maximum number of items per page of results.

header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
required
Array of objects or null unique
next
required
string or null
previous
required
string or null
api_version
required
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples
Response samples
application/json
{
  • "previous": "/billing_statements/{id}/fees_summary?page=aaabc123def456",
  • "next": "/billing_statements/{id}/fees_summary?page=cccde123fgh456",
  • "results": [
    • {
      • "fee_type": "VISA",
      • "fee_category": " VISA BUSINESS TIER 3 - STANDARD",
      • "currency": "USD",
      • "total_amount": 56594,
      • "item_count": 1,
      • "variable_fee_bps": 295,
      • "fixed_fee_amount": 20,
      • "fixed_fee_markup_amount": 0,
      • "variable_fee_markup_bps": 15,
      • "total_interchange_fee": 1690,
      • "total_markup": 8489,
      • "total_fees": 10179,
      • "api_version": "3.0"
      },
    • {
      • "fee_type": "VISA",
      • "fee_category": "VISA BUSINESS TIER 4 - STANDARD",
      • "currency": "USD",
      • "total_amount": 652134,
      • "item_count": 9,
      • "variable_fee_bps": 295,
      • "fixed_fee_amount": 25,
      • "fixed_fee_markup_amount": 0,
      • "variable_fee_markup_bps": 15,
      • "total_interchange_fee": 19463,
      • "total_markup": 97820,
      • "total_fees": 117823,
      • "api_version": "3.0"
      },
    • {
      • "fee_type": "VISA",
      • "fee_category": "VISA CORPORATE CARD - CARD NOT PRESENT",
      • "currency": "USD",
      • "total_amount": 202903,
      • "item_count": 4,
      • "variable_fee_bps": 265,
      • "fixed_fee_amount": 10,
      • "fixed_fee_markup_amount": 0,
      • "variable_fee_markup_bps": 15,
      • "total_interchange_fee": 5417,
      • "total_markup": 30435,
      • "total_fees": 35852,
      • "api_version": "3.0"
      },
    • {
      • "fee_type": "ECHECK",
      • "fee_category": "eCheck fees",
      • "currency": "USD",
      • "total_amount": 20290,
      • "item_count": 6,
      • "variable_fee_bps": null,
      • "fixed_fee_amount": null,
      • "fixed_fee_markup_amount": 0,
      • "variable_fee_markup_bps": 15,
      • "total_markup": 5417,
      • "total_fees": 5417,
      • "total_interchange_fee": null,
      • "api_version": "3.0"
      },
    • {
      • "fee_type": "ECHECK",
      • "fee_category": "eCheck fees max",
      • "currency": "USD",
      • "total_amount": 20290,
      • "item_count": 6,
      • "variable_fee_bps": null,
      • "fixed_fee_amount": null,
      • "fixed_fee_markup_amount": 0,
      • "variable_fee_markup_bps": 15,
      • "total_markup": 5417,
      • "total_fees": 5417,
      • "total_interchange_fee": null,
      • "api_version": "3.0"
      },
    • {
      • "fee_type": "ECHECK",
      • "fee_category": "eCheck fees min",
      • "currency": "USD",
      • "total_amount": 20290,
      • "item_count": 6,
      • "variable_fee_bps": null,
      • "fixed_fee_amount": null,
      • "fixed_fee_markup_amount": 0,
      • "variable_fee_markup_bps": 15,
      • "total_markup": 5417,
      • "total_fees": 5417,
      • "total_interchange_fee": null,
      • "api_version": "3.0"
      },
    • {
      • "fee_type": "CHARGEBACK",
      • "fee_category": "Chargeback fees",
      • "currency": "USD",
      • "total_amount": 20290,
      • "item_count": 4,
      • "variable_fee_bps": 0,
      • "fixed_fee_amount": 1500,
      • "fixed_fee_markup_amount": null,
      • "variable_fee_markup_bps": null,
      • "total_markup": null,
      • "total_fees": 6000,
      • "total_interchange_fee": null,
      • "api_version": "3.0"
      },
    • {
      • "fee_type": "VISA",
      • "fee_category": "Visa Fraud Chargeback Fee",
      • "currency": "USD",
      • "total_amount": 9000,
      • "item_count": 10,
      • "variable_fee_bps": null,
      • "fixed_fee_amount": 10,
      • "fixed_fee_markup_amount": null,
      • "variable_fee_markup_bps": null,
      • "total_markup": null,
      • "total_fees": 100,
      • "total_interchange_fee": 100,
      • "api_version": "3.0"
      },
    • {
      • "fee_type": "VISA",
      • "fee_category": "'VI Intl RefundTrx APF Credit",
      • "currency": "USD",
      • "total_amount": -5000,
      • "item_count": 10,
      • "variable_fee_bps": -10,
      • "fixed_fee_amount": null,
      • "fixed_fee_markup_amount": null,
      • "variable_fee_markup_bps": 10,
      • "total_markup": 0,
      • "total_fees": 500,
      • "total_interchange_fee": 500,
      • "api_version": "3.0"
      },
    • {
      • "fee_type": "OTHER",
      • "fee_category": "MC ACQUIRING FEE",
      • "currency": "USD",
      • "total_amount": 8807781,
      • "item_count": 49,
      • "variable_fee_bps": 4,
      • "fixed_fee_amount": 0,
      • "fixed_fee_markup_amount": null,
      • "variable_fee_markup_bps": null,
      • "total_markup": null,
      • "total_fees": 352,
      • "total_interchange_fee": 352,
      • "api_version": "3.0"
      },
    • {
      • "fee_type": "RECURRING",
      • "fee_category": "Monthly",
      • "currency": "USD",
      • "total_amount": null,
      • "item_count": null,
      • "variable_fee_bps": null,
      • "fixed_fee_amount": null,
      • "fixed_fee_markup_amount": 2500,
      • "variable_fee_markup_bps": null,
      • "total_markup": 2500,
      • "total_fees": 2500,
      • "total_interchange_fee": null,
      • "api_version": "3.0"
      },
    • {
      • "fee_type": "VISA",
      • "fee_category": "Auth Fees",
      • "currency": "USD",
      • "total_amount": null,
      • "item_count": 100,
      • "variable_fee_bps": null,
      • "fixed_fee_amount": null,
      • "fixed_fee_markup_amount": 30,
      • "variable_fee_markup_bps": null,
      • "total_markup": 30,
      • "total_fees": 30,
      • "total_interchange_fee": null,
      • "api_version": "3.0"
      },
    • {
      • "fee_type": "MASTERCARD",
      • "fee_category": "Auth Fees",
      • "currency": "USD",
      • "total_amount": null,
      • "item_count": 50,
      • "variable_fee_bps": null,
      • "fixed_fee_amount": null,
      • "fixed_fee_markup_amount": 30,
      • "variable_fee_markup_bps": null,
      • "total_markup": 1500,
      • "total_fees": 1500,
      • "total_interchange_fee": null,
      • "api_version": "3.0"
      },
    • {
      • "fee_type": "ADJUSTMENT",
      • "fee_category": "Financial Adjustment",
      • "currency": "USD",
      • "month": 1,
      • "total_amount": 100,
      • "item_count": null,
      • "variable_fee_bps": null,
      • "fixed_fee_amount": null,
      • "fixed_fee_markup_amount": null,
      • "variable_fee_markup_bps": null,
      • "total_markup": null,
      • "total_fees": null,
      • "total_interchange_fee": null,
      • "api_version": "3.0"
      },
    • {
      • "fee_type": "ACCOUNT_DEBIT_FAILURE",
      • "fee_category": "BILLING FAILURE",
      • "currency": "USD",
      • "total_amount": null,
      • "item_count": 25,
      • "variable_fee_bps": null,
      • "fixed_fee_amount": null,
      • "fixed_fee_markup_amount": 1000,
      • "variable_fee_markup_bps": null,
      • "total_markup": null,
      • "total_fees": 25000,
      • "total_interchange_fee": null,
      • "api_version": "3.0"
      }
    ],
  • "api_version": "3.0"
}