Patron Credit

Add Patron Credit From Payment

POST /api/.../patrons/{id}/accounttransactions/credit?action=creditfrmpay

Add credit from patron's payment.

Permissions

    CR_AccessPatronServices_Allow
    CR_PatronStatus_Access
    CR_PatronStatus_ModifyPatronAccount
    CR_CreatePatronAccountCredit_Allow

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the patron code. Used to return a single object.
action String Yes. Value should be 'creditfrmpay' action identifier
DtoCreditData
Property Type Nullable Description
TxnAmount Decimal No Required. (Has to be greater than 0)
FreeTextNote String Yes Notes
MainTxnIDs Int No Required. List of payment transaction IDs. Unique identifier for each transaction.
Request body
Example
application/json, text/json 
{ 
    "TxnAmount" :8.50, 
    "FreeTextNote" : "Add credit from payment",
    "MainTxnIds":
    [
        45678,
        12345
    ]
}

Response Information

Example
application/json, text/json 
{
    "PatronID":85616,
    "TxnAmount":8.50,
    "FreeTextNote":"Fiddler add credit",
    "PatronPaymentMethod":11,
    "MainTxnIDs":
    [
        3666715,
        3666716
    ]
}
MainTxnIds is an array on integer, in this call it returns the Txn Ids of successfully added credits.

HTTP Response Codes

Code Description
200 OK. Success
403 Forbidden (privileges).
404 Not Found. Patron not found
409 CONFLICT. Patron record is secured.