Retrieve allowed SIF names based on API user's ISO

API Method: GET /api/v1/SIFFeeNames

Description:

This API method retrieves a list of allowed SIF (System Integration Fee) names that a payment processing service supports for a given ISO (Independent Sales Organization). The list of SIF fee names returned will be specific to the API user's permissions, meaning only the fee names allowed for the ISO the API user belongs to will be available.

Endpoint:

GET /api/v1/SIFFeeNames

Purpose:

To allow users to retrieve all available SIF fee names that they can apply in payment processing or merchant boarding operations. These fee names are used to define specific integration or transactional fees that can be assigned to merchants during the boarding process.

Authentication:

  • API Key or Basic auth
  • The API user must belong to a valid ISO.

Parameters:

  • Headers:
    • Authorization: Basick token or API key (required).
    • Content-Type: application/json (optional).

Response:

  • Status Code: 200 OK
  • Content Type: application/json

Example Response:

{
  "data": [
    "INTERNET GATEWAY",
    "POS INSURANCE",
    "POS SERVICE",
    "POS SUPPORT",
    "ACCOUNT MAINTENANCE",
    "APTITO POS SOFTWARE",
    "INACTIVITY FEE",
    "MERCHANT CLUB",
    "SERVICE FEE",
    "ONE TIME PLACEMENT",
    "SOFTWARE ONE TIME",
    "MONTHLY PLACEMENT",
    "MONTHLY POS PLACEMENT",
    "SOFTWARE MONTHLY",
    "ALDELO POS LICENSES",
    "ALDELO POS SOFTWARE",
    "ALDELO POS PLACEMENT",
    "ADMINISTRATIVE FEE",
    "POYNT PLACEMENT",
    "MONTHLY SUPPORT",
    "WIRELESS GATEWAY",
    "GIFT CARD PACKAGE",
    "WARRANTY",
    "EMV encryption",
    "Equipment LEASING",
    "Installation Fee",
    "Discover Membership",
    "Care Program",
    "PCI Annual Fee",
    "PCI Monthly",
    "APTITO POS HARDWARE",
    "EQUIPMENT ONE TIME",
    "HARDWARE ONE TIME",
    "EQUIPMENT MONTHLY",
    "HARDWARE MONTHLY",
    "ALDELO POS HARDWARE",
    "POYNT HARDWARE",
    "mPOS Placement",
    "GIFT CARD PACAKGE",
    "CMF G2 Reg",
    "CMF G2",
    "CMF Preform Match",
    "CMF Preform Match Reg",
    "POYNT SOFTWARE",
    "ADD SERVICES",
    "WEBSITE",
    "GATEWAY",
    "MERCHANT CLUB",
    "On File Fee",
    "NMI Gateway",
    "Annual Fee Monthly",
    "Back Bill",
    "Monthly Service",
    "Benefit Club Plus",
    "EBT Monthly Statement",
    "APTITO POS LICENSES",
    "CPS Software placement ",
    "CPS Hardware placement",
    "Aptito Sales",
    "UP INSIGHTS ESSENTIA",
    "mPOS Access",
    "mPOS SOFTWARE",
    "April Retreivals",
    "May Retrievals",
    "June Interchange",
    "Membership fee",
    "DataCap technology fee ",
    "Tech Support VAR POS",
    "mPOS LICENSES",
    "mPOS HARDWARE",
    "Consumer Pay Program",
    "Smart Membership Program",
    "Merch Annual Fee March",
    "CMS Fee Reg",
    "CMS Fee",
    "Custom Fee Name Test X",
    "Inactive Merchant Fee",
    "New Fee w-o description",
    "Equipment placement",
    "Equipment Fee"
  ],
  "status": 200,
}

Errors:

  • 401 Unauthorized: Invalid API key or token.
  • 403 Forbidden: API user does not have the necessary permissions to access the resource.
  • 404 Not Found: No SIF fee names available for the specified ISO or API user.
  • 500 Internal Server Error: An unexpected error occurred on the server.

Notes:

  • This API is primarily used during merchant onboarding and allows the user to retrieve fee structures that are applicable for the particular ISO.
  • The SIF fee names are predefined by the payment processor and mapped to each ISO based on their agreements.
Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!