POST
/
api
/
v1
/
checkout-intents
Checkout Intent
curl --request POST \
  --url https://staging.api.rye.com/api/v1/checkout-intents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "buyer": {
    "postalCode": "10001",
    "country": "US",
    "province": "NY",
    "city": "New York",
    "address2": "Apt 1",
    "address1": "123 Main St",
    "phone": "5555555555",
    "email": "john.doe@example.com",
    "lastName": "Doe",
    "firstName": "John"
  },
  "quantity": 123,
  "productUrl": "<string>"
}'
{
  "buyer": {
    "postalCode": "10001",
    "country": "US",
    "province": "NY",
    "city": "New York",
    "address2": "Apt 1",
    "address1": "123 Main St",
    "phone": "5555555555",
    "email": "john.doe@example.com",
    "lastName": "Doe",
    "firstName": "John"
  },
  "quantity": 123,
  "productUrl": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "state": "retrieving_offer"
}

Authorizations

Authorization
string
header
required

Rye API key. Format: Bearer <RYE_API_KEY>

Body

application/json

Response

201
application/json

Created

The response is of type object.