RYrye-com
Checkout Intents

Confirm checkout intent

Changed on

Confirm a checkout intent with provided payment information

Confirm means we have buyer's name, address and payment info, so we can move forward to place the order.

post/api/v1/checkout-intents/{id}/confirm

Request

  • Base URL
    https://staging.api.rye.com
  • URL
    https://staging.api.rye.com/api/v1/checkout-intents/{id}/confirm
  • Auth
    API key in header Authorization

Path parameters

idstring required

The id of the checkout intent to confirm

Request body

Example request

{
  "paymentMethod": {
    "stripeToken": "tok_1RkrWWHGDlstla3f1Fc7ZrhH",
    "type": "stripe_token"
  }
}

Response

The confirmed checkout intent

OR
OR
OR
OR
OR

Example response

{
  "referenceId": "order-1234",
  "constraints": {
    "maxShippingPrice": 500,
    "maxTotalPrice": 100000
  },
  "promoCodes": [
    "SAVE20"
  ],
  "variantSelections": [
    {
      "label": "Size, Color, etc."
    }
  ],
  "buyer": {
    "postalCode": "10001",
    "country": "US",
    "province": "NY",
    "city": "New York",
    "address2": "Apt 1",
    "address1": "123 Main St",
    "phone": "1234567890",
    "email": "john.doe@example.com",
    "lastName": "Doe",
    "firstName": "John"
  }
}

Changes

  • cd4a7aa2308bRevision changes
    • breaking

      removed from the request property anyOf list

    • info

      removed from the // response property anyOf list for the response status

    • info

      removed from the // response property anyOf list for the response status

    • info

      removed from the // response property anyOf list for the response status

    • info

      removed from the // response property anyOf list for the response status

    • info

      removed from the // response property anyOf list for the response status

  • f2236504ec75Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status