# External Purchase Server API Send and manage reports you send to Apple for tokens you receive when your app provides external purchases for digital goods and services. ## Overview Call this REST API from your server to report external purchase tokens and your customers’ transactions related to the tokens. Use this API if your app uses API and provides alternative payment options for digital goods and services, using any of the following: - *Payment Service Providers (PSP)*: An alternative payment processor that lets customers complete transactions within your app. - *Linking out to purchase*: Directing customers to complete a transaction for digital goods and services on your external website, or a distribution channel of your choice. Report all tokens, including those that didn’t result in a transaction, and report the transactions associated with the tokens. For more information on the reporting requirements, including scope and report timing expectations, see the [Commission, transaction reports, and payments](https://developer.apple.com/support/apps-using-alternative-payment-providers-in-the-eu#commission-reports-and-payments) section of the article Using alternative payment options on the App Store in the European Union. ### Authorize your API calls Calls to the API require JSON Web Tokens (JWTs) for authorization. Get keys to create JWTs from your organization’s App Store Connect account. See to create your keys. See to generate tokens using your keys, and send API requests. ### Report external purchase tokens and transactions When customers initiate an external purchase, your app or website receives a token. You need to report the token and the transactions associated with the token. For more information on how you receive tokens, see . To send a report, call the [`Send External Purchase Report`](/documentation/ExternalPurchaseServerAPI/Send-External-Purchase-Report) endpoint for each token. Send reports in all of the following cases: - To report a token, with line items, when a customer completes one or more transactions. - To report a token, without line items, when a customer doesn’t complete any transactions. - To report an unrecognized token, when you receive an App Store Server Notification about a token that you don’t have recorded in your system. - To report duplicate `ACQUISITION` and `SERVICES` tokens. For more information, see [Reporting tokens with transactions](/documentation/ExternalPurchaseServerAPI/reportwithtransactions) and [Reporting unrecognized and transactionless tokens](/documentation/ExternalPurchaseServerAPI/reportwithouttransactions). If you successfully send a report that you later find to be incorrect, you need to correct your submission. For more information, see [Reporting corrections](/documentation/ExternalPurchaseServerAPI/reportcorrections). ### Retrieve reports Call the [`Retrieve External Purchase Report`](/documentation/ExternalPurchaseServerAPI/Retrieve-External-Purchase-Report) endpoint to get reports you previously sent to Apple. Specify which report to retrieve by using the same `requestIdentifier` value that you provide when you send the report. ### Receive notifications for unreported tokens The App Store server sends an `EXTERNAL_PURCHASE_TOKEN` to your endpoint in the following cases: - To indicate unreported tokens, using the UNREPORTED subtype - To remind you of active custom link tokens, using the ACTIVE_TOKEN_REMINDER subtype. If you receive the `EXTERNAL_PURCHASE_TOKEN` notification, send a report for the token the notification specifies. To check for notifications you might have missed — for example, due to a server outage — send a request to the endpoint to get a list of notifications that App Store Server Notifications attempted to send to your server. For more information on notifications, see . Configure the endpoint on your server to receive version 2 notifications. ### Test using the sandbox environment When you test your app in the sandbox environment, the API returns tokens that are valid only in that environment. These tokens have an `externalPurchaseId` that starts with the string “`SANDBOX`”. To test your server’s token reporting implementation, send reports for sandbox tokens to the Sandbox URL of the [`Send External Purchase Report`](/documentation/ExternalPurchaseServerAPI/Send-External-Purchase-Report) endpoint. > Important: External purchase tokens generated in the sandbox environment are for testing only. The sandbox tokens and any test transaction data you submit through the sandbox URLs of the External Purchase Server API are not actual transactions. ## Topics ### Essentials [External Purchase Server API changelog](/documentation/ExternalPurchaseServerAPI/changelog) Learn about new features and updates in the External Purchase Server API. ### External purchase tokens ### External purchase reporting [`Send External Purchase Report`](/documentation/ExternalPurchaseServerAPI/Send-External-Purchase-Report) Report required information about external purchase tokens and associated transactions. [`ExternalPurchaseReport`](/documentation/ExternalPurchaseServerAPI/ExternalPurchaseReport) The contents of an external purchase report for a single token. [`SendReportSuccessResponse`](/documentation/ExternalPurchaseServerAPI/SendReportSuccessResponse) A response that contains the request identifier and indicates the server successfully received your external purchase report. [`SendReportErrorResponse`](/documentation/ExternalPurchaseServerAPI/SendReportErrorResponse) An error response that indicates your external purchase report didn’t succeed, including error details for the line items in your report. ### External purchase report transactions [Reporting tokens with transactions](/documentation/ExternalPurchaseServerAPI/reportwithtransactions) Create reports for external purchase tokens that result in completed transactions, including one-time charges, subscriptions and renewals, and refunds. [Reporting corrections](/documentation/ExternalPurchaseServerAPI/reportcorrections) Submit a report with corrections if you find errors in, or have adjustments to, a successfully submitted transaction. [`OneTimeBuyLineItem`](/documentation/ExternalPurchaseServerAPI/OneTimeBuyLineItem) The line item that indicates a one-time charge transaction. [`RefundLineItem`](/documentation/ExternalPurchaseServerAPI/RefundLineItem) The line item that indicates a refund transaction. [`SubscriptionBuyLineItem`](/documentation/ExternalPurchaseServerAPI/SubscriptionBuyLineItem) The line item that indicates a subscription-related event or transaction. [Line item fields](/documentation/ExternalPurchaseServerAPI/lineitems) Properties that describe a single transaction or correction in an external purchase report. ### External purchase report without transactions [Reporting unrecognized and transactionless tokens](/documentation/ExternalPurchaseServerAPI/reportwithouttransactions) Create reports for external purchase tokens that didn’t result in completed transactions, duplicate tokens, or tokens that you learn of from an App Store server notification. ### External purchase report retrieval [`Retrieve External Purchase Report`](/documentation/ExternalPurchaseServerAPI/Retrieve-External-Purchase-Report) Get an external purchase report by providing its request identifier. [`RetrieveReportSuccessResponse`](/documentation/ExternalPurchaseServerAPI/RetrieveReportSuccessResponse) A response that indicates success and includes your external purchase report data. ### Error handling [Error messages and codes](/documentation/ExternalPurchaseServerAPI/errorcodes) Error messages and codes for reports and endpoints. --- Copyright © 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)