Refresh a Payment Session

POST/store/carts/{id}/payment-sessions/{provider_id}/refresh

Refresh a Payment Session to ensure that it is in sync with the Cart. This is usually not necessary, but is provided for edge cases.

Request

Path Params

string

required

The ID of the Cart.

provider_id

string

required

The ID of the Payment Provider that created the Payment Session to be refreshed.

Request samples

Responses

OK(200)

Client Error or Multiple Errors(400)

Not Found Error(404)

Invalid State Error(409)

Invalid Request Error(422)

Server Error(500)

HTTP Code: 200

Content Type : JSONapplication/json

The cart's details.

cart

object (Cart)

required

A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim.

string

required

The cart's ID

Example:

cart_01G8ZH853Y6TFXWPG5EYE81X63

string <email> | null

required

The email associated with the cart

billing_address_id

string | null

required

The billing address's ID

Example:

addr_01G8ZH853YPY9B94857DY91YGW

shipping_address_id

string | null

required

The shipping address's ID

Example:

addr_01G8ZH853YPY9B94857DY91YGW

region_id

string

required

The region's ID

Example:

reg_01G1G5V26T9H8Y0M4JNE3YGA4G

customer_id

string | null

required

The customer's ID

Example:

cus_01G2SG30J8C85S4A5CHM2S1NS2

customer

object | null

optional

The details of the customer the cart belongs to.

payment_session

object | null

required

The details of the selected payment session in the cart.

payment_id

string | null

required

The payment's ID if available

Example:

pay_01G8ZCC5W42ZNY842124G7P5R9

payment

object | null

optional

The details of the payment associated with the cart.

completed_at

string <date-time> | null

required

The date with timezone at which the cart was completed.

payment_authorized_at

string <date-time> | null

required

The date with timezone at which the payment was authorized.

sales_channel_id

string | null

optional

The sales channel ID the cart is associated with.

Example:

null

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

shipping_total

integer

optional

The total of shipping

Example:

1000

discount_total

integer

optional

The total of discount rounded

Example:

800

raw_discount_total

integer

optional

The total of discount

Example:

800

item_tax_total

integer

optional

The total of items with taxes

Example:

8000

shipping_tax_total

integer

optional

The total of shipping with taxes

Example:

1000

tax_total

integer

optional

The total of tax

Example:

refunded_total

integer

optional

The total amount refunded if the order associated with this cart is returned.

Example:

total

integer

optional

The total amount of the cart

Example:

8200

subtotal

integer

optional

The subtotal of the cart

Example:

8000

refundable_amount

integer

optional

The amount that can be refunded

Example:

8200

gift_card_total

integer

optional

The total of gift cards

Example:

gift_card_tax_total

integer

optional

The total of gift cards with taxes

Example:

payment_sessions

array [object]

optional

The details of all payment sessions created on the cart.

type

enum<string>

required

The cart's type.

Allowed values:

defaultswapdraft_orderpayment_linkclaim

Default:

default

idempotency_key

string | null

required

Randomly generated key used to continue the completion of a cart in case of failure.

context

object | null

required

The context of the cart which can include info like IP or user agent.

Example:

{"ip":"::1","user_agent":"PostmanRuntime/7.29.2"}

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

billing_address

object (Address)

optional

An address is used across the Medusa backend within other schemas and object types. For example, a customer's billing and shipping addresses both use the Address entity.

sales_channel

object (Sales Channel)

optional

A Sales Channel is a method a business offers its products for purchase for the customers. For example, a Webshop can be a sales channel, and a mobile app can be another.

shipping_address

object (Address)

optional

An address is used across the Medusa backend within other schemas and object types. For example, a customer's billing and shipping addresses both use the Address entity.

shipping_methods

array[object (Shipping Method) {20}]

optional

The details of the shipping methods added to the cart.

region

object (Region)

optional

A region holds settings specific to a geographical location, including the currency, tax rates, and fulfillment and payment providers. A Region can consist of multiple countries to accomodate common shopping settings across countries.

gift_cards

array[object (Gift Card) {15}]

optional

An array of details of all gift cards applied to the cart.

discounts

array[object (Discount) {18}]

optional

An array of details of all discounts applied to the cart.

items

array[object (Line Item) {42}]

optional

The line items added to the cart.

Not configured

Last modified: a year ago