Called when we begin to fetch metadata for the 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.
The instance of the raw data manager calling this delegate method.
PrimerValidationState
An object containing the state that triggered the metadata fetch. For example, for
card number entry, this will be an instance of PrimerCardNumberEntryState
Hide Implementations
Used when rawData is set to PrimerCardData
Hide Properties
String
required
The card number set on rawData that triggered the metadata fetch
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.
The instance of the raw data manager calling this delegate method.
PrimerPaymentMethodMetadata
An object containing metadata for the relevant state also returned with this method.
Hide Implementations
Used when rawData is set to PrimerCardData
Hide Properties
String
required
The card number set on rawData that triggered the metadata fetch
PrimerValidationState
An object containing the state that triggered the metadata fetch. For example, for
card number entry, this will be an instance of PrimerCardNumberEntryState
Hide Implementations
Card network metadata including selectable card networks and detected card
networks.
Hide Properties
PrimerCardValidationSource
required
Enum value indicating the source of the validation.
Hide 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.
PrimerCardNetworksMetadata?
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.
Show Properties
[PrimerCardNetwork]
required
Show Element
PrimerCardNetwork
Represents a card network and includes metadata about that network relative to
a specific card BIN.
Hide child attributes
CardNetwork
required
An enum value for the card network (e.g. .visa, .mastercard)
String
required
The human-readable name of the card network (e.g., Visa, Mastercard).
Bool
required
A boolean indicating whether this card network is allowed.
PrimerCardNetwork?
The preferred card network. Use this to pre-select a network if there are multiple.
Hide child attributes
CardNetwork
required
An enum value for the card network (e.g. .visa, .mastercard)
String
required
The human-readable name of the card network (e.g., Visa, Mastercard).
Bool
required
A boolean indicating whether this card network is allowed.
PrimerCardNetworksMetadata
All detected card networks for the given card number. This will include
networks even if they are not merchant-supported.
Show Properties
[PrimerCardNetwork]
required
Show Element
PrimerCardNetwork
Represents a card network and includes metadata about that network relative to
a specific card BIN.
Hide child attributes
CardNetwork
required
An enum value for the card network (e.g. .visa, .mastercard)
String
required
The human-readable name of the card network (e.g., Visa, Mastercard).
Bool
required
A boolean indicating whether this card network is allowed.
PrimerCardNetwork?
The preferred card network. Use this to pre-select a network if there are multiple.
Hide child attributes
CardNetwork
required
An enum value for the card network (e.g. .visa, .mastercard)
String
required
The human-readable name of the card network (e.g., Visa, Mastercard).
Bool
required
A boolean indicating whether this card network is allowed.
primerRawDataManager(_:didReceiveBinData:)
Called when the SDK detects BIN data from the card number entered by the user.
This callback provides detailed information about the card including issuer details and card attributes.
It delivers BIN data independently from the metadata state callbacks and has a default no-op implementation, so overriding it is optional.
The instance of the raw data manager calling this delegate method.
PrimerBinData
Hide Properties
PrimerCardNetwork?
The recommended card network to use, based on the order specified in orderedAllowedCardNetworks in the Client Session. nil if no network is allowed or data is not yet resolved.
Show PrimerCardNetwork Properties
CardNetwork
required
An enum value for the card network (e.g. .visa, .mastercard).
String
required
A human-readable name for the card network (e.g., “Visa”, “Mastercard”).
String?
The ISO 3166-1 alpha-2 country code of the card issuer.
String?
The name of the card issuer (e.g., bank name).
String?
The type of account funding (e.g., “CREDIT”, “DEBIT”, “PREPAID”).
String?
Indicates whether a prepaid card is reloadable.
String?
The usage type of the card product (e.g., “CONSUMER”, “BUSINESS”, “GOVERNMENT”).
String?
The product code assigned by the card network.
String?
The product name assigned by the card network (e.g., “Visa Signature”).
String?
The ISO 4217 currency code associated with the card issuer.
String?
Regional restrictions that apply to the card.
String?
The type of account number (e.g., “PAN”, “TOKEN”).
[PrimerCardNetwork]
required
All detected card networks, including ones that are not allowed. For co-badged cards, this list contains multiple networks. Each element has the same properties as preferred above.
PrimerBinDataStatus
required
The status of the BIN data retrieval.
Hide Cases
This happens when 8 digits or more are entered in the card number field. The SDK retrieved the BIN data using Primer’s BIN data service, providing the most accurate information including issuer details.
This happens when fewer than 8 digits are entered in the card number field, or when the SDK fails to contact Primer’s BIN data service. The SDK retrieved the card networks using static information bundled with the SDK. This can only identify international card networks and does not include issuer details.
String?
The first digits (BIN prefix) of the card number, when available.
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.