ccrz.cc_hk_Payment

Compatibility

This reference applies to:

TransactionPaymentParams Inner Class

The ccrz.cc_hk_Payment extension point class defines an inner class, TransactionPaymentParams, that defines the following Apex properties. For more information about Apex properties and accessors, see Apex Properties.

accountNumber {get; set;}

String that specifies an account number for the payment.

• For a purchase order (PO), this value is the entire PO number.
• For a credit card or bank account, this value is likely the account number's last four digits.

accountType {get; set;}

String that specifies the method of payment, such as purchase order (PO), credit card, and so on.

amount {get; set;}

Decimal that specifies the transaction's actual payment amount.

comments {get; set;}

String that specifies free text associated with the payment.

displayName {get; set;}

String that specifies the user-entered name for the stored payment that saves this transaction payment information.

expirationMonth {get; set;}

String that specifies the two-digit expiration month for the payment, such as for a credit card expiration date.

expirationYear {get; set;}

String that specifies the four-digit expiration year for the payment, such as for a credit card expiration date.

paymentType {get; set;}

String that specifies more specific payment method details for accountType. For example, if accountType is Credit Card, then this value can be the type of credit card.

requestAmount {get; set;}

Decimal that specifies a requested payment amount.

saveAsStoredPayment {get; set;}

Boolean

Value	Usage
true	Save the transaction payment information as a stored payment for the account.
false (default)	Don't save the transaction payment information as a stored payment.

storedPaymentId {get; set;}

String that specifies the Salesforce ID of the original ccrz__E_StoredPayment__c for the payment, if applicable.

storefront {get; set;}

String that specifies the storefront for the payment.

subAccountNumber {get; set;}

String that specifies a subaccount used with accountNumber.

token {get; set;}

String that specifies the tokenized form of the payment information.

transactionCode {get; set;}

String that specifies a code associated with the transaction. For example, for a credit card payment, this value is the specific transaction ID.

transactionPaymentId {get; set;}

String that specifies a unique ID that associates the record with an external system.

transactionSubcode {get; set;}

String that specifies a secondary code associated with the transaction. For example, if the transaction failed, this value can be failure's error code.

transactionType {get; set;}

String that specifies a provider-specific type of transaction, such as AUTH or CAPTURE for a credit card payment.

verificationCode {get; set;}

String that specifies a secondary transactionCode.

Extension Class Setting in CC Admin

If you extend the default version of this class, update your storefront settings in CC Admin. Select your storefront (1), and then select Payments in the Integrations section of the Storefront Settings menu (2). Update the Payment Hook API Class field (3) with your custom class name, prefixed with c., such as c.cc_example_hk_Payment.

For more help with creating an extension, including considerations and conventions, see Extend a Global Extension Point Class.

Tip

The Payment Types for Storefront section of the Payments integrations page is deprecated.

Note

Methods