AppendReceiptRequest Class Reference

Inheritance diagram for AppendReceiptRequest:

Public Member Functions
String	getName ()
	AppendReceiptRequest (@NonNull @ReceiptType String type, @NonNull String htmlContent)
void	setContent (@NonNull String htmlContent)
String	getContent ()
void	setType (@NonNull @ReceiptType String type)
void	setType (@ReceiptTypeFromReceipt int type)
String	getType ()
Public Member Functions inherited from CommerceApi
String	getMessageType ()
Public Member Functions inherited from CommerceMessage
abstract String	getName ()
abstract String	getMessageType ()
final String	getHandle ()
final boolean	isTypeOfMessage (@NonNull final String type)
boolean	put (String key, Object value)
Object	get (String key)
List< String >	getKeys ()
Status	send (@NonNull final Context context)

Static Public Attributes
static final String	NAME = "CP_APP_REQUESTS_APPEND_RECEIPT"
static final String	TYPE_CARD_HOLDER_RECEIPT_FOOTER = "CARDHOLDER_RECEIPT_FOOTER"
static final String	TYPE_MERCHANT_RECEIPT_FOOTER = "MERCHANT_RECEIPT_FOOTER"
Static Public Attributes inherited from CommerceApi
static final String	MESSAGE_NAME_PREFIX = "CP_APP_"
Static Public Attributes inherited from CommerceMessage
static final String	MESSAGE_TYPE_INTERAPP = "INTERAPP"
static final String	MESSAGE_TYPE_PAYMENTTRIGGER = "PAYMENTTRIGGER"
static final String	MESSAGE_TYPE_NONPAYMENTTRIGGER = "NONPAYMENTTRIGGER"
static final String	MESSAGE_TYPE_PAYMENTAPI = "PAYMENTAPI"
static final String	MESSAGE_TYPE_UNKNOWN = "UNKNOWN"
static final String	INTENT_ACTION_PREFIX = "com.verifone.commerce.intent.action."
static final String	INTENT_CATEGORY = "com.verifone.commerce.intent.category.CP_MESSAGE"
static final String	INTENT_EXTRA_HANDLE = "com.verifone.commerce.intent.extra.HANDLE"
static final String	INTENT_EXTRA_PAYLOAD = "com.verifone.commerce.intent.extra.PAYLOAD"
static final String	CP_JSON_KEY_TRANS_AMOUNT = "Trans_Amount"
static final String	CP_JSON_KEY_CURRENCY = "Currency"

Protected Member Functions
void	setHandle (@NonNull String handle)
void	setCpAppId (String cpAppId)
void	setCpAppVersion (String cpAppVersion)
String	getAsJsonString ()
void	populateMessageFromJson (@NonNull JSONObject jsonObject)
Protected Member Functions inherited from CommerceApi
void	populateMessageFromJson (@NonNull final JSONObject jsonObject)
String	getAsJsonString ()
String	getCpAppId ()
String	getCpAppVersion ()
Protected Member Functions inherited from CommerceMessage
void	populateMessageFromJson (@NonNull final JSONObject jsonObject)
void	setHandle (@NonNull final String handle)
JSONObject	getJsonObject ()
void	setJsonObject (@NonNull final JSONObject jsonObject)
abstract String	getAsJsonString ()
String	getCpAppId ()
void	setCpAppId (String cpAppId)
String	getCpAppVersion ()
void	setCpAppVersion (String cpAppVersion)

Additional Inherited Members
Static Public Member Functions inherited from CommerceMessage
static Intent	createIntentWithName (final String name)
static Intent	createIntentForMessage (final CommerceMessage message)
static int	getNumberOfReceivers (Context context, final CommerceMessage message)
static boolean	isResponseMessage (String name)
static boolean	isRequestMessage (String name)
static boolean	isMessageFromCPAndroid (String name)

Detailed Description

An API call to add data to the receipt footer. This can only be called within the context of a transaction, and should be called in response to a trigger before the transaction ends, generally in response to com.verifone.commerce.triggers.PaymentCompletedNotification.

This is currently abstract. in order to append to the receipt before this class is finally made concrete, please follow the instructions below in response to the PaymentCompletedNotification.

When the notification is received, the app has 1-2 seconds to create the footer information and send it back. In the sample code below, the phrase "Have a nice day!" will be appended to the bottom of the receipt.

Intent intent = new Intent("com.verifone.commerce.intent.action.CP_APP_REQUESTS_APPEND_RECEIPT");
intent.addCategory("com.verifone.commerce.intent.category.CP_MESSAGE");
intent.putExtra("com.verifone.commerce.intent.extra.PAYLOAD", "<p>Have a nice day!</p>");
context.sendBroadcast(intent);

To append an image, the image data must be inserted inline to an HTML img tag using the data URL scheme, as defined at https://tools.ietf.org/html/rfc2397. More information can be found at https://en.wikipedia.org/wiki/Data_URI_scheme#HTML, with an example below.

  Intent intent = new Intent("com.verifone.commerce.intent.action.CP_APP_REQUESTS_APPEND_RECEIPT");
  intent.addCategory("com.verifone.commerce.intent.category.CP_MESSAGE");
  intent.putExtra("com.verifone.commerce.intent.extra.PAYLOAD", "<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/* w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==" alt="Red dot" />");
* context.sendBroadcast(intent);
*  

CP API 4.3.0

Definition at line 53 of file AppendReceiptRequest.java.

Constructor & Destructor Documentation

AppendReceiptRequest()

AppendReceiptRequest	(	@NonNull @ReceiptType String	type,
		@NonNull String	htmlContent
	)

Creates the API request to send.

Parameters

type	Refer to setType(String type)
htmlContent	Refer to setContent(String htmlContent)

Definition at line 164 of file AppendReceiptRequest.java.

Member Function Documentation

getContent()

String getContent

(

)

Refer to setContent(String htmlContent)

Definition at line 181 of file AppendReceiptRequest.java.

getType()

String getType

(

)

Refer to setType(String type)

Definition at line 210 of file AppendReceiptRequest.java.

setContent()

void setContent

(

@NonNull String

htmlContent

)

Expects HTML data to append to the receipt.

Definition at line 173 of file AppendReceiptRequest.java.

setType()

void setType

(

@NonNull @ReceiptType String

type

)

Sets the type of receipt to modify.

Definition at line 188 of file AppendReceiptRequest.java.

Member Data Documentation

NAME

final String NAME = "CP_APP_REQUESTS_APPEND_RECEIPT"

static

The system name of the message.

Definition at line 60 of file AppendReceiptRequest.java.

TYPE_CARD_HOLDER_RECEIPT_FOOTER

final String TYPE_CARD_HOLDER_RECEIPT_FOOTER = "CARDHOLDER_RECEIPT_FOOTER"

static

The receipt presented to the customer.

Definition at line 64 of file AppendReceiptRequest.java.

TYPE_MERCHANT_RECEIPT_FOOTER

final String TYPE_MERCHANT_RECEIPT_FOOTER = "MERCHANT_RECEIPT_FOOTER"

static

The receipt retained by the merchant.

Definition at line 68 of file AppendReceiptRequest.java.

---

The documentation for this class was generated from the following file:

• src/main/java/com/verifone/commerce/api/AppendReceiptRequest.java