Introduction
Agreement
Authentication
Batch
Browser Payment
Gateway
Hosted Checkout
Payment Plan
Session
Tokenization
Transaction
Wallet
RESOURCES
Changelog
Session
setMessage()
setMessage()
Sets the content of the hidden label inside the iFrame. Content of the label will be used by assistive technology applications and devices.
This function supports the Multiple Hosted Session functionality.
Usage Copied to clipboard
PaymentSession.setMessage(HostedFieldRole, message, scope)
Example Copied to clipboard
PaymentSession.setMessage('card.number', 'Invalid card number, please check your card number');
Arguments Copied to clipboard
HostedFieldRole
Copied to clipboard
String
REQUIRED
The field role for the card field rendered in an iFrame and hosted on the American Express PSP. Valid
field
roles:
card.nameOnCard
card.number
card.expiryMonth
card.expiryYear
card.securityCode
giftCard.number
giftCard.pin
ach.bankAccountNumber
ach.bankAccountNumberConfirmation
ach.bankAccountHolder
ach.routingNumber
directDebitCanada.bankAccountHolder
directDebitCanada.bankAccountNumber
directDebitCanada.financialInstitutionNumber
directDebitCanada.bankAccountNumberConfirmation
directDebitCanada.transitNumber
message
Copied to clipboard
String
The message to be sent to hosted field and used as a hidden label.
scope
Copied to clipboard
String
The optional named instance of a card payment data set within a session. See Multiple Hosted Sessions for more information.
Return Value Copied to clipboard
None