Patron Payment methods

Get Patron Payment

GET /api/.../paymentmethods/{id}

Return a specific payment method in the system.

Response Information

Example

{
    "PaymentMethodID":11,
    "Description":"Cash"
}

HTTP Response Codes

List Patron Payment Methods

GET /api/.../paymentmethods

Return list of all payment methods in the system.

GET /api/.../paymentmethods?orgid={orgid}

Return a list of payment methods that belong to a specific organization.

GET /api/.../paymentmethods?txncode={txncode}

Return a list of payment methods that applies to a specific transaction type.

Note: Credit Card payment method is only included if all of the following are true:

• EnvisionWare or Comprise SmartPAY credit card payments is licensed.
• The branch allows online payments.
• The payment processing gateway is set to EnvisionWare or Comprise MSP.
• If using Envisionware, Leap is enabled in the gateway connection properties.

Request Information

Parameters

Response Information

Example

[
 {  "PaymentMethodID":11,
    "Description":"Cash"
 },
 {
    "PaymentMethodID":14,"Description":"Check"
 },
 {
    "PaymentMethodID":16,
    "Description":"Collection Agency"
 },
 {
    "PaymentMethodID":12,
    "Description":"Credit card"
 },
 {
    "PaymentMethodID":13,
    "Description":"Debit card"
 },
 {
    "PaymentMethodID":17,
    "Description":"Smart card"
 },
 {
    "PaymentMethodID":15,
    "Description":"Voucher"
 }
]

Example when txncode is CREDIT or DEPOSIT

[
 {  "PaymentMethodID":11,
    "Description":"Cash"
 },
 {
    "PaymentMethodID": 13,
    "Description": "Debit card"
 },
 {
    "PaymentMethodID": 14,
    "Description": "Check"
 },
 {
    "PaymentMethodID": 15,
    "Description": "Voucher"
 },
 {
    "PaymentMethodID": 17,
    "Description": "Smart card"
 }
]

Patron Account TxnCode

PatronAccountTxnCode
{
	Charge = 1,
	Deposit = 4,
	Credit = 8,
}

HTTP Response Codes