Get Refund History V1
Get a list of up to 50 of a customer’s refunded in-app purchases for your app.
URL
GET https://api.storekit.apple.com/inApps/v1/refund/lookup/{originalTransactionId}Sandbox URL
GET https://api.storekit-sandbox.apple.com/inApps/v1/refund/lookup/{originalTransactionId}Path Parameters
| Name | Type | Description |
|---|---|---|
originalTransactionId Required | originalTransactionId | The original transaction identifier for a transaction that belongs to the customer. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | RefundLookupResponse | Request succeeded. |
| 400 | Bad Request Content-Type: application/json | InvalidOriginalTransactionIdError | The request is invalid. Check the specific error message for further information. |
| 401 | Unauthorized | The JSON Web Token (JWT) in the authorization header is invalid. For more information, see Generating JSON Web Tokens for API requests. | |
| 404 | Not Found Content-Type: application/json | OriginalTransactionIdNotFoundError | The request is invalid. Check the specific error message for further information. |
| 429 | Content-Type: application/json | RateLimitExceededError | |
| 500 | Internal Server Error Content-Type: application/json | (GeneralInternalError | GeneralInternalRetryableError) | The request failed. This may be due to a temporary outage. Check the specific error message for further information. |
Mentioned in
Discussion
Call this endpoint to get a customer’s refund history for your app. The response (RefundLookupResponse) includes up to 50 of the customer’s most-recently refunded transactions, based on the revocationDate.
To call this endpoint, provide any original transaction identifier (originalID) for any of the customer’s in-app purchases. The response only includes App Store-approved refunds for any product type: consumable, non-consumable, auto-renewable subscriptions, and non-renewing subscriptions. For more information about product types, see In-app purchase.
The information in the response is the same as the information in one or more REFUND notifications (notificationType) from App Store Server Notifications. Use this API to retrieve any refund notifications you may have missed, such as during a server outage.
A successful response may have an empty signedTransactions array if the customer hasn’t received any App Store-approved refunds. To identify the date and reason code for a refund, see revocationDate and revocationReason in the JWSTransactionDecodedPayload.
The App Store Server API returns information based on the customer’s in-app purchase history regardless of whether the customer installs, removes, or reinstalls the app on their devices.