---
title: externalPurchaseToken
framework: appstoreservernotifications
role: symbol
role_heading: Object
path: appstoreservernotifications/externalpurchasetoken
---

# externalPurchaseToken

The payload data that contains an external purchase token.

## Declaration

```data
object externalPurchaseToken
```

## Properties

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: The UNIX time, in milliseconds, when the system created the token. appAppleId: The app Apple ID for which the system generated the token. bundleId: The bundle ID of the app for which the system generated the token. tokenExpirationDate: The UNIX time, in milliseconds, when a token expires. This field is present only for custom link tokens. tokenType: The custom link token type, either SERVICES or ACQUISITION. This field is present only for custom link tokens.

## Mentioned in

App Store Server Notifications changelog Receiving App Store Server Notifications

## Discussion

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.

## Topics

### External purchase token fields

- [externalPurchaseId](appstoreservernotifications/externalpurchaseid.md)
- [tokenCreationDate](appstoreservernotifications/tokencreationdate.md)
- [tokenExpirationDate](appstoreservernotifications/tokenexpirationdate.md)
- [tokenType](appstoreservernotifications/tokentype.md)