API Docs

__METHOD= POST . __PATH= /almaws/v1/users/{user_id}/fees/{fee_id} .

Pay/waive/dispute/restore user fine/fee

This API applies the specified operation to a specific fine/fee.

Resource URL

POST /almaws/v1/users/{user_id}/fees/{fee_id}

API Description

URL Parameters

ParameterTypeDescription
user_idxs:stringA unique identifier for the user
fee_idxs:stringThe fine/fee identifier

Querystring Parameters

ParameterTypeRequiredDescription
user_id_typexs:stringOptional. Default: all_uniqueThe type of identifier that is being searched. Optional. If this is not provided, all unique identifier types are used. The values that can be used are any of the values in the User Identifier Type code table.
opxs:stringRequiredThe operation to be performed on the user's specified fee. Mandatory. Options are pay, waive, dispute or restore
amountxs:stringOptional.The amount of the payment to be made on the user's specified fees. Relevant for op=pay,waive
methodxs:stringOptional.The Payment method. Relevant and mandatory if op=pay. Options are CREDIT_CARD, ONLINE, or CASH
reasonxs:stringOptional.The reason for waiving the fine/fee. Mandatory if op=waive. The value should be one of the codes from the Reasons for Transactions code table.
commentxs:stringOptional.A note that can be attached to the action. Optional.
external_transaction_idxs:stringOptional.An external payment system transaction ID. Relevant for op=pay

Body Parameters

None

Output

This method returns a Fee object. See doc

Possible Error Codes

CodeMessage
402119General error.
401665Fine not found.
401651Identifier not found.
401666Parameter is not valid.