Data validation

The Aeropay component validates data at several stages of the payment or payout flow:

1. Component creation: Validates the session funding configuration, transaction intent, entry type, and currency.
2. Button tap: Runs optional onCustomValidation, then validates shopper details if onGetShopper is configured and returns values.
3. Consumer data collection: Requires valid first name, last name, email address, and phone number values.
4. OTP verification: Requires a six-digit code and handles provider verification failures.
5. Returning-shopper lookup: Confirms that userId belongs to an active Aeropay user.
6. Transaction submission: Lets you approve or stop the transaction through onPreAuthorisation, then reports failures only if submission is attempted.

How you receive an error depends on the validation stage:

The Aeropay component maps recognised runtime failures to these SDK codes:

SDK1301, SDK1302, SDK1305, SDK1306, SDK1308, and SDK1319 apply to recognised API or provider failure responses. Network or transport errors on the same operations call onError with SDK0500 or SDK0000 instead.

Before creating the Aeropay button, the SDK checks that:

• transactionData.intent.aeropay is present.
• session.allowedFundingTypes.payByBanks.aeropay.externalMerchantId is present and non-blank.
• session.allowedFundingTypes.payByBanks.aeropay.configurationId is present and non-blank.
• transactionData.entryType is EntryType.Ecom.
• transactionData.currency is "USD".

The supported Aeropay intents are Authorisation, Purchase, EstimatedAuthorisation, and Payout. In Kotlin these values are represented by the sealed AeropayIntentType class.

Catch creation errors around createComponent():

import com.pxp.checkout.types.ComponentType
import com.pxp.checkout.components.aeropaybutton.types.AeropayButtonComponentConfig
import com.pxp.checkout.exceptions.BaseSdkException

try {
    val aeropayButton = checkout.createComponent(
        ComponentType.AERO_PAY_BUTTON,
        AeropayButtonComponentConfig().apply {
            // Required for payment submission — return true to proceed.
            // If omitted or returns false, the SDK does not submit.
            onPreAuthorisation = { true }
        },
    )
} catch (error: BaseSdkException) {
    // Inspect error.errorCode and error.message
    showAlternativePaymentMethods()
}

Creation validation can produce these errors:

When userId isn't set, tapping the button runs shopper pre-validation only if onGetShopper is configured. The SDK trims and validates any returned firstName, lastName, email, and phoneNumber values before opening the popup.

Configure onGetShopper on PxpSdkConfig when you want to prefill or pre-validate shopper data before the popup opens. If you omit it, shoppers enter details on the consumer data screen. Don't rely on transactionData.shopper alone for Aeropay prefill or pre-check.

You can omit fields or return empty strings. The component treats them as missing and lets the shopper enter them on the consumer data screen. If you return a non-empty invalid value, the component calls onError with SDK1300. Invalid formats in the pre-check map to FN02, LN02, EA02, and PN02. Length violations map to FN03, LN03, and EA03.

Inspect error.details on the BaseSdkException passed to onError for field keys and localised validation messages when debugging invalid prefilled shopper data.

Return shopper data in the expected formats:

import com.pxp.checkout.services.models.transaction.Shopper

onGetShopper = {
    Shopper(
        id = "shopper-123",
        firstName = "John",
        lastName = "Doe",
        email = "john.doe@example.com",
        phoneNumber = "+14155550123",
    )
}

Validation rules for values returned by onGetShopper:

skipConsumerDataCollection requires all four consumer data values to be non-empty and consumerDataCollectionConfig.editableFields to be empty. If any field is listed in editableFields, the consumer data screen still appears. An empty phone number from onGetShopper also prevents the skip even when the flag is true.

On the consumer data screen, empty required fields show inline messages such as FN01, LN01, EA01, and PN01. Invalid formats show FN02, LN02, EA02, and PN02.

The shopper can't continue until all four fields pass validation.

The OTP screen requires a six-digit code. Non-digit characters are filtered out. Verification remains unavailable until all six digits are present.

When OTP verification fails, the component calls onError with SDK1302. If the provider returns code AP112, the SDK still reports SDK1302. Treat this as a verification failure and let the shopper retry or use Resend when the countdown allows it.

When userId is set to a non-empty trimmed value, the SDK retrieves the Aeropay user before opening bank selection:

Empty or blank userId values don't start the returning-shopper path. The SDK continues with the new-shopper flow instead.

Before submitting the transaction, the SDK calls onPreAuthorisation.