PApaymentology
Fees

Apply Rebate Fee

Changed on

This API will be deprecated. Use the new API "Apply Miscellaneous Fee" to apply a fee or a fee rebate

post/pws/pws_apply_rebate_fees/

Request

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

Request body

api_call_unique_identifierstring required

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

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

input_idinteger required

Group Id /token/ account number.</br>Pass group_id when input_type is 'g'.</br>Pass account number when input_type is 'a'.</br>Pass token when input_type is 't'.

input_typestring required
<p>Input Type :</p> <ul> <li class="docBullet">a ==&gt; Account</li> <li class="docBullet">g ==&gt; Group</li> <li class="docBullet">t ==&gt; Token</li> </ul>
user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Details on the Fee example Location of the fee

fee_amountnumber

Amount that is charged as miscellaneous fee

ext_fee_reference_idstring

Fee Reference Id from external system.</br>It is optional when fee_id is provided

fee_idinteger

Fee id which is applied at group/account level.</br>It is optional when ext_fee_reference_id is provided.

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "input_id": 695534277,
  "input_type": "a",
  "remarks": "**ADD FEE DETAILS**, eg Guadalajara Govt Fees",
  "fee_id": 71
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "message": "Miscellaneous Fee Applied successfully for  465591301"
  }
}

Changes