/walletobjects/v1/giftCardObject

POST

giftcardobject

Inserts an gift card object with the given ID and properties.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://walletobjects.googleapis.com//walletobjects/v1/giftCardObject' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

Request

Body Params application/json

appLinkData

object (AppLinkData)

optional

Optional information about the partner app link.

androidAppLinkInfo

object (AppLinkDataAppLinkInfo)

optional

Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.

iosAppLinkInfo

object (AppLinkDataAppLinkInfo)

optional

Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the ios client.

webAppLinkInfo

object (AppLinkDataAppLinkInfo)

optional

Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.

balance

object (Money)

optional

The card's monetary balance.

currencyCode

string

optional

The currency code, such as "USD" or "EUR."

kind

string

optional

Identifies what kind of resource this is. Value: the fixed string "walletobjects#money".

micros

string <int64>

optional

The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.

balanceUpdateTime

object (DateTime)

optional

The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.

date

string

optional

An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: 1985-04-12T23:20:50.52Z would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. 1985-04-12T19:20:50.52-04:00 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. 1985-04-12T19:20:50.52 would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of 2018-06-19T18:30:00-04:00 will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of 2018-06-19T18:30:00 will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones.

barcode

object (Barcode)

optional

The barcode type and value.

alternateText

string

optional

An optional text that will override the default text that shows under the barcode. This field is intended for a human readable equivalent of the barcode value, used when the barcode cannot be scanned.

kind

string

optional

Identifies what kind of resource this is. Value: the fixed string "walletobjects#barcode".

renderEncoding

enum<string>

optional

The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.

Allowed values:

RENDER_ENCODING_UNSPECIFIEDUTF_8

showCodeText

object (LocalizedString)

optional

Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.

type

enum<string>

optional

The type of barcode.

Allowed values:

BARCODE_TYPE_UNSPECIFIEDAZTECaztecCODE_39code39CODE_128code128CODABARcodabarDATA_MATRIXdataMatrixEAN_8ean8EAN_13ean13EAN13ITF_14itf14PDF_417pdf417PDF417QR_CODEqrCodeqrcodeUPC_AupcATEXT_ONLYtextOnly

value

string

optional

The value encoded in the barcode.

cardNumber

string

optional

Required. The card's number.

classId

string

optional

Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you.

classReference

object (GiftCardClass)

optional

A copy of the inherited fields of the parent class. These fields are retrieved during a GET.

allowBarcodeRedemption

boolean

optional

Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.

allowMultipleUsersPerObject

boolean

optional

Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.

callbackOptions

object (CallbackOptions)

optional

Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.

cardNumberLabel

string

optional

The label to display for the card number, such as "Card Number".

classTemplateInfo

object (ClassTemplateInfo)

optional

Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.

countryCode

string

optional

Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.

enableSmartTap

boolean

optional

Available only to Smart Tap enabled partners. Contact support for additional guidance.

eventNumberLabel

string

optional

The label to display for event number, such as "Target Event #".

heroImage

object (Image)

optional

Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.

hexBackgroundColor

string

optional

The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #rrggbb where rrggbb is a hex RGB triplet, such as #ffcc00. You can also use the shorthand version of the RGB triplet which is #rgb, such as #fc0.

homepageUri

object (Uri)

optional

The URI of your application's home page. Populating the URI in this field results in the exact same behavior as populating an URI in linksModuleData (when an object is rendered, a link to the homepage is shown in what would usually be thought of as the linksModuleData section of the object).

string

optional

Required. The unique identifier for a class. This ID must be unique across all classes from an issuer. This value should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.

imageModulesData

array[object (ImageModuleData) {2}]

optional

Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.

infoModuleData

object (InfoModuleData)

optional

Deprecated. Use textModulesData instead.

issuerName

string

optional

Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.

kind

string

optional

Identifies what kind of resource this is. Value: the fixed string "walletobjects#giftCardClass".

linksModuleData

object (LinksModuleData)

optional

Links module data. If links module data is also defined on the object, both will be displayed.

localizedCardNumberLabel

object (LocalizedString)

optional

Translated strings for the card_number_label.

localizedEventNumberLabel

object (LocalizedString)

optional

Translated strings for the event_number_label.

localizedIssuerName

object (LocalizedString)

optional

Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.

localizedMerchantName

object (LocalizedString)

optional

Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.

localizedPinLabel

object (LocalizedString)

optional

Translated strings for the pin_label.

locations

array[object (LatLongPoint) {3}]

optional

