SCPLocation

Objective-C


@interface SCPLocation : NSObject <SCPJSONDecodable>

Swift

class Location : NSObject, JSONDecodable

A Location is used to group readers in the Stripe Terminal ecosystem. The Location to which a reader is registered can control regional behavior for that particular reader.

You cannot create locations through the SDK. Instead, use the Stripe API from your backend to manage your account’s locations.

To fetch the Location objects associated with your account, call Terminal.shared.listLocations().

See

https://stripe.com/docs/api/terminal/locations

  • The ID of the Location

    Declaration

    Objective-C

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

    Swift

    var stripeId: String { get }

  • The address of this Location

    See

    SCPAddress

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) SCPAddress *address;

    Swift

    var address: SCPAddress? { get }

  • The Kanji variation address of this Location (Japan only)

    See

    SCPAddress

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) SCPAddress *addressKanji;

    Swift

    var addressKanji: SCPAddress? { get }

  • The Kana variation address of this Location (Japan only)

    See

    SCPAddress

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) SCPAddress *addressKana;

    Swift

    var addressKana: SCPAddress? { get }

  • The display name of this Location

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *displayName;

    Swift

    var displayName: String? { get }

  • The Kanji variation variation display name of this Location (Japan only)

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *displayNameKanji;

    Swift

    var displayNameKanji: String? { get }

  • The Kana variation display name of this Location (Japan only)

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *displayNameKana;

    Swift

    var displayNameKana: String? { get }

  • The phone number of this Location

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *phone;

    Swift

    var phone: String? { get }

  • Whether this Location was created in livemode

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL livemode;

    Swift

    var livemode: Bool { get }

  • Any metadata attached to this Location

    See

    https://stripe.com/docs/api/terminal/locations/create#create_terminal_location-metadata

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSDictionary<NSString *, NSString *> *metadata;

    Swift

    var metadata: [String : String]? { get }

  • Unavailable

    You cannot directly instantiate this class.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Unavailable

    You cannot directly instantiate this class.

    Declaration

    Objective-C

    + (nonnull instancetype)new;