Home
API Reference
  1. Web Checkouts API
  2. API Reference

Calculate merchant fees

post
https://sand.merchant-api.com/merchant/calculate-merchant-fees

Merchants with a merchant fee for payment plan (i.e. MFPP) agreement can use this endpoint to determine the fee amount for a given order.

This service is only available for USD and CAD currencies.

Useful notes

  • The state and country value correspond to the customer's shipping address.
  • When the value returned in merchant_fee_for_payment_plan is $0 it means there is no fee applied to the order and this does not need to be displayed at checkout.
    • Calculate merchant fees response

    • adjusted_order_amount DOUBLE

      Total order amount including the merchant fee plan amount.

    • currency STRING

      Order currency.

    • merchant_fee_for_payment_plan DOUBLE

      Calculated amount for merchant fee for payment plan.

    Body Params
    string
    required

    Order currency that will be applied to merchant fee plan calculation.

    double
    required

    Order amount used to calculate the merchant fee plan.

    string
    required

    Customer state derived from the customer's shipping address

    string
    required

    Customer country derived from the customer's shipping address

    Responses

    Updated 6 days ago

    Language
    Credentials
    Header
    LoadingLoading…
    Response
    Click Try It! to start a request and see the response here! Or choose an example:
    application/json

    Updated 6 days ago