BTClientMetadata

Objective-C

@interface BTClientMetadata : NSObject <NSCopying, NSMutableCopying>

Swift

class BTClientMetadata : NSObject, NSCopying, NSMutableCopying

Represents the metadata associated with a session for posting along with payment data during tokenization

When a payment method is tokenized, the client api accepts parameters under _meta which are used to determine where payment data originated.

In general, this data may evolve and be used in different ways by different integrations in a single app. For example, if both Apple Pay and drop in are used. In this case, the source and integration may change over time, while the sessionID should remain constant. To achieve this, users of this class should use mutableCopy to create a new copy based on the existing session and then update the object as needed.

Show on GitHub

Derived Properties

  • String representation of the integration

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull integrationString;

    Swift

    var integrationString: String { get }
    Show on GitHub

  • String representation of the source

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull sourceString;

    Swift

    var sourceString: String { get }
    Show on GitHub

  • Additional metadata parameters

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSDictionary *_Nonnull parameters;

    Swift

    var parameters: [AnyHashable : Any] { get }
    Show on GitHub