NMW Payment Taglib Reference

JSP taglib encapsulating the AO Payments API.

This is the scriptless implementation based on javax.servlet.jsp.tagext.SimpleTagSupport. For compatibility with legacy applications that use JSP scriptlets, please use NMW Payment Taglib Reference (Legacy).

Both implementations are interoperable and may be used simultaneously under different prefixes.

A tag library for storing credit cards, authorizing credit card payments, capturing the funds, and voiding transactions.

This taglib is part of an extensible suite of interoperable, context-aware, auto-encoding taglibs. All auto-encoding tags generate correct output for their context, provide context information for nested tags, and validate the output of nested tags. For example, <ao:message> within <payment:comment> will write its output encoded as TEXT.

This suite includes, but is not limited to:

Usage

Standard Syntax

<%@ taglib prefix="payment" uri="https://oss.newmediaworks.com/payment-taglib/" %>

XML Syntax

<anyxmlelement xmlns:payment="https://oss.newmediaworks.com/payment-taglib/" />

Tag Library Information

Display Name:	NMW Payment Taglib
Version:	2.1.2
Short Name:	payment
URI:	https://oss.newmediaworks.com/payment-taglib/

Tag Summary

<payment:useProcessor>	Selects the processor that will be used for subsequent transactions.
<payment:connectorName>	Provides the connector name for the <payment:useProcessor> tag.
<payment:parameter>	Provides a connector-specific parameter for the <payment:useProcessor> tag.
<payment:storeCreditCard>	Stores a credit card number to a bank-provided, CISP-compliant storage mechanism.
<payment:payment>	Processes a credit card transaction.
<payment:capture>	Captures the funds from a previous authorization-only transaction (from <payment:payment capture="false">).
<payment:void>	Voids a previous transaction (from <payment:payment>).
<payment:maskCardNumber>	Masks a credit card number by only showing the first and last digits, hiding all the middle digits.
<payment:creditCard>	Provides the credit card details to a <payment:payment> tag.
<payment:cardNumber>	Provides the card number to either a <payment:storeCreditCard> or <payment:creditCard> tag.
<payment:expirationMonth>	Provides the expiration month to either a <payment:storeCreditCard> or <payment:creditCard> tag.
<payment:expirationYear>	Provides the expiration year to either a <payment:storeCreditCard> or <payment:creditCard> tag.
<payment:expirationDate>	Provides the expiration month and year to either a <payment:storeCreditCard> or <payment:creditCard> tag.
<payment:cardCode>	Provides the CVV2 card security code (three or four digits) to a <payment:storeCreditCard> or <payment:creditCard> tag.
<payment:maskedCardNumber>	Provides the masked (partial) card number to a <payment:creditCard> tag.
<payment:creditCardGUID>	Provides the token of a stored credit card to a <payment:creditCard> tag.
<payment:shippingAddress>	Provides the shipping details to a <payment:payment> tag.
<payment:firstName>	Provides a first/given name to a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.
<payment:lastName>	Provides a last/family name to a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.
<payment:companyName>	Provides a company name to a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.
<payment:email>	Provides the email address of the customer to either a <payment:storeCreditCard> or <payment:creditCard> tag.
<payment:phone>	Provides the phone number of the customer to either a <payment:storeCreditCard> or <payment:creditCard> tag.
<payment:fax>	Provides the fax number of the customer to either a <payment:storeCreditCard> or <payment:creditCard> tag.
<payment:customerId>	Provides an application-specific customer identifier to either a <payment:storeCreditCard> or <payment:creditCard> tag.
<payment:customerTaxId>	Provides the Social Security Number (SSN) or Employer Identification Number (EIN) of the customer to either a <payment:storeCreditCard> or <payment:creditCard> tag.
<payment:streetAddress1>	Provides the street address (line 1) to a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.
<payment:streetAddress2>	Provides the street address (line 2) to a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.
<payment:city>	Provides the city to a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.
<payment:state>	Provides the state/province/prefecture to a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.
<payment:postalCode>	Provides the ZIP/postal code to a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.
<payment:countryCode>	Provides a two-digit ISO 3166-1 alpha-2 country code to a <payment:storeCreditCard>, <payment:creditCard>, or <payment:shippingAddress> tag.
<payment:comment>	Provides a comment to a <payment:storeCreditCard>, <payment:creditCard>, or <payment:payment> tag.
<payment:orderNumber>	Provides the application-specific unique order number to a <payment:payment> tag.
<payment:currencyCode>	Provides the 3-digit ISO 4217 currency code to a <payment:payment> tag.
<payment:amount>	Provides the amount of the payment to a <payment:payment> tag.
<payment:taxAmount>	Provides the tax amount of the payment to a <payment:payment> tag.
<payment:taxExempt>	Provides the tax exempt flag to a <payment:payment> tag.
<payment:shippingAmount>	Provides the shipping amount to a <payment:payment> tag.
<payment:dutyAmount>	Provides the duty amount to a <payment:payment> tag.
<payment:merchantEmail>	Provides the email address of the merchant to a <payment:payment> tag.
<payment:invoiceNumber>	Provides the invoice number of this transaction to a <payment:payment> tag.
<payment:purchaseOrderNumber>	Provides the purchase order number of this transaction to a <payment:payment> tag.
<payment:transactionId>	Provides the transaction ID to a <payment:capture> or <payment:void> tag.
<payment:process>	This is the point where the bank is contacted and the <payment:payment>, <payment:capture>, or <payment:void> is processed.
<payment:error>	The body of this tag will be processed when there was any type of error processing the <payment:payment>, <payment:capture>, or <payment:void>.
<payment:getErrorReason>	Gets the reason for a processing error.
<payment:accepted>	The body of this tag will be processed when the payment was accepted (approved).
<payment:getAuthorizationCode>	Gets the authorization code to display to the customer.
<payment:getTransactionId>	Gets the per-processor unique transaction ID.
<payment:held>	The body of this tag will be processed when the payment was held (pending some sort of review).
<payment:getReviewReason>	Gets the review reason for a transaction that has been placed on hold.
<payment:rejected>	The body of this tag will be processed when the payment was rejected (declined).
<payment:getRejectedReason>	Gets the rejected reason for a payment attempt.
<payment:getCvvResult>	Gets the CVV2 (card security code) verification result.
<payment:getAvsResult>	Gets the AVS (address verification system) result.

Function Summary

String	${payment:maskCardNumber(String)}	Masks a credit card number by only showing the first and last digits, hiding all the middle digits.
boolean	${payment:isError()}	Determines if there was any type of error processing the <payment:payment>, <payment:capture>, or <payment:void>.
String	${payment:getErrorReason()}	Gets the reason for a processing error.
boolean	${payment:isAccepted()}	Determines if the payment was accepted (approved).
String	${payment:getAuthorizationCode()}	Gets the authorization code to display to the customer.
String	${payment:getTransactionId()}	Gets the per-processor unique transaction ID.
boolean	${payment:isHeld()}	Determines if the payment was held (pending some sort of review).
String	${payment:getReviewReason()}	Gets the review reason for a transaction that has been placed on hold.
boolean	${payment:isRejected()}	Determines if the payment was rejected (declined).
String	${payment:getRejectedReason()}	Gets the rejected reason for a payment attempt.
String	${payment:getCvvResult()}	Gets the CVV2 (card security code) verification result.
String	${payment:getAvsResult()}	Gets the AVS (address verification system) result.