PatronAccountPay
Makes a payment on an existing charge on the Polaris patron account.
| PUT | /protected/1/{AccessToken}/patron/{PatronBarcode}/account/{ChargeTransactionID}/pay |
Authorization required?
Yes
Protected method?
Yes
URI Parameters
|
Name |
Required |
Description/Notes |
|
PatronBarcode |
Yes |
Barcode of patron |
|
ChargeTransactionID |
Yes |
Polaris charge transaction ID |
Query String Parameters
| Name |
Values |
Required |
Description/Notes |
|
wsid |
>0 |
Yes |
ID of workstation calling this method |
|
userid |
>0 |
Yes |
ID of user calling this method (not patron ID) |
XML Body Elements
Important: XML elements must be in the order shown below.
|
Name |
Required |
Description/Notes |
|
TxnAmount |
Yes |
Valid dollar amount and not greater than balance owed |
|
PaymentMethodID |
Yes |
Valid values are: 11 - Cash |
|
FreeTextNote |
|
Note to attach to payment |
XML Elements Returned
The following XML elements are returned.
|
Name |
Description/Notes |
| PAPIErrorCode |
PAPI Error code: Negative values represent errors and are defined elsewhere. Note: On successful completion, the PAPI error code is populated with a positive integer representing the number of rows returned. |
| ErrorMessage | Error or information message |
| PayTxnID | ID of the payment transaction |
Example
https://[hostname]/PAPIService/REST/protected/v1/1033/100/1/kSUEQM6CuhkFaloIaHPYdpHJ0U7Neczl/patron/21756003332022/account/680938/payBody
<PatronAccountPayData>
<TxnAmount >1.25</TxnAmount>
<PaymentMethodID >11</PaymentMethodID>
<FreeTextNote>Paid through Polaris API</FreeTextNote>
</PatronAccountPayData>Return - Success
HTTP/1.1 200 OK
<PatronAccountPayResult
xmlns:i="http://www.w3.org/2001/XMLSchemainstance">
<PAPIErrorCode>0</PAPIErrorCode>
<ErrorMessage/>
<PayTxnID>6546</PayTxnID>
</PatronAccountPayResult>Return - Failed
HTTP/1.1 200 OK
<PatronAccountPayResult
xmlns:i="http://www.w3.org/2001/XMLSchemainstance"><PAPIErrorCode>-1</PAPIErrorCode>
<ErrorMessage>Invalid workstation ID.</ErrorMessage>
<PayTxnID>0</PayTxnID>
</PatronAccountPayResult>