Path parameters

• cartId string(uuid) Required

  The unique identifier of the cart to select the payment method for.

Responses

• 200 application/json

  The payment method was selected for the cart.

  Hide response attribute Show response attribute object

  • data object Required

    The cart the payment method has been selected for.

    Hide data attributes Show data attributes object

    • checkout object Required

      A minimal summary of the cart's latest checkout attempt, or null if no checkout has been created yet.

      Hide checkout attributes Show checkout attributes object

      • cancelledAt string(date-time) | null Required

        The timestamp when the cart checkout was cancelled.

      • completedAt string(date-time) | null Required

        The timestamp when the cart checkout was completed.

      • failedAt string(date-time) | null Required

        The timestamp when the cart checkout failed.

      • failureCode string | null Required

        The failure code of the cart checkout. Free-form: new codes are introduced without a version change, so treat an unrecognized value as an unspecified failure.

      • id string(uuid) Required

        The unique identifier of the checkout.

      • startedAt string(date-time) Required

        The timestamp when the cart checkout was started.

      • status string Required

        The status of the cart checkout.

        Values are PROCESSING, ACTIONS_REQUIRED, COMPLETED, CANCELLED, or FAILED.

    • clientId string Required

      The unique identifier of the client through which this cart was created.

    • createdAt string(date-time) Required

      The timestamp when the cart was created.

    • expiresAt string(date-time) | null Required

      The timestamp at which the cart lapses if nothing interacts with it before then. Every interaction with the cart pushes it further out, so read the current value rather than assuming a fixed window. It is null once the checkout has completed.

    • id string(uuid) Required

      The unique identifier for the cart.

    • paymentMethodId string(uuid) | null Required

      The unique identifier of the payment method selected for this cart, or null while none is selected. Adding, configuring or removing an item clears the selection.

    • poiId string(uuid) Required

      The unique identifier of the POI associated with this cart.

    • status string Required

      The current status of the cart.

      Values are OPEN, PROCESSING, COMPLETED, CANCELLED, FAILED, EXHAUSTED, or EXPIRED.

    • summary object Required

      A post-settlement aggregate of the cart's totals, or null until every non-cancelled item has settled.

      Hide summary attributes Show summary attributes object

      • currency string Required

        The currency of the cart total.

      • priceExcludingVAT string(decimal) Required

        The total price of the cart, excluding VAT.

        Minimum value is 0.

      • priceIncludingVAT string(decimal) Required

        The total price of the cart, including VAT.

        Minimum value is 0.

      • vatAmount string(decimal) Required

        The total amount of VAT applied to the cart.

        Minimum value is 0.

    • updatedAt string(date-time) Required

      The timestamp when the cart was last updated.

    • userId string(uuid) Required

      The unique identifier of the user who owns this cart.

• 400

  The request parameters are missing or invalid.

• 401

  Client authentication failed.

• 403

  Missing one or more required scopes.

• 404

  The specified cart or payment method was not found.

• 409

  The payment method is not usable for the cart, the cart has an ongoing or completed checkout, or the cart is currently being modified.

• 500

  An unexpected error occurred.