Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Rye API key

Query Parameters

limit
integer<int32>

Maximum number of results to return (default 100)

Required range: 1 <= x <= 100
after
string
before
string
id
string[]
state
enum<string>[]
Available options:
completed,
failed,
retrieving_offer,
awaiting_confirmation,
requires_action,
placing_order

Response

Paginated checkout intents response

pageInfo
object
required
data
(Retrieving Offer · object | Awaiting Confirmation · object | Requires Action · object | Placing Order · object | Completed · object | Failed · object)[]
required