When called for a not submitted cart, Checkout.status will always be PENDING. After cart submission Checkout.status will change according to the current checkout state.

Sometimes, when using the checkoutByCartID query, the returned status may be ACTION_REQUIRED. In this case, you should check the requiredActions field for each order with this status and perform the necessary actions. Currently, there is only one required action: CompletePaymentChallenge, also known as 3D-S Challenge. You can learn more about this use casse in the 3D-S Challenge guide.

​
Arguments

​
cartID
ID!
required

The ID of the Cart

​
Returns

​
Checkout.*
Checkout

Any requested field from the Checkout object.

​
Usage

import { RyeClient, Marketplace } from "@rye-api/rye-sdk";

const ryeClient = new RyeClient({
  authHeader: "<AUTH_HEADER>",
  shopperIp: "<SHOPPER_IP>",
});

const result = await ryeClient.checkoutByCartId({
  id: "<CART_ID>",
});