Check UserFee

Merchants can be set up on a CustomerPay pricing model where transaction fees are passed on to the customer at the time of checkout. These transaction fees are passed using the field USERFEE. This guide will walk you through how to calculate the USERFEE field using our gateway depending on the integration method you are using.

Direct - Check UserFee API

Our gateway provides a feature to calculate the processing fee that should be applied to the transaction using that merchant's specific pricing. You can then display the returned value on the checkout page by including the field USERFEE in the Sale transaction request.

Refer to Sequence of Passing USERFEE

This specific call is most helpful when you already have the Tokenized Card Data stored, and are completing subsequent Direct Payment transactions. Otherwise, if you need to collect card data, you can use the GetAPIKey call and include AMT in the request to get the USERFEE field passed back.

Refer to Embedded Tokenization steps

Requests

The Direct Check UserFee API Reference outlines the required and optional parameters needed for your request. The minimum required information in your request includes the merchants Terminal ID ( TERMID) and Password (PASS), the type of transaction (Z for Administrative), the subtype (UF for Check UserFee), and the Amount (AMT ).

If you are including a Platform Fee ( PLATFEE), make sure to pass this field so it can be added to the the total amount when the gateway calculates the USERFEE. Failure to do so will result in an incorrect USERFEE being returned.

Refer to Check UserFee API Reference

# Example Check UserFee request
curl --request POST \
  --url https://svra.interpaypos.com:1443/ \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
    "TYPE": "Z",
    "SUBTYPE": "UF",
    "TERMID": "TEST0058",
    "PASS": "zX3Ht5va",
    "AMT": "150.00"
  }'

Response Fields

All requests will be responded to with TEXT field and CODE field, and if successful, a USERFEE field:

• TEXT : "USERFEE CALCULATED" is displayed here when successful. For errors and decline responses this field contains the error message or decline message.
• CODE: This is the 4-digit response code from the transaction. "0000" constitutes a successful transaction, and any other 4-digit code constitutes a failure.
• USERFEE: Amount to charge cardholder for transaction in dollars and cents (numeric with decimal - e.g., 1.00 is one dollar). Will return 0 if the merchant is not set up for CustomerPay.

Additional fields returned include DATE, TIME, and DUR.

{
  "CODE": "0000",
  "TEXT": "USERFEE CALCULATED",
  "USERFEE": "0.80",//User fee is returned in dollars and cents
  "DATE": "2024-10-15",
  "TIME": "12:41:22",
  "DUR": "0.109"
}

Redirect Payment - Check UserFee API

The Redirect Check UserFee API allows you to calculate the processing fee (USERFEE) for a transaction amount. You can then pass the calculated amount to the StartSession.

Requests

The Redirect Check UserFee API Reference outlines the required and optional parameters needed for your request. The minimum required information in your request includes the merchants Terminal ID ( TERMID) and Password (PASS), the type of transaction (W for Web-Redirect), the action (CheckUserFee for Check UserFee), and the Amount (AMT ).

If you are including a Platform Fee ( PLATFEE), make sure to pass this field so it can be added to the the total amount when the gateway calculates the USERFEE. Failure to do so will result in an incorrect USERFEE being returned.

Refer to Check UserFee API Reference

# Example Check UserFee request
curl --request POST \
  --url https://svra.interpaypos.com:1443/ \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
    "TYPE": "W",
    "ACTION": "CheckUserFee",
    "TERMID": "TEST0058",
    "PASS": "zX3Ht5va",
    "AMT": "200.00"
  }'

Response Fields

All requests will be responded to with TEXT field and CODE field, and if successful, a USERFEE field:

• TEXT : "USERFEE CALCULATED" is displayed here when successful. For errors and decline responses this field contains the error message or decline message.
• CODE: This is the 4-digit response code from the transaction. "0000" constitutes a successful transaction, and any other 4-digit code constitutes a failure.
• USERFEE: Amount to charge cardholder for transaction in dollars and cents (numeric with decimal - e.g., 1.00 is one dollar). Will return 0 if the merchant is not set up for CustomerPay.

Additional fields returned include DATE, TIME, and DUR.

{
  "CODE": "0000",
  "TEXT": "USERFEE CALCULATED",
  "USERFEE": "0.80",//User fee is returned in dollars and cents
  "DATE": "2024-10-15",
  "TIME": "12:41:22",
  "DUR": "0.109"
}

Important Notes

• If the merchant is not set up for Customer Pay, the USERFEE will return as 0.00.
• You can always add USERFEE=0 to any Sale transaction, even if the merchant is not set up for Customer Pay. This ensures consistency in your integration without affecting the transaction.