Calculating Card Fees for on-charging

Payment Authorisation Fee

This documentation is deprecated

Please refer to the updated documentation https://docs.payadvantage.com.au/reference/payment_authorization_fees_calculate-1 

In order to accurately provide fee information to your customers when charging them, it is essential to know the type of card they will be using. This information ensures that the fee details given to the customer are correct. To assist you in this process, our helper allows you to input the charge amount and receive a breakdown of the fees incurred.

When a customer's payment account is tokenized, you will receive a customer payment account token. This token can be used to calculate the fee for the specific transaction at hand. 

Example Request

curl -L -X POST 'https://api.payadvantage.com.au/v3/payment_authorization_fees
--data: '{"Amount": 100.00, "CustomerPaymentAccount": {"code": "QRTIPA"}}'

Example Request Body

{
       "Amount": 100.00,
       "CustomerPaymentAccount": {
"code": "QRTIPA"
}
}

Example Responses

STATUS 200 // Successful

{
        "AttemptFee": 0.7,
        "AttemptFeeTax": 0.07,
        "Msf": 0.5,
        "MsfTax": 0.05,
        "TotalAmount": 1.32,
        "Card": {
                "IssuingCountry": "Australia"
        }
}

STATUS 4## // Error

{
	"errorCode": "error_code",
	"messages": [
		"Error message." 
	]
}

Query Parameters

[Deprecated] Calculate Fee with Amount

NOTE: Please use the Payment Authorisation Fee endpoint above

If you are on-charging fees to your customers then it may be beneficial to calculate and show this fee amount to them. This helper allows you to provide the charge amount and get back a breakdown of the fee incurred.

Example Request

curl -L -X GET 'https://api.payadvantage.com.au/v3/calculator/fees/realtime_credit_card?amount={value}' \
 -H 'Authorization: Bearer {access_token}' \

Example Responses

STATUS 200 // Successful
    
{
	"Amount": 100.00,
	"AttemptFee": 0.30,
	"AttemptFeeGST": 0.03,
	"MSF": 1.81,
	"MSFGST": 0.09,
	"TotalFee": 2.23
}

STATUS 4## // Error
    
{
	"errorCode": "error_code",
	"messages": [
		"Error message." 
	]
}

Query Parameters

Parameters used in the request URL to return filtered or sorted data in the response body. These parameters follow the same rules as any standard HTML query string parameter. The first parameter is separated by ‘?’ and subsequent parameters are separated by ‘&’.