PApaymentology
Fees

Update Fee

Changed on

This web service updates a given fee

post/pws/pws_update_fee/

Request

  • Base URL
    https://api.uat.paymentology.com/ppws/api
  • URL
    https://api.uat.paymentology.com/ppws/api/pws/pws_update_fee/
  • Auth
    none declared

Request body

amount_referencedstring required
<p>The amout percentage is counted from</br> possible options are: <ul><li>N/A: Amount is irrelevant</li> <li>TXN: transaction</li> <li>OWD: Amount owed</li> <li>ATA: Aggregated amount of all transactions during the day, billing cycle, or annual (depending on the value of applied_to)</li> <li>ATD: Aggregated amount of debit transactions during the day, billing cycle, or annual (depending on the value of applied_to)</li> <li>ATC: Aggregated amount of credit transactions during the day, billing cycle, or annual (depending on the value of applied_to)</li><li>BAL: Statement Balance</li><li>DUE:Minimum Due</li> <li>OLA: Over Limit Amount</li><li>SET: Settlement Currency Amount</li><li>BIL: Billing Currency Amount</li></ul></p>. <p>Table with the possible fee_type with amount_referenced and applied_to:</p><table > <tbody> <tr> <th ><strong>fee_type</strong></th> <th ><strong>applied_to</strong></th> <th ><strong>amount_referenced</strong></th> </tr> <tr> <td >AUT</td> <td >TXN</td> <td> TXN,BIL,SET</td> </tr> <tr> <td >PER</td> <td >ANN, BLC, DAY</td> <td>N/A, TXN, OWD, ATA, ATD, ATC</td> </tr> <tr> <td >ADH</td> <td >MAN</td> <td>N/A, TXN, OWD, ATA, ATD, ATC </td> </tr> <tr> <td >MSC</td> <td >MAN</td> <td>N/A</td> </tr> <tr> <td >FLP/FSC</td> <td >SPE</td> <td>BAL,DUE</td> </tr> <tr> <td >FOL</td> <td >SPE</td> <td>OLA</td> </tr> <tr> </tbody> </table>
api_call_unique_identifierstring required

Unique number that must be passed at each API request. Identifier to make each API request unique

applied_to'TXN,BLC,ANN,DAY,MAN,SPE' required
<p>Fee that is applied to.</br>possible options are:</p><ul><li>TXN: transaction</li> <li>BLC: Billing Cycle (Period)</li> <li>ANN: Annually</li> <li>DAY: Daily (Computed during the overnight computational cycle)</li> <li>MAN: Api Charge Fee</li><li>SPE: Special Event</li></ul>
client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

effective_datestring required

Effective Date

fee_descrstring required

Fee Description

fee_idinteger required

Fee Template Id

fee_titlestring required

Fee Title

fee_type'AUT,PER,ADH,MSC,FLP,FRB,FOL,FCC,DOR' required
<p>Fee Type that is to be applied.</br>Possible Options are:</p><table > <tbody> <tr> <th ><strong>fee_type</strong></th> <th ><strong>fee_type_name</strong></th> <th ><strong>fee_type_description</strong></th> <th ><strong>fee_condition_usage</strong></th> </tr> <tr> <td >AUT</td> <td >Transaction Authorization Fee</td> <td>The fee is charged at transaction level during the Authorization Process. It is used in the Fraud Rules Engine</td> <td>1</td> </tr> <tr> <td >PER</td> <td >Periodic Fee</td> <td>Fee applied based on a predefined frequency</td> <td>2</td> </tr> <tr> <td >ADH</td> <td >Ad-Hoc Fee</td> <td>The fee is charged sporadically.</td> <td>0</td> </tr> <tr> <td >MSC</td> <td >Miscellaneous Fee</td> <td>Catch-All Fee triggered over API. Allows custom amount over an API call or a Billing Descriptor</td> <td>0</td> </tr> <tr> <td >FLP</td> <td >Late Payment Fee</td> <td>The fee is charged at the end of the Billing Cycle in case of a late payment or missed payment on account.</td> <td>0</td> </tr> <tr> <td >FRB</td> <td >Fee Rebate</td> <td>The fee rebate resulted by a reversal, etc.</td> <td>0</td> </tr> <tr> <td >FOL</td> <td >Over-the-Limit-Fee</td> <td>The fee is charged when the Credit Limit was exceeded and overdraft was applied</td> <td>2</td> </tr> <tr> <td >FCC</td> <td >Currency Conversion Fee</td> <td>The fee is charged when the currency conversion process took place.</td> <td>2</td> </tr> <tr> <td >DOR</td> <td >Dormancy Fee</td> <td>The fee is charged when the account is dormant during certain period of time determined by the Condition Function</td> <td>1</td> </tr> </tbody> </table>
user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

external_fee_reference_idstring

External Fee Reference Id

external_fee_reference_descrstring

External Fee Reference Descr

condition_function_callstring
<p>Condition Function Call (to determine if the fee should be applied or not.</br>Empty string means that the fee can be applied unconditionally</p>)
concurrencyboolean

If set to TRUE, then the fee will possibly be concurrent with other fees in the same Fee Priority Section

fee_priority_sectioninteger
<p>Fee Priority Section (to decide about how to apply concurrent fees belonging to the same Fee Priority Section).</br>If concurrency = FALSE, this parameter must be NULL</p>
fee_sectional_priorityinteger

Priority of the current fee in presence of multiple fees from the same Fee Priority Section (0 is the highest prioority)

special_actionsstring

Function call for a function making special actions

rule_idinteger

Rule Id

fee_basisinteger

This parameter regulates in which case to apply the fee (of course, provided the rule is triggered):

<ul><li>1: Apply only if the transaction is approved</li> <li>2: Apply only if the transaction is declined</li> <li>3: Apply only mo matter the transaction is approved or declined</li> <li>0: Irrelevant: The rule is not a subject for a fee (fee_id IS NULL)</li></ul>
is_fee_rebateboolean

This field indicate if the fee template include rebate fee or not

taxableboolean

Taxable Fee. If this field is true then for the calculation tax_fee_percent will be taken from product level

Example request

{
  "amount_referenced": "TXN",
  "api_call_unique_identifier": "438574845790657485",
  "applied_to": "TXN",
  "client_id": 760131,
  "effective_date": "2020-11-19",
  "fee_descr": "Generic Fee",
  "fee_id": 1,
  "fee_title": "Generic Fee",
  "fee_type": "FLP",
  "external_fee_reference_id": "N/A",
  "external_fee_reference_descr": "N/A",
  "condition_function_call": "</>",
  "special_actions": "Generic Fee Applied to TXN",
  "fee_basis": 1
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "message": "Fee Id 1 updated successfully"
  }
}

Changes