Pay fine

Pay patron fine

PUT /api/.../patrons/{id}/accounttransactions/finesfees?action=pay&reload={true}&overpayment={true}

This method allows the caller to pay patron fine.

Request Information

Parameters
Name Type Required Description
fineData DtoFineData Yes Define this parameter in the request body.
id Integer Yes The unique id assigned to the patron.
action String Yes Define this parameter in the request query string. Possible value is 'pay'
reload Bool Yes Define this parameter in the request query string. If set true, updated fines and fees list is returned
overpayment Bool Yes Define this parameter in the request query string. If set to true, over payment is credited to the patron account.
Note: In order for credit transaction to be completed, 'Credit for overpayment' SA needs to be enabled at the branch.
DtoFineData
Property Type Nullable Description
TxnAmount Decimal No Required. Amount to pay. For current implementation, amount should be equal or less than the balance owed.
MainTxnIDs Int No Required. List of transaction IDs. Unique identifier for each transaction
PatronPaymentMethod Int No For current implementation possible values are: 11 for paying with cash
FreeTextNote String Yes Notes
Request body
Example
application/json, text/json 
{ 
TxnAmount : 10, 
FreeTextNote : "Paying fee from NextGen",
PatronPaymentMethod: 11,
MainTxnIDs:
 [
        3,
        4,
        5
 ]
}

Response Information

Returns Txn Ids. If reload is set, fines fees are also returned
Example
application/json, text/json 
{
    
    "FinesAndFees": [
        {
            "ItemRecordID":0,
            "TxnID":3665717,
            "TxnCodeID":1,
            "CallNumber":null,
            "MaterialType":null,
            "TxnDate":"2013-05-29T17:11:59.33",
            "Type":"Charge",
            "FeeDescription":"Damage",
            "BrowseTitle":"",
            "Barcode":null,
            "TxnAmount":6.0000,
            "OutstandingAmount":6.0000,
            "Organization":"Schenectady County Public Library - Central",
            "TxnOrgID":null,
            "FreeTextNote":"damage fine from NextGen",
            "WaiverRequestID": null,
            "HasPendingWaiverRequest": false
        },
        {
            "ItemRecordID":0,
            "TxnID":3665712,
            "TxnCodeID":1,
            "CallNumber":null,
            "MaterialType":null,
            "TxnDate":"2013-05-29T16:29:29.633",
            "Type":"Charge",
            "FeeDescription":"Damage",
            "BrowseTitle":"",
            "Barcode":null,
            "TxnAmount":6.0000,
            "OutstandingAmount":6.0000,
            "Organization":"Schenectady County Public Library - Central",
            "TxnOrgID":null,
            "FreeTextNote":"damage fine from NextGen"
        },
        {
            "ItemRecordID":0,
            "TxnID":3665709,
            "TxnCodeID":1,
            "CallNumber":null,
            "MaterialType":null,
            "TxnDate":"2013-05-29T16:20:19.28",
            "Type":"Charge",
            "FeeDescription":"Misc Charge",
            "BrowseTitle":"",
            "Barcode":null,
            "TxnAmount":4.0000,
            "OutstandingAmount":4.0000,
            "Organization":"Schenectady County Public Library - Central",
            "TxnOrgID":null,
            "FreeTextNote":"charge",
            "WaiverRequestID": null,
            "HasPendingWaiverRequest": false
        }
    ],
    TxnIds: [
        1,
        2
    ]
 }

Reference for Polaris enum values:

enum PatronAccountTxnCode
{	
    Charge = 1,
    Payment = 2,
    Return = 3,
    Deposit = 4,
    Waive = 5,
    WaiveExistingCharge = 6,
    Forfeit = 7,
    Credit = 8,
    PayRefund = 9,
    AutoWaive = 10
}
enum PatronPaymentMethod
{
    PayFrmCredit = 1,
    PayFrmDeposit = 2,
    DepositFrmCredit = 3,
    CreditFrmDeposit = 4,
    CreditFrmPAY = 5,
    StoredValue = 6,
    Cash = 11,
    CreditCard = 12,
    DebitCard = 13,
    Check = 14,
    Voucher = 15,
    CollectionAgency = 16,
    SmartCard = 17
}

HTTP Response Codes

Code Description
200 OK. Success
400 Null object. Bad request
409 CONFLICT. Patron record is secured.