Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

A guide to the Fee Profiling functionality to support businesses with this requirement via our REST API.

This function allows you to specify a Fee Profile to be applied on a per transaction basis and can be used via Schedule a single payment API and eCommerce live card/tokenized API. This function is not enabled by default and is subject to approval with the fee details agreed upon in the application form.

A new parameter needs to be included in the API when using the functionality - “Profile”.

Possible scenarios:

  • If “Profile' parameter is not included in the API call, Profile 1 is automatically applied.

  • If “Profile” parameter included in the API call:

    • Value '1' = profile 1 will be applied

    • Value '2' = profile 2 will be applied

    • Other value = error is returned

Sample API:

Profile 1 = Business Paid

{
    "ProcessType": "COMPLETE",
    "Reference": "FeeProfiling T10",
    "Description": "This is an example real-time transaction",
    "Amount": 100.00,
    "CurrencyCode": "AUD",
    "Profile": 1,
    "CardToken": "2ac36f28fccf48ffa846678bf8a59151",
    "ServiceDate": "2022-03-01T10:00:00+10:00",
    "Payer": {
    	"uniqueReference": "Testfake1",
    	"groupReference":"Testfake1",
    	"familyOrBusinessName":"Surname",
    	"givenName":"First Name",
    	"billingAddress":{"Line1": "1 Test St","Line2": "Test Building","Suburb": "Testville","State": "QLD","PostCode": "4001","Country": "AUS" },
    	"email":"test@test.com",
    	"phone":"0733331111",
    	"savePayer":"false"
    },
    "Audit": {
		"Username": "Example-User",
    	"UserIP": "1.2.3.4"
    }
  }

Sample response of Profile 1

{
    "transactionId": "RT869913",
    "reference": "FeeProfiling T10",
    "statusCode": "S",
    "subStatusCode": null,
    "statusDescription": null,
    "processedAmount": 100.00,
    "cardType": "Visa",

Profile 2 = Payer Paid

{
    "ProcessType": "COMPLETE",
    "Reference": "FeeProfiling T20",
    "Description": "This is an example real-time transaction",
    "Amount": 100.00,
    "CurrencyCode": "AUD",
    "Profile": 2,
    "CardToken": "1a1c6d12176e4c1fb04b9241c52f14f0",
    "ServiceDate": "2022-03-01T10:00:00+10:00",
    "Payer": {
    	"uniqueReference": "Testfake1",
    	"groupReference":"Testfake1",
    	"familyOrBusinessName":"Surname",
    	"givenName":"First Name",
    	"billingAddress":{"Line1": "1 Test St","Line2": "Test Building","Suburb": "Testville","State": "QLD","PostCode": "4001","Country": "AUS" },
    	"email":"test@test.com",
    	"phone":"0733331111",
    	"savePayer":"false"
    },
    "Audit": {
		"Username": "Example-User",
    	"UserIP": "1.2.3.4"
    }
  }

Sample response of Profile 2

{
    "transactionId": "RT869914",
    "reference": "FeeProfiling T20",
    "statusCode": "S",
    "subStatusCode": null,
    "statusDescription": null,
    "processedAmount": 104.00,
    "cardType": "Visa",

  • No labels