API Docs

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

Pay user fines/fees

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

Resource URL

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

API Description

URL Parameters

ParameterTypeDescription
user_idxs:stringA unique identifier for the user

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. Currently only op=pay is supported
amountxs:stringOptional.The amount of the payment to be made on the user's specified fees. To pay the entire balance use amount=ALL
methodxs:stringOptional.The Payment method. Relevant and mandatory if op=pay. Options are CREDIT_CARD, ONLINE, or CASH
commentxs:stringOptional.A note that can be attached to the payment action. Optional.
external_transaction_idxs:stringOptional.An external payment system transaction ID. Optional.

Body Parameters

None

Output

This method returns a Fees object. See doc

Possible Error Codes

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