JavaScript
Checkout Intents
Purchase product
Create a checkout intent and immediately trigger the purchase workflow.
This is a “fire-and-forget” endpoint that combines create + confirm in one step. The workflow handles offer retrieval, payment authorization, and order placement asynchronously. Poll the GET endpoint to check status.
POST
JavaScript
Authorizations
Rye API key
Body
application/json
The request body containing the checkout intent purchase parameters
Required range:
x >= 0Example:
1
Example:
"https://www.amazon.com/dp/B0DFC9MT8Q"
- Stripe
- Basis Theory
- Nekuda
- Prava
- Drawdown
- X402
Maximum array length:
16Promo code string with validation constraints.
- Must contain only letters, digits, underscores, or hyphens
- Maximum length of 32 characters
Maximum string length:
32Pattern:
^[a-zA-Z0-9_\-]+$Response
Created
- Retrieving Offer
- Awaiting Confirmation
- Requires Action
- Placing Order
- Completed
- Failed
Required range:
x >= 0Available options:
retrieving_offer Promo code string with validation constraints.
- Must contain only letters, digits, underscores, or hyphens
- Maximum length of 32 characters
Maximum string length:
32Pattern:
^[a-zA-Z0-9_\-]+$
