---
title: "Get the payment status of current cart (or last placed cart)"
method: GET
path: "/api/v1/payment/status"
tags: ["Payment"]
---

# Get the payment status of current cart (or last placed cart)

`GET /api/v1/payment/status`

## Response `200`

OK

- object
  - `Action` string — Action to perform to proceed in the payment flow. If status is "payment_waiting_for_customer" this field contains information about what to do - e.g. "redirect" or "show_iframe"
  - `ActionData` DomainFlowActionData
    - `DisplayData` string — DisplayData holds data, normally HTML to be displayed to the user
    - `FormParameter` object
    - `URL` string — URL is used to pass URL data to the user if the current state needs some
    - `WalletDetails` DomainWalletDetails
      - `PaymentRequestAPI` DomainPaymentRequestAPI
        - `CompleteURL` string
        - `Details` string
        - `MerchantValidationURL` string
        - `Methods` string
        - `Options` string
      - `UsedPaymentMethod` string
  - `Data` unknown
  - `Error` DomainError
    - `ErrorCode` string
    - `ErrorMessage` string
  - `Status` string — Status of the payment flow. E.g. "payment_completed", "payment_waiting_for_customer" or "payment_failed"
  - `data` CartCart
    - `AdditionalData` CartAdditionalData
      - `CustomAttributes` object — CustomAttributes list of key values
      - `ReservedOrderID` string — ReservedOrderID is an ID already known by the Cart of the future order ID
    - `AppliedCouponCodes` CartCouponCode[] — AppliedCouponCodes hold the coupons or discount codes that are applied to the cart
      - `Code` string
      - `CustomAttributes` object — CustomAttributes can hold additional data for coupon code - keys and values are project specific
    - `AppliedGiftCards` CartAppliedGiftCard[] — AppliedGiftCards is a list of applied gift cards
      - `Applied` DomainPrice
      - `Code` string
      - `CustomAttributes` object — additional custom attributes
      - `Remaining` DomainPrice
    - `AuthenticatedUserID` string — AuthenticatedUserID holds the potential customer ID
    - `BelongsToAuthenticatedUser` boolean — BelongsToAuthenticatedUser displays if the cart is guest cart (false) or from an authenticated user (true)
    - `BillingAddress` CartAddress
      - `AdditionalAddressLines` string[]
      - `City` string
      - `Company` string
      - `Country` string
      - `CountryCode` string
      - `Email` string
      - `Firstname` string
      - `Lastname` string
      - `MiddleName` string
      - `PostCode` string
      - `RegionCode` string
      - `Salutation` string
      - `State` string
      - `Street` string
      - `StreetNr` string
      - `Telephone` string — Deprecated: parts of number should be distinguished, please use TelephoneCountryCode, TelephoneAreaCode and TelephoneNumber
      - `TelephoneAreaCode` string
      - `TelephoneCountryCode` string
      - `TelephoneNumber` string
      - `Title` string
      - `Vat` string
    - `DefaultCurrency` string
    - `Deliveries` CartDelivery[] — Deliveries contains a list of desired Deliveries (or Shipments) involved in this cart
      - `Cartitems` CartItem[] — Cartitems is the list of items belonging to this delivery
        - `AdditionalData` object
        - `AppliedDiscounts` CartAppliedDiscount[] — AppliedDiscounts contains the details about the discounts applied to this item - they can be "itemrelated" or not itemrelated would be e.g. special price, buy 3 pay 2 non-itemrelated would be e.g. 10% on everything
          - `Applied` DomainPrice
          - `CampaignCode` string — unique code of the underlying campaign or rule e.g. "summer-campaign-2018"
          - `CouponCode` string — code of discount e.g. provided by user "summer2018"
          - `CustomAttributes` object — stores additional discount attributes
          - `IsItemRelated` boolean — flag indicating if the discount is applied due to item in cart
          - `Label` string — readable name of discount "Super Summer Sale 2018"
          - `SortOrder` integer — indicates in which order discount have been applied, low value has been applied before high value
          - `Type` string — to distinguish between discounts
        - `BundleConfig` DomainBundleConfiguration
        - `ExternalReference` string — ExternalReference can be used by cart service implementations to separate the representation in an external cart service from the unique item ID
        - `ID` string — ID of the item - needs to be unique over the whole cart
        - `ItemRelatedDiscountAmount` DomainPrice
        - `MarketplaceCode` string — MarketplaceCode is the identifier for the product
        - `NonItemRelatedDiscountAmount` DomainPrice
        - `ProductName` string
        - `Qty` integer
        - `RowPriceGross` DomainPrice
        - `RowPriceGrossWithDiscount` DomainPrice
        - `RowPriceGrossWithItemRelatedDiscount` DomainPrice
        - `RowPriceNet` DomainPrice
        - `RowPriceNetWithDiscount` DomainPrice
        - `RowPriceNetWithItemRelatedDiscount` DomainPrice
        - `RowTaxes` CartTax[] — RowTaxes is a list of all taxes applied for the given Qty of products
          - `Amount` DomainPrice
          - `Rate` string
          - `Type` string
        - `SinglePriceGross` DomainPrice
        - `SinglePriceNet` DomainPrice
        - `SourceID` string — Source Id of where the items should be initial picked - This is set by the SourcingLogic
        - `TotalDiscountAmount` DomainPrice
        - `VariantMarketPlaceCode` string — VariantMarketPlaceCode is used for Configurable products
      - `DeliveryInfo` CartDeliveryInfo
        - `AdditionalData` object — AdditionalData can be used to store project specific information on the delivery
        - `Carrier` string — Carrier optional name of the Carrier that should be responsible for executing the delivery
        - `Code` string — Code is a project specific identifier for the Delivery - you need it for the AddToCart Request for example the code can follow the convention in the Readme: Type_Method_LocationType_LocationCode
        - `DeliveryLocation` CartDeliveryLocation
          - `Address` CartAddress
            - `AdditionalAddressLines` string[]
            - `City` string
            - `Company` string
            - `Country` string
            - `CountryCode` string
            - `Email` string
            - `Firstname` string
            - `Lastname` string
            - `MiddleName` string
            - `PostCode` string
            - `RegionCode` string
            - `Salutation` string
            - `State` string
            - `Street` string
            - `StreetNr` string
            - `Telephone` string — Deprecated: parts of number should be distinguished, please use TelephoneCountryCode, TelephoneAreaCode and TelephoneNumber
            - `TelephoneAreaCode` string
            - `TelephoneCountryCode` string
            - `TelephoneNumber` string
            - `Title` string
            - `Vat` string
          - `Code` string — Code is an optional identifier of this location/destination
          - `Type` string — Type is the type of the delivery - use some of the constant defined in the package like DeliverylocationTypeAddress
          - `UseBillingAddress` boolean — UseBillingAddress if the address should be taken from billing (only relevant for type address)
        - `DesiredTime` string — DesiredTime is an optional desired time for the delivery
        - `Method` string — Method is the shipping method something that is project specific and that can mean different delivery qualities with different delivery costs
        - `Workflow` string — Workflow of the Delivery e.g. delivery or pickup, see DeliveryWorkflowPickup, DeliveryWorkflowDelivery or DeliveryWorkflowUnspecified
      - `GrandTotal` DomainPrice
      - `ItemRelatedDiscountAmount` DomainPrice
      - `NonItemRelatedDiscountAmount` DomainPrice
      - `ShippingItem` CartShippingItem
        - `AppliedDiscounts` CartAppliedDiscount[]
          - `Applied` DomainPrice
          - `CampaignCode` string — unique code of the underlying campaign or rule e.g. "summer-campaign-2018"
          - `CouponCode` string — code of discount e.g. provided by user "summer2018"
          - `CustomAttributes` object — stores additional discount attributes
          - `IsItemRelated` boolean — flag indicating if the discount is applied due to item in cart
          - `Label` string — readable name of discount "Super Summer Sale 2018"
          - `SortOrder` integer — indicates in which order discount have been applied, low value has been applied before high value
          - `Type` string — to distinguish between discounts
        - `PriceGross` DomainPrice
        - `PriceGrossWithDiscounts` DomainPrice
        - `PriceNet` DomainPrice
        - `PriceNetWithDiscounts` DomainPrice
        - `TaxAmount` DomainPrice
        - `Title` string
      - `SubTotalDiscountAmount` DomainPrice
      - `SubTotalGross` DomainPrice
      - `SubTotalGrossWithDiscounts` DomainPrice
      - `SubTotalNet` DomainPrice
      - `SubTotalNetWithDiscounts` DomainPrice
      - `TotalDiscountAmount` DomainPrice
    - `EntityID` string — EntityID is a second identifier that may be used by some backends
    - `GrandTotal` DomainPrice
    - `GrandTotalNet` DomainPrice
    - `GrandTotalNetWithGiftCards` DomainPrice
    - `GrandTotalWithGiftCards` DomainPrice
    - `ID` string — ID is the main identifier of the cart
    - `ItemRelatedDiscountAmount` DomainPrice
    - `NonItemRelatedDiscountAmount` DomainPrice
    - `PaymentSelection` unknown
    - `Purchaser` CartPerson
      - `Address` CartAddress
        - `AdditionalAddressLines` string[]
        - `City` string
        - `Company` string
        - `Country` string
        - `CountryCode` string
        - `Email` string
        - `Firstname` string
        - `Lastname` string
        - `MiddleName` string
        - `PostCode` string
        - `RegionCode` string
        - `Salutation` string
        - `State` string
        - `Street` string
        - `StreetNr` string
        - `Telephone` string — Deprecated: parts of number should be distinguished, please use TelephoneCountryCode, TelephoneAreaCode and TelephoneNumber
        - `TelephoneAreaCode` string
        - `TelephoneCountryCode` string
        - `TelephoneNumber` string
        - `Title` string
        - `Vat` string
      - `ExistingCustomerData` CartExistingCustomerData
        - `ID` string — ID of the customer
      - `PersonalDetails` CartPersonalDetails
        - `DateOfBirth` string
        - `Nationality` string
        - `PassportCountry` string
        - `PassportNumber` string
    - `ShippingGross` DomainPrice
    - `ShippingGrossWithDiscounts` DomainPrice
    - `ShippingNet` DomainPrice
    - `ShippingNetWithDiscounts` DomainPrice
    - `SubTotalGross` DomainPrice
    - `SubTotalGrossWithDiscounts` DomainPrice
    - `SubTotalNet` DomainPrice
    - `SubTotalNetWithDiscounts` DomainPrice
    - `TotalDiscountAmount` DomainPrice
    - `TotalGiftCardAmount` DomainPrice
    - `Totalitems` CartTotalitem[] — Additional non taxable totals
      - `Code` string
      - `Price` DomainPrice
      - `Title` string
      - `Type` string

## Other responses

- `500` — Internal Server Error

---

[API](https://skmtc.net/i-love-flamingo/apis/flamingo-commerce-api-spec.md) · [All operations](https://skmtc.net/i-love-flamingo/apis/flamingo-commerce-api-spec/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/i-love-flamingo/flamingo-commerce-api-spec/versions/b7749eb201b8/schema)