Use this page with AI
Copy this into your coding assistant and add your request.
Read https://openiap.dev/docs/types/verify-purchase-with-provider-props and https://openiap.dev/llms.txt. Follow the reading instructions, detailed reference, and linked guides relevant to my task before making changes.
Inspect my existing project and reuse its framework and conventions. Ask me for missing product decisions. Implement the requested behavior and run the applicable checks.
Show the working result, the commands and actual test results, and any remaining limitations. Keep your explanation brief.
My request: [describe what customers should be able to do]VerifyPurchaseWithProviderProps
VerifyPurchaseWithProviderProps#
Input type for verifyPurchaseWithProvider() - used to verify purchases through external providers like IAPKit.
Input to verifyPurchaseWithProvider — pick a managed validator. The PurchaseVerificationProvider enum currently exposes only IAPKit (open source under MIT — source at packages/kit). See Validation docs.
| Name | Type | Summary |
|---|---|---|
provider | PurchaseVerificationProvider | The verification provider to use. Currently only 'iapkit' is supported. |
iapkit | RequestVerifyPurchaseWithIapkitProps? | IAPKit-specific verification parameters. |
RequestVerifyPurchaseWithIapkitProps#
Parameters for IAPKit verification. Product client payload enrichment is opt-in, so existing integrations keep the same response shape and bandwidth by default.
| Name | Type | Summary |
|---|---|---|
apiKey | string? | API key used for the Authorization header (Bearer {apiKey}). |
baseUrl | string? | Available in OpenIAP 2.3.1 / openiap-apple 2.4.0 / openiap-google 2.4.0. IAPKit server origin. Defaults to https://kit.openiap.dev; set it to a reachable HTTP(S) origin for self-hosted or local IAPKit verification. The apiKey must be issued by the same IAPKit/Convex deployment that this origin uses. |
includeClientPayload | boolean? | Defaults to false. When true, a valid Apple or Google verification may include the public product clientPayload stored in IAPKit. Invalid receipts, products without an active catalog row, removed products, products without a payload, and Horizon or Amazon responses omit it. |
apple | RequestVerifyPurchaseWithIapkitAppleProps? | Apple/iOS verification parameters. |
google | RequestVerifyPurchaseWithIapkitGoogleProps? | Google/Android verification parameters. |
amazon | RequestVerifyPurchaseWithIapkitAmazonProps? | Amazon Appstore verification parameters for Fire OS and Vega OS purchase receipts. |
See the IapkitProductClientPayload result shape and the IAPKit product client payload guide.
RequestVerifyPurchaseWithIapkitAppleProps#
| Name | Type | Summary |
|---|---|---|
jws | string | The JWS token returned with the purchase response. |
RequestVerifyPurchaseWithIapkitGoogleProps#
| Name | Type | Summary |
|---|---|---|
purchaseToken | string | The token provided to the user's device when the product or subscription was purchased. |
RequestVerifyPurchaseWithIapkitAmazonProps#
Amazon Appstore receipt verification parameters. Fire OS and Vega OS both use this amazon payload when verifying through IAPKit. Amazon App Tester receipts also require the project-level Allow Amazon App Tester / RVS Cloud Sandbox opt-in.
| Name | Type | Summary |
|---|---|---|
expectedProductId | string? | Available in OpenIAP 3.2.0 / openiap-apple 3.2.0 / openiap-google 3.3.0. Optional product ID that must exactly match the product ID returned by Amazon RVS. |
userId | string? | Amazon Appstore user id returned by PurchaseResponse.getUserData().getUserId(). |
receiptId | string | Amazon Appstore receipt id returned by PurchaseResponse.getReceipt().getReceiptId(). |
sandbox | boolean? | Use Amazon RVS Cloud Sandbox for Amazon App Tester receipts. The IAPKit project opt-in is disabled by default. |