Learn how to cover Fees

Payment API - Fee - API specification calculates fees based on the transaction amount and source grouping, with various optional parameters affecting the fee calculation.

Key Details:

• API Version: v1

• Endpoint: /api/fee

• Method: GET

• Tags: Fees

• Summary: Calculates fees based on amount and transaction source.

• Required Parameters:

  • Amount: Transaction amount (required).

  • TransactionSourceGroupId: Transaction type (10 = api partner fee).

  • PayFee: A flag indicating whether the transaction fee is covered.

• Optional Parameters:

  • ProcessorGuid, CharityId, OrganizationGuid, IntegrationSourceGuid, TokenGuid: Used to specify the processor, charity, and integration details.

  • CommissionRateOverride: Allows setting a custom commission rate (within contract limits).

  • CardProcessingFeeOverride: Overrides default card processing fees.

  • Tip: Donor's tip amount (if applicable).

  • CreditCardTypeId: Used for card-specific fee calculation. (possible values - 1 - AMEX, 2 - MC, 3 - VISA, 4 - DISCOVER, 5 - DINERSCLUB, 7 - MAESTRO

Responses:

• 200 (Success): Returns the calculated fees in JSON format.

• 400 (Bad Request): If there's an exception in fee calculation.

• 404 (Not Found): If the fees cannot be found.

Components:

• FeeResponse: Describes the calculated fee details (e.g., commission rates, card fees, total fees, and overrides).

• BrokenRule: Represents an error in fee calculation with an error code and message.

• ProblemDetails: Details for any error response, including status, title, and description.

The API enables fee calculations with flexibility to account for various factors such as commission overrides, card type fees, and tips.

Calculate Fees

See how to cover and calculate your fees here:

Fee