Patron Credit

Refund Patron Credit

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

Add's patron credit.

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 (possible values {add, refund}) action identifier
DtoCreditData
Property Type Nullable Description
TxnAmount Decimal No Required. (Value must be less than outstanding balance for single txnId, Value has to be equal to outstanding balance for multiple txnIds)
PatronPaymentMethod Int No Yes. (11 for cash, only supported)
FreeTextNote String Yes Notes
MainTxnIds List of integer No Txn Ids of those credit that are refunded.
Request body
Example
application/json, text/json 
{ 
TxnAmount :8.50, 
FreeTextNote : "Fiddler refund credit",
PatronPaymentMethod: 11,
MainTxnIds:[1,2,3]
}

Response Information

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

HTTP Response Codes

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