onFocus Callback

When the hosted field in the iFrame has gained focus, the onFocus() callback invokes the function registered against this event.

Usage

PaymentSession.onFocus([<HostedFieldsRole>], function(selector, role), [scope])

Example

PaymentSession.onFocus(['card.number', 'card.securityCode'], function(selector, role) {
    //handle focus event
});

Arguments

<HostedFieldsRole> Array COMPULSORY

An array of field roles for the hosted fields where the event occurred. Valid array of 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.bankAccountNumberConfirmation', 'directDebitCanada.bankAccountHolder', 'directDebitCanada.bankAccountNumber', 'directDebitCanada.financialInstitutionNumber', 'directDebitCanada.transitNumber']

<callbackFunction> Function COMPULSORY

The callback function invoked with the selector and the role for the field whose proxy triggered the event.

selector String COMPULSORY

Identifier of the HTML element that has gained the focus (ex: "#card-number").
role String COMPULSORY

Valid array of field roles: ['number', 'nameOnCard', 'expiryMonth', 'expiryYear', 'securityCode', 'pin', 'bankAccountNumber', 'bankAccountNumberConfirmation', 'bankAccountHolder', 'routingNumber', 'financialInstitutionNumber', 'transitNumber']

scope String OPTIONAL

The optional named instance of a card payment data set within a session. See Multiple Hosted Sessions for more information.

Return Value

None