Surcharge

Get Configured Surcharge Merchant data: Is Surcharge enabled, Surcharge percentage, and Surcharge StartDate

get

Query parameters

processorGuidstring · uuidOptional

organizationGuidstring · uuidOptional

mKeystringOptional

Header parameters

AccessTokenstringRequired

access token

Responses

200

Returns the Configured Surcharge Merchant data

application/json

SurchargeEnabledbooleanOptional

Is Surcharging enabled - true/false returned based on configured Merchant Surcharge.

SurchargeRatestring · nullableOptional

example 2.9900 in d.dddd format - configured Merchant Surcharge Percentage Rate.

SurchargeStartDatestring · nullableOptional

Surcharge Start Date based on configured Merchant Surcharge. Date Format - yyyy-MM-dd Response Example: "SurchargeStartDate": "2025-01-31"

400

If surcharge config throws exception

application/json

404

If the surcharge config is not found

application/json

get/api/surchargeConfig

GET /api/surchargeConfig HTTP/1.1
AccessToken: text
Accept: */*

{
  "SurchargeEnabled": true,
  "SurchargeRate": "text",
  "SurchargeStartDate": "text"
}

Returns Calculated Surcharge based on Amount, Configured Surcharge Merchant percentage, and CREDIT only Card Bin

get

Query parameters

ProcessorGuidstringOptional

required if API Partner - Identifies Processor being used by an API Partner

OrganizationGuidstringOptional

internal use - Valid Panorama Organization Guid

MKeystring · max: 500Optional

internal use - Used by FrontStream only

CardBinstring · min: 6 · max: 8Optional

optional if TokenGuid or ExternalCardToken used - Valid card bin - 1st 6 to 8 digits

TokenGuidstringOptional

optional - Valid Token Guid from a Tokenized card through Payment API

ExternalCardTokenstring · max: 200Optional

internal use

Amountstring · max: 9Required

required - transaction amount used for surcharge calculation

Header parameters

AccessTokenstringRequired

access token

Responses

200

Returns the calculated surcharge

application/json

Amountstring · nullableOptional

This is the original amount submitted for Surcharge calculation.

SurchargeAmountstring · nullableOptional

This is the calculated surcharge amount based on configured Merchant Surcharge Percentage Rate and submitted amount. d.dd format

SurchargeRatestring · nullableOptional

example 2.9900 in d.dddd format - configured Merchant Surcharge Percentage Rate.

400

If surcharge calculation throws exception

application/json

404

If the surcharge data is not found

application/json

get/api/surcharge

GET /api/surcharge?Amount=text HTTP/1.1
AccessToken: text
Accept: */*

{
  "Amount": "text",
  "SurchargeAmount": "text",
  "SurchargeRate": "text"
}