v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Convenience Fees

Get convenience fee settings

Returns all convenience fee settings configured for the authenticated account. Each setting defines the transaction fee and processing fee applied for a specific payment rail. Requires the ViewConvenienceFees permission.

get/account/convenience-fees/settings

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

Response

Successboolean

True if the request was successful, false if it failed

ErrorMessagestring

Contains a description of the error if the request failed

Example response

{
  "Success": true,
  "FeeSettings": [
    {
      "SettingID": 12,
      "TransactionTypeID": 3,
      "TransactionType": "EFT",
      "TransactionFee": "1.50",
      "ProcessingFee": "0.25"
    }
  ]
}