The list of locations where the object can be used. The platform uses this information to trigger geolocated notifications to users. Note that locations in the object override locations in the class which override locations in the Google Places ID.

merchantName

string

optional

Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.

messages

array[object (Message) {8}]

optional

An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.

multipleDevicesAndHoldersAllowedStatus

enum<string>

optional

Identifies whether multiple users and devices will save the same object referencing this class.

Allowed values:

STATUS_UNSPECIFIEDMULTIPLE_HOLDERSmultipleHoldersONE_USER_ALL_DEVICESoneUserAllDevicesONE_USER_ONE_DEVICEoneUserOneDevice

pinLabel

string

optional

The label to display for the PIN, such as "4-digit PIN".

programLogo

object (Image)

optional

The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.

redemptionIssuers

array[string <int64>]

optional

Available only to Smart Tap enabled partners. Contact support for additional guidance.

review

object (Review)

optional

The review comments set by the platform when a class is marked approved or rejected.

reviewStatus

enum<string>

optional

Required. The status of the class. This field can be set to draft or underReview using the insert, patch, or update API calls. Once the review state is changed from draft it may not be changed back to draft. You should keep this field to draft when the class is under development. A draft class cannot be used to create any object. You should set this field to underReview when you believe the class is ready for use. The platform will automatically set this field to approved and it can be immediately used to create or migrate objects. When updating an already approved class you should keep setting this field to underReview.

Allowed values:

REVIEW_STATUS_UNSPECIFIEDUNDER_REVIEWunderReviewAPPROVEDapprovedREJECTEDrejectedDRAFTdraft

textModulesData

array[object (TextModuleData) {5}]

optional

Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.

version

string <int64>

optional

Deprecated

wordMark

object (Image)

optional

Deprecated.

disableExpirationNotification

boolean

optional

Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the messages field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for offers.

eventNumber

string

optional

The card's event number, an optional field used by some gift cards.

hasLinkedDevice

boolean

optional

Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information.

hasUsers

boolean

optional

Indicates if the object has users. This field is set by the platform.

heroImage

object (Image)

optional

Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed.

string

optional

Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.

imageModulesData

array[object (ImageModuleData) {2}]

optional

Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.

string

optional

The ID associated with an image module. This field is here to enable ease of management of image modules.

mainImage

object (Image)

optional

A 100% width image.

infoModuleData

object (InfoModuleData)

optional

Deprecated. Use textModulesData instead.

kind

string

optional

Identifies what kind of resource this is. Value: the fixed string "walletobjects#giftCardObject".

linksModuleData

object (LinksModuleData)

optional

Links module data. If links module data is also defined on the class, both will be displayed.

locations

array[object (LatLongPoint) {3}]

optional

kind

string

optional

Identifies what kind of resource this is. Value: the fixed string "walletobjects#latLongPoint".

latitude

number <double>

optional

The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.

longitude

number <double>

optional

The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.

messages

array[object (Message) {8}]

optional

An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.

body

string

optional

The message body.

displayInterval

object (TimeInterval)

optional

The period of time that the message will be displayed to users. You can define both a startTime and endTime for each message. A message is displayed immediately after a Wallet Object is inserted unless a startTime is set. The message will appear in a list of messages indefinitely if endTime is not provided.

header

string

optional

The message header.

string

optional

The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.

kind

string

optional

Identifies what kind of resource this is. Value: the fixed string "walletobjects#walletObjectMessage".

localizedBody

object (LocalizedString)

optional

Translated strings for the message body.

localizedHeader

object (LocalizedString)

optional

Translated strings for the message header.

messageType

enum<string>

optional

The type of the message. Currently, this can only be set for offers.

Allowed values:

MESSAGE_TYPE_UNSPECIFIEDTEXTtextEXPIRATION_NOTIFICATIONexpirationNotification

string

optional

The card's PIN.

smartTapRedemptionValue

string

optional

Available only to Smart Tap enabled partners. Contact support for additional guidance.

state

enum<string>

optional

Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an inactive object is moved to the "Expired passes" section.

Allowed values:

STATE_UNSPECIFIEDACTIVEactiveCOMPLETEDcompletedEXPIREDexpiredINACTIVEinactive

textModulesData

array[object (TextModuleData) {5}]

optional

Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.

body

string

optional

The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.

header

string

optional

The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.

string

optional

The ID associated with a text module. This field is here to enable ease of management of text modules.

localizedBody

object (LocalizedString)

optional

Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.

localizedHeader

object (LocalizedString)

optional

Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.

validTimeInterval

object (TimeInterval)

optional

