Primer Docs

Overview

Set the PrimerHeadlessUniversalCheckoutRawDataManagerDelegate in order to receive different callbacks from your RawDataManager.

primerRawDataManager(_:dataIsValid:)

Returns whether the rawData set is valid, and all the errors that occurred during validation.

1func primerRawDataManager(_ rawDataManager: PrimerHeadlessUniversalCheckout.RawDataManager, dataIsValid isValid: Bool, errors: [Error]?)

swift

copy

Parameters

The instance of the raw data manager calling this delegate method

Whether the data is valid

The errors that occured during the validation

primerRawDataManager(_:willFetchMetadataForState:)

Called when we begin to fetch metadata forthe current rawData. Changing rawData triggers this callback. Some time after this is called, primerRawDataManager(_:didReceiveMetadata:forState:) will be called with the relevant metadata for the state.

Use this method to indicate to the user that metadata is being fetched; for example, by showing a loading spinner or other UI until the metadata has been returned.

12func primerRawDataManager(_ rawDataManager: PrimerHeadlessUniversalCheckout.RawDataManager,                          willFetchMetadataForState state: PrimerValidationState)

swift

copy

Parameters

The instance of the raw data manager calling this delegate method.

An object containing the state that triggered the metadata fetch. For example, for card number entry, this will be an instance of PrimerCardNumberEntryState

Implementations

class PrimerCardNumberEntryState

Used when rawData is set to PrimerCardData

Properties

The card number set on rawData that triggered the metadata fetch

primerRawDataManager(_:didReceiveMetadata:forState:)

Called when new validation metadata relating to the current validation state is received. This will always be called some time after primerRawDataManager(_:willFetchMetadataForState:) is called.

Use this method to query new validation metadata, add informational UI, or allow the user to add additional payment information required to make a payment.

123func primerRawDataManager(_ rawDataManager: PrimerHeadlessUniversalCheckout.RawDataManager,                          didReceiveMetadata metadata: PrimerPaymentMethodMetadata,                          forState state: PrimerValidationState)

swift

copy

Parameters

The instance of the raw data manager calling this delegate method.

An object containing metadata for the relevant state also returned with this method.

Implementations

class PrimerCardNumberEntryState

Used when rawData is set to PrimerCardData

Properties

The card number set on rawData that triggered the metadata fetch

An object containing the state that triggered the metadata fetch. For example, for card number entry, this will be an instance of PrimerCardNumberEntryState

Implementations

class PrimerCardNumberEntryMetadata

Card network metadata including selectable card networks and detected card networks.

Properties

Enum value indicating the source of the validation.

cases

Indicates that remote validation occurred using Primer APIs.

Indicates that remote validation was attempted but could not be completed, causing a fallback to local validation.

Indicates that the validation occurred locally, usually leveraging the first few digits of the card number.

Card networks for the given card number that can be selected by the user prior to payment. This will be null in the case that a network is co-badged, or we are unable to remotely validate the given card number.

Properties

Represents a card network and includes metadata about that network relative to a specific card BIN.

An enum value for the card network (e.g. .visa, .mastercard)

The human-readable name of the card network (e.g., Visa, Mastercard).

A boolean indicating whether this card network is allowed.

The preferred card network. Use this to pre-select a network if there are multiple.

An enum value for the card network (e.g. .visa, .mastercard)

The human-readable name of the card network (e.g., Visa, Mastercard).

A boolean indicating whether this card network is allowed.

All detected card networks for the given card number. This will include networks even if they are not merchant-supported.

Properties

Represents a card network and includes metadata about that network relative to a specific card BIN.

An enum value for the card network (e.g. .visa, .mastercard)

The human-readable name of the card network (e.g., Visa, Mastercard).

A boolean indicating whether this card network is allowed.

The preferred card network. Use this to pre-select a network if there are multiple.

An enum value for the card network (e.g. .visa, .mastercard)

The human-readable name of the card network (e.g., Visa, Mastercard).

A boolean indicating whether this card network is allowed.

primerRawDataManager(_:metadataDidChange:)

⚠️

This method is deprecated. Please use primerRawDataManager(_:willFetchMetadataForState:) and primerRawDataManager(_:didReceiveMetadata:forState:).

Returns validation metadata for the current validation state, triggered by using rawData. Check the section below for the metadata types that can be returned.

1func primerRawDataManager(_ rawDataManager: PrimerHeadlessUniversalCheckout.RawDataManager, metadataDidChange metadata: [String: Any]?)

swift

copy

Parameters

The instance of the raw data manager calling this delegate method.

The metadata associated