API Docs

Pay user fines/fees

This API posts a payment against a specific user's fines and fees as a whole.

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

Parameter	Type	Description
`user_id`	xs:string	A unique identifier for the user

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 the User Identifier Type code table.
`op`	xs:string	Required	The operation to be performed on the user's specified fee. Mandatory. Currently only op=pay is supported
`amount`	xs:string	Optional.	The amount of the payment to be made on the user's specified fees. To pay the entire balance use amount=ALL
`method`	xs:string	Optional.	The Payment method. Relevant and mandatory if op=pay. Options are CREDIT_CARD, ONLINE, or CASH
`comment`	xs:string	Optional.	A note that can be attached to the payment action. Optional.
`external_transaction_id`	xs:string	Optional.	An external payment system transaction ID. Optional.

None

This method returns a Fees object. See doc

Code	Message
402119	General error.
401651	Identifier not found.
401666	Parameter is not valid.
60340	The request is API Restricted by library.
60258	The API Restricted profile is not valid.