The time period this object will be active and object can be used. An object's state will be changed to expired when this time period has passed.

version

string <int64>

optional

Deprecated

Examples

Responses

🟢200Successful response

application/json

Body

appLinkData

object (AppLinkData)

optional

Optional information about the partner app link.

androidAppLinkInfo

object (AppLinkDataAppLinkInfo)

optional

Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the android client.

iosAppLinkInfo

object (AppLinkDataAppLinkInfo)

optional

Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the ios client.

webAppLinkInfo

object (AppLinkDataAppLinkInfo)

optional

Optional information about the partner app link. If included, the app link link module will be rendered on the valuable details on the web client.

balance

object (Money)

optional

The card's monetary balance.

currencyCode

string

optional

The currency code, such as "USD" or "EUR."

kind

string

optional

Identifies what kind of resource this is. Value: the fixed string "walletobjects#money".

micros

string <int64>

optional

The unit of money amount in micros. For example, $1 USD would be represented as 1000000 micros.

balanceUpdateTime

object (DateTime)

optional

The date and time when the balance was last updated. Offset is required. If balance is updated and this property is not provided, system will default to the current time.

date

string

optional

barcode

object (Barcode)

optional

The barcode type and value.

alternateText

string

optional

kind

string

optional

Identifies what kind of resource this is. Value: the fixed string "walletobjects#barcode".

renderEncoding

enum<string>

optional

The render encoding for the barcode. When specified, barcode is rendered in the given encoding. Otherwise best known encoding is chosen by Google.

Allowed values:

RENDER_ENCODING_UNSPECIFIEDUTF_8

showCodeText

object (LocalizedString)

optional

Optional text that will be shown when the barcode is hidden behind a click action. This happens in cases where a pass has Smart Tap enabled. If not specified, a default is chosen by Google.

type

enum<string>

optional

The type of barcode.

Allowed values:

BARCODE_TYPE_UNSPECIFIEDAZTECaztecCODE_39code39CODE_128code128CODABARcodabarDATA_MATRIXdataMatrixEAN_8ean8EAN_13ean13EAN13ITF_14itf14PDF_417pdf417PDF417QR_CODEqrCodeqrcodeUPC_AupcATEXT_ONLYtextOnly

value

string

optional

The value encoded in the barcode.

cardNumber

string

optional

Required. The card's number.

classId

string

optional

classReference

object (GiftCardClass)

optional

A copy of the inherited fields of the parent class. These fields are retrieved during a GET.

allowBarcodeRedemption

boolean

optional

Determines whether the merchant supports gift card redemption using barcode. If true, app displays a barcode for the gift card on the Gift card details screen. If false, a barcode is not displayed.

allowMultipleUsersPerObject

boolean

optional

Deprecated. Use multipleDevicesAndHoldersAllowedStatus instead.

callbackOptions

object (CallbackOptions)

optional

Callback options to be used to call the issuer back for every save/delete of an object for this class by the end-user. All objects of this class are eligible for the callback.

cardNumberLabel

string

optional

The label to display for the card number, such as "Card Number".

classTemplateInfo

object (ClassTemplateInfo)

optional

Template information about how the class should be displayed. If unset, Google will fallback to a default set of fields to display.

countryCode

string

optional

Country code used to display the card's country (when the user is not in that country), as well as to display localized content when content is not available in the user's locale.

enableSmartTap

boolean

optional

Available only to Smart Tap enabled partners. Contact support for additional guidance.

eventNumberLabel

string

optional

The label to display for event number, such as "Target Event #".

heroImage

object (Image)

optional

Optional banner image displayed on the front of the card. If none is present, nothing will be displayed. The image will display at 100% width.

hexBackgroundColor

string

optional

homepageUri

object (Uri)

optional

string

optional

imageModulesData

array[object (ImageModuleData) {2}]

optional

Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.

infoModuleData

object (InfoModuleData)

optional

Deprecated. Use textModulesData instead.

issuerName

string

optional

Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.

kind

string

optional

Identifies what kind of resource this is. Value: the fixed string "walletobjects#giftCardClass".

linksModuleData

object (LinksModuleData)

optional

Links module data. If links module data is also defined on the object, both will be displayed.

localizedCardNumberLabel

object (LocalizedString)

optional

Translated strings for the card_number_label.

localizedEventNumberLabel

object (LocalizedString)

optional

Translated strings for the event_number_label.

localizedIssuerName

object (LocalizedString)

optional

Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.

localizedMerchantName

object (LocalizedString)

optional

Translated strings for the merchant_name. The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.

