externalPurchaseToken
The payload data that contains an external purchase token.
Declaration
object externalPurchaseTokenProperties
| Name | Type | Description |
|---|---|---|
externalPurchaseId Required | externalPurchaseId | The unique identifier of the token. Use this value to report tokens and their associated transactions in the Send External Purchase Report endpoint. |
tokenCreationDate Required | tokenCreationDate | The UNIX time, in milliseconds, when the system created the token. |
appAppleId Required | appAppleId | The app Apple ID for which the system generated the token. |
bundleId Required | bundleId | The bundle ID of the app for which the system generated the token. |
tokenExpirationDate | tokenExpirationDate | The UNIX time, in milliseconds, when a token expires. This field is present only for custom link tokens. |
tokenType | tokenType | The custom link token type, either |
Mentioned in
Discussion
The externalPurchaseToken object is part of the responseBodyV2DecodedPayload. It’s present in the payload when the notificationType is EXTERNAL_PURCHASE_TOKEN. This notification type applies to apps that use the External Purchase API to offer alternative payment options.
The externalPurchaseToken object is the Base64URL-decoded JSON of the external purchase token your app or website receives when your customer initiates an external purchase. For more information on external purchase tokens, see Receiving and decoding external purchase tokens.
To report tokens with or without associated transactions, call the Send External Purchase Report endpoint of the External Purchase Server API from your server.