• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
LoyaltyAccountMapping BETA

Represents the mapping that associates a loyalty account with a buyer.

Currently, a loyalty account can only be mapped to a buyer by phone number. For more information, see Loyalty Overview.

Properties

Name Description
id
string

Read only The Square-assigned ID of the mapping.

Max Length 36
type
string

The mapping type, which is used with value to represent a phone number mapping.

When specifying a mapping, the phone_number field is preferred to using type and value.

value
string

The mapping value, which is used with type to represent a phone number mapping. The value can be a phone number in E.164 format. For example, "+14155551111".

When specifying a mapping, the phone_number field is preferred to using type and value.

created_at
string

Read only The timestamp when the mapping was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

phone_number
string

The phone number of the buyer, in E.164 format. For example, "+14155551111".

When specifying a mapping, this phone_number field is preferred to using type and value.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?