localizedPinLabel

object (LocalizedString)

optional

Translated strings for the pin_label.

locations

array[object (LatLongPoint) {3}]

optional

merchantName

string

optional

Merchant name, such as "Adam's Apparel". The app may display an ellipsis after the first 20 characters to ensure full string is displayed on smaller screens.

messages

array[object (Message) {8}]

optional

An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.

multipleDevicesAndHoldersAllowedStatus

enum<string>

optional

Identifies whether multiple users and devices will save the same object referencing this class.

Allowed values:

STATUS_UNSPECIFIEDMULTIPLE_HOLDERSmultipleHoldersONE_USER_ALL_DEVICESoneUserAllDevicesONE_USER_ONE_DEVICEoneUserOneDevice

pinLabel

string

optional

The label to display for the PIN, such as "4-digit PIN".

programLogo

object (Image)

optional

The logo of the gift card program or company. This logo is displayed in both the details and list views of the app.

redemptionIssuers

array[string <int64>]

optional

Available only to Smart Tap enabled partners. Contact support for additional guidance.

review

object (Review)

optional

The review comments set by the platform when a class is marked approved or rejected.

reviewStatus

enum<string>

optional

Allowed values:

REVIEW_STATUS_UNSPECIFIEDUNDER_REVIEWunderReviewAPPROVEDapprovedREJECTEDrejectedDRAFTdraft

textModulesData

array[object (TextModuleData) {5}]

optional

Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.

version

string <int64>

optional

Deprecated

wordMark

object (Image)

optional

Deprecated.

disableExpirationNotification

boolean

optional

eventNumber

string

optional

The card's event number, an optional field used by some gift cards.

hasLinkedDevice

boolean

optional

hasUsers

boolean

optional

Indicates if the object has users. This field is set by the platform.

heroImage

object (Image)

optional

string

optional

imageModulesData

array[object (ImageModuleData) {2}]

optional

Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.

string

optional

The ID associated with an image module. This field is here to enable ease of management of image modules.

mainImage

object (Image)

optional

A 100% width image.

infoModuleData

object (InfoModuleData)

optional

Deprecated. Use textModulesData instead.

kind

string

optional

Identifies what kind of resource this is. Value: the fixed string "walletobjects#giftCardObject".

linksModuleData

object (LinksModuleData)

optional

Links module data. If links module data is also defined on the class, both will be displayed.

locations

array[object (LatLongPoint) {3}]

optional

kind

string

optional

Identifies what kind of resource this is. Value: the fixed string "walletobjects#latLongPoint".

latitude

number <double>

optional

The latitude specified as any value in the range of -90.0 through +90.0, both inclusive. Values outside these bounds will be rejected.

longitude

number <double>

optional

The longitude specified in the range -180.0 through +180.0, both inclusive. Values outside these bounds will be rejected.

messages

array[object (Message) {8}]

optional

An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.

body

string

optional

The message body.

displayInterval

object (TimeInterval)

optional

header

string

optional

The message header.

string

optional

kind

string

optional

Identifies what kind of resource this is. Value: the fixed string "walletobjects#walletObjectMessage".

localizedBody

object (LocalizedString)

optional

Translated strings for the message body.

localizedHeader

object (LocalizedString)

optional

Translated strings for the message header.

messageType

enum<string>

optional

The type of the message. Currently, this can only be set for offers.

Allowed values:

MESSAGE_TYPE_UNSPECIFIEDTEXTtextEXPIRATION_NOTIFICATIONexpirationNotification

string

optional

The card's PIN.

smartTapRedemptionValue

string

optional

Available only to Smart Tap enabled partners. Contact support for additional guidance.

state

enum<string>

optional

Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an inactive object is moved to the "Expired passes" section.

Allowed values:

STATE_UNSPECIFIEDACTIVEactiveCOMPLETEDcompletedEXPIREDexpiredINACTIVEinactive

textModulesData

array[object (TextModuleData) {5}]

optional

Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class.

body

string

optional

The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.

header

string

optional

The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.

string

optional

The ID associated with a text module. This field is here to enable ease of management of text modules.

localizedBody

object (LocalizedString)

optional

Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.

localizedHeader

object (LocalizedString)

optional

Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.

validTimeInterval

object (TimeInterval)

optional

The time period this object will be active and object can be used. An object's state will be changed to expired when this time period has passed.

version

string <int64>

optional

Deprecated

Modified at 2022-09-10 16:56:46

/walletobjects/v1/giftCardObject

/walletobjects/v1/giftCardObject/{resourceId}