API Docs
Pay/waive/dispute/restore user fine/fee
Contents
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
| Parameter | Type | Description |
|---|---|---|
user_id | xs:string | A unique identifier for the user |
fee_id | xs:string | The fine/fee identifier |
Querystring Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
user_id_type | xs:string | Optional. Default: all_unique | The 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 UserIdentifierTypes code table. |
op | xs:string | Required | The operation to be performed on the user's specified fee. Mandatory. Options are pay, waive, dispute or restore |
amount | xs:string | Optional. | The amount of the payment to be made on the user's specified fees. Relevant for op=pay,waive |
method | xs:string | Optional. | The Payment method. Relevant and mandatory if op=pay. Options are CREDIT_CARD, ONLINE, or CASH |
reason | xs:string | Optional. | The reason for waiving the fine/fee. Relevant and mandatory for op=waive. The value should be one of the codes from the FineFeeTransactionReason code table. |
comment | xs:string | Optional. | A note that can be attached to the action. Optional. |
external_transaction_id | xs:string | Optional. | 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
| Code | Message |
|---|---|
| 402119 | General error. |
| 401665 | Fine not found. |
| 401651 | Identifier not found. |
| 401666 | Parameter is not valid. |
| 60340 | The fee is API Restricted by library. |
| 60258 | The API Restricted profile is not valid. |