openapi: 3.0.1 info: title: PayPal Complete Payments Extension description: "The _PayPal Complete Payments Extension REST API_, provided by the\ \ PayPal Complete Payments Connector, introduces PayPal-specific resources\nthat\ \ extend the capabilities of the standard Basket REST API. \nTo make use of these\ \ extensions, it is crucial to have the PayPal Complete Payments Connector customization\ \ correctly installed and configured.\n\n#### API Versioning & Accept-Header\n\ \nMedia-type-based versioning is used to distinguish between different API versions.\ \ The API extends the Basket REST API v1 and therefore \nuses the same ```Accept```\ \ header:\n\n```Accept: application/vnd.intershop.basket.v1+json```\n\n## Changelog\n\ \n### Version 1.0.0\n* Initial version of PayPal Complete Payments Extension to\ \ Basket API v1" contact: name: Intershop Communications AG url: http://intershop.com version: 1.0.0 servers: - url: "/INTERSHOP/rest/{serverGroup}/{siteName}/{appUrl}" description: Intershop ICM Server variables: serverGroup: description: The server group enum: - BOS - JOB - WFS default: WFS siteName: description: The site name default: inSPIRED-inTRONICS-Site appUrl: description: The application URL identifier enum: - "-" default: "-" tags: - name: Payment description: This section covers additional operations required for the payment functionality of the Basket REST API in connection with PayPal. x-origin-class: com.intershop.adapter.payment.paypal.checkout.capi.rest.PaymentItemPaypalExperienceContextResource paths: /baskets/{BasketResourceKey}/payments/{BasketPaymentKey}/paypal-experience-context: get: tags: - Payment summary: Re-reads the PayPal order status description: "This operation reads the current order details from the PayPal\ \ order in order to return details about the payment. If the PayPal order\ \ cannot be found, a 404 error is returned." operationId: GetPayPalExperienceContext parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource - name: BasketPaymentKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource responses: "200": description: OK - The payment details have been retrieved successfully. content: application/vnd.intershop.basket.v1+json: schema: $ref: "#/components/schemas/PaypalPaymentSourceRO" "404": description: Not found - The PayPal order (with the experience context) could not be read. content: application/vnd.intershop.basket.v1+json: schema: $ref: "#/components/schemas/PaypalPaymentSourceRO" security: - bearerAuth: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.adapter.payment.paypal.checkout.capi.rest.PaymentItemPaypalExperienceContextResource.get3DSecure() x-origin-class: com.intershop.adapter.payment.paypal.checkout.capi.rest.PaymentItemPaypalExperienceContextResource x-AuthorizationRule: "[((((NOT isAuthenticated[Organization] OR isCustomerType)\ \ OR hasPermission[Organization:APP_B2B_PURCHASE]) OR hasPermission[Organization:APP_B2B_SEND_OCI_BASKET])\ \ OR hasPermission[Organization:APP_B2B_SEND_CXML_BASKET])]" put: tags: - Payment summary: Initializes a PayPal payment with an experience context description: "This operation initializes a PayPal payment with an experience\ \ context (e.g., card, google_pay) by creating an order on the PayPal side.\ \ If the PayPal order cannot be created, a 422 error is returned." operationId: InitializePayPalExperienceContext parameters: - name: BasketResourceKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketListResource - name: BasketPaymentKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource requestBody: description: The object containing the updated URLs for initializing the PayPal payment content: application/json: schema: $ref: "#/components/schemas/PaypalPaymentSourceRO" responses: "200": description: OK - The PayPal order with the experience context has been initialized successfully. content: application/vnd.intershop.basket.v1+json: schema: $ref: "#/components/schemas/PaymentCtnrRO_v1" "422": description: Unprocessable Entity - The PayPal order (with the experience context) could not be initialized. content: application/vnd.intershop.basket.v1+json: schema: $ref: "#/components/schemas/PaymentCtnrRO_v1" "423": description: Locked - The basket is locked by another process. content: application/vnd.intershop.basket.v1+json: schema: $ref: "#/components/schemas/PaymentCtnrRO_v1" security: - bearerAuth: [] x-origin-method: public jakarta.ws.rs.core.Response com.intershop.adapter.payment.paypal.checkout.capi.rest.PaymentItemPaypalExperienceContextResource.initializeExperienceContext(com.intershop.adapter.payment.paypal.checkout.capi.rest.PaypalPaymentSourceRO) x-origin-class: com.intershop.adapter.payment.paypal.checkout.capi.rest.PaymentItemPaypalExperienceContextResource x-AuthorizationRule: "[((((NOT isAuthenticated[Organization] OR isCustomerType)\ \ OR hasPermission[Organization:APP_B2B_PURCHASE]) OR hasPermission[Organization:APP_B2B_SEND_OCI_BASKET])\ \ OR hasPermission[Organization:APP_B2B_SEND_CXML_BASKET])]" components: schemas: PaypalCardRO: type: object properties: brand: type: string description: The card brand or network readOnly: true example: VISA expiry: type: string description: "The card expiration year and month, in Internet date format" readOnly: true example: 2030-12 lastDigits: type: string description: The last digits of the payment card readOnly: true example: "4242" threeDSecureDecision: type: string description: The general advice on how to proceed after 3D Secure authentication readOnly: true example: ACCEPT enum: - ACCEPT - DECLINE description: Describes publicly available card meta data provided by PayPal readOnly: true PaypalExperienceContextRO: required: - cancelUrl - returnUrl type: object properties: cancelUrl: type: string description: The URL to be called on failed or canceled payment returns to the shop format: uri example: https://shop.server/cancel returnUrl: type: string description: The URL to be called on successful payment returns to the shop format: uri example: https://shop.server/success description: Describes the URLs to be used for redirecting back to the storefront PaypalPaymentSourceRO: required: - experienceContext type: object properties: card: $ref: "#/components/schemas/PaypalCardRO" experienceContext: $ref: "#/components/schemas/PaypalExperienceContextRO" name: type: string description: The name of the card or account as it appears on the card or associated account readOnly: true example: Max Mustermann orderId: type: string description: The ID of the order created on the PayPal side readOnly: true example: ORDER-42 description: Describes order and payment details provided by PayPal FeedbackCauseRO_v1: title: FeedbackCauseRO_v1 required: - code - message type: object properties: code: type: string description: A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) example: product.name.required.error message: type: string description: A human readable message in the request's locale example: The product name must be specified. parameters: type: object additionalProperties: type: object description: A map of several parameters that are used to assemble the message. description: A map of several parameters that are used to assemble the message paths: type: array description: "A collection of JSON paths to the associated entities. Unless\ \ otherwise specified, this always refers to the request entity." example: - "\"$.name (position: 1)\"" externalDocs: url: https://github.com/json-path/JsonPath items: type: string description: "A collection of JSON paths to the associated entities. If\ \ not otherwise specified, this always refers to the request entity." externalDocs: url: https://github.com/json-path/JsonPath description: A representation for the common feedback information FeedbackRO_v1: title: FeedbackRO_v1 required: - code - message type: object properties: causes: type: array description: A collection of errors/warnings/infos that caused the feedback items: $ref: "#/components/schemas/FeedbackCauseRO_v1" code: type: string description: A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) example: product.name.required.error message: type: string description: A human readable message in the request's locale example: The product name must be specified. parameters: type: object additionalProperties: type: object description: A map of several parameters that are used to assemble the message. description: A map of several parameters that are used to assemble the message paths: type: array description: "A collection of JSON paths to the associated entities. Unless\ \ otherwise specified, this always refers to the request entity." example: - "\"$.name (position: 1)\"" externalDocs: url: https://github.com/json-path/JsonPath items: type: string description: "A collection of JSON paths to the associated entities. If\ \ not otherwise specified, this always refers to the request entity." externalDocs: url: https://github.com/json-path/JsonPath status: type: string description: The HTTP status code that is applicable to this problem example: "422" description: An error or piece of information related to the current request readOnly: true MoneyRO_v1: title: MoneyRO_v1 type: object properties: currency: type: string description: Three-letter currency code (ISO 4217) of the monetary value example: USD value: type: number description: The monetary value example: 10.99 description: Describes a money object readOnly: true ParameterRO_v1: type: object properties: name: type: string description: The name of an element example: expiryDate value: type: object description: The value of the parameter example: 12/30 description: A representation of a parameter value PaymentCtnrRO_v1: type: object properties: data: $ref: "#/components/schemas/PaymentRO_v1" errors: type: array description: List of errors that occurred in relation to the request readOnly: true items: $ref: "#/components/schemas/FeedbackRO_v1" included: type: object properties: paymentMethod: type: object properties: : $ref: "#/components/schemas/PaymentMethodRO_v1" paymentInstrument: type: object properties: : $ref: "#/components/schemas/PaymentInstrumentRO_v1" paymentInstrument_paymentMethod: type: object properties: : $ref: "#/components/schemas/PaymentMethodRO_v1" paymentMethod_paymentInstruments: type: object properties: : $ref: "#/components/schemas/PaymentInstrumentRO_v1" description: Optionally included related data objects. Included via "include" query parameter. readOnly: true x-supported-include-type: com.intershop.sellside.rest.payment.v1.capi.resourceobject.payment.PaymentRO infos: type: array description: List of informations regarding to the request (e.g. value adjustments) readOnly: true items: $ref: "#/components/schemas/FeedbackRO_v1" links: type: object additionalProperties: type: object description: "Map of links to this and the optionally included related\ \ data objects. The object in the \"data\" property is always referenced\ \ by identifier \"self\". Note that this identifier may also contain\ \ a list of URIs, if the data block contains multiple elements." readOnly: true description: "Map of links to this and the optionally included related data\ \ objects. The object in the \"data\" property is always referenced by\ \ identifier \"self\". Note that this identifier may also contain a list\ \ of URIs, if the data block contains multiple elements." readOnly: true PaymentRO_v1: required: - paymentInstrument type: object properties: baseAmount: $ref: "#/components/schemas/MoneyRO_v1" id: type: string description: The ID of the payment readOnly: true example: AAFjXFq2QKAEsBiyQABB6G14 openTender: type: boolean description: Indicates whether or not the payment is an 'open-tender' payment readOnly: true paymentCosts: $ref: "#/components/schemas/PriceRO_v1" paymentInstrument: type: string description: The reference to the payment instrument that was selected for this payment example: c2UKAEsBar8AAAFmxYVBTOiI paymentMethod: type: string description: The reference to the payment method that was used for this payment readOnly: true example: ISH_INVOICE redirect: $ref: "#/components/schemas/PaymentRedirectRO_v1" redirectRequired: type: boolean description: Indicates whether or not a redirect is required to finish the payment. The type of redirect (before or after the checkout process) can be determined via the capabilities of the payment method. readOnly: true status: type: string description: The localized display name of the payment status readOnly: true example: Partially captured totalAmount: $ref: "#/components/schemas/MoneyRO_v1" description: A payment assigned to the basket/order to pay the bill with PaymentRedirectRO_v1: required: - cancelUrl - failureUrl - successUrl type: object properties: cancelUrl: type: string description: "The URL to be called when the user cancelled payment and the\ \ PSP redirects the user back to the shop. Placeholders can be used in\ \ this URL that get replaced by their real values during order creation.\ \ Per default, the placeholders \\*orderID\\* and \\*paymentID\\* are\ \ available." format: uri example: https://shop.server/cancel?paymentID=*paymentID* failureUrl: type: string description: "The URL to be called when the payment failed and the PSP redirects\ \ the user back to the shop. Placeholders can be used in this URL that\ \ get replaced by their real values during order creation. Per default,\ \ the placeholders \\*orderID\\* and \\*paymentID\\* are available." format: uri example: https://shop.server/failure parameters: type: array description: List of parameters returned in the redirect response from the PSP items: $ref: "#/components/schemas/ParameterRO_v1" redirectUrl: type: string description: The URL to be called when redirecting the user to the payment providers page format: uri readOnly: true example: https://psp-server/pay status: type: string description: The final status of the redirect returned to the shop example: SUCCESS enum: - SUCCESS - CANCEL - FAILURE successUrl: type: string description: "The URL to be called on successful payment redirect back to\ \ the shop. Placeholders can be used in this URL that get replaced by\ \ their real values during order creation. Per default, the placeholders\ \ \\*orderID\\* and \\*paymentID\\* are available." format: uri example: https://shop.server/success?orderID=*orderID* description: Describes a payment redirect PriceRO_v1: type: object properties: gross: $ref: "#/components/schemas/MoneyRO_v1" net: $ref: "#/components/schemas/MoneyRO_v1" priceQuantity: $ref: "#/components/schemas/QuantityRO_v1" tax: $ref: "#/components/schemas/MoneyRO_v1" description: "Describes a price. A price has a monetary net, gross, and tax\ \ value and a quantity the price refers to (optional)." readOnly: true QuantityRO_v1: required: - value type: object properties: unit: type: string description: The unit of the quantity example: kg value: type: number description: The quantity's value example: 10 description: The quantity of a business entity readOnly: true PaymentInstrumentRO_v1: required: - paymentMethod type: object properties: accountIdentifier: type: string description: An optional identifier for the customers bank account. readOnly: true example: DE12****7890 id: type: string description: The ID of the payment instrument. example: AAFjXFq2QKAEsBiyQABB6G14 numberOfPayments: type: integer description: The number of payments done with this instrument. format: int32 readOnly: true example: 3 parameters: type: array description: The parameters for the payment instrument. items: $ref: "#/components/schemas/ParameterRO_v1" paymentMethod: type: string description: The reference to the payment method the instrument is created for. example: ISH_DIRECT_DEBIT urn: type: string description: The URN of the payment instrument. example: urn:payment-instrument:basket:q2QKAEsBiyQAAAFjXFBB6G14:AAFjXFq2QKAEsBiyQABB6G14 description: A payment instrument with stored bank account data. ConstraintRO_v1: required: - message type: object properties: message: type: string description: The message text of the constraint readOnly: true description: A constraint of a parameter PaymentMethodRO_v1: type: object properties: capabilities: type: array description: List of supported payment service capabilities readOnly: true example: RedirectAfterCheckout items: type: string description: List of supported payment service capabilities readOnly: true example: RedirectAfterCheckout default: type: boolean description: Indicates whether the payment method is the default payment method of the channel readOnly: true description: type: string description: A more detailed description of the payment method readOnly: true example: Simulate a payment with the Intershop demo method displayName: type: string description: The display name of the payment method readOnly: true example: ISH Demo Payment hostedPaymentPageParameters: type: array description: List of content parameters for Hosted Payment Pages readOnly: true items: $ref: "#/components/schemas/ParameterRO_v1" id: type: string description: The ID of the payment method. Internally this is the ID of the payment method configuration in the back office readOnly: true example: ISH_INVOICE maxOrderAmount: $ref: "#/components/schemas/PriceRO_v1" minOrderAmount: $ref: "#/components/schemas/PriceRO_v1" parameterDefinitions: type: array description: "List of parameters (e.g., credit card 3DS token or IBAN) for\ \ this payment" readOnly: true items: $ref: "#/components/schemas/ParameterDefinitionRO_v1" paymentCosts: $ref: "#/components/schemas/PriceRO_v1" paymentCostsThreshold: $ref: "#/components/schemas/PriceRO_v1" paymentInstruments: type: array description: The IDs of all payment instruments stored for this payment method in the current context readOnly: true items: type: string description: The IDs of all payment instruments stored for this payment method in the current context readOnly: true restricted: type: boolean description: Indicates whether the payment method can be used in the current context readOnly: true restrictions: type: array description: The restrictions which prevent the payment method from being applicable readOnly: true items: $ref: "#/components/schemas/PaymentRestrictionRO_v1" saveAllowed: type: boolean description: Indicates whether the entered payment data can be saved for later reuse readOnly: true example: false serviceID: type: string description: The ID of the payment service readOnly: true example: SomePaymentProvider_CreditCard description: A configured payment method OptionRO_v1: type: object properties: displayName: type: string description: The localized display name of the parameter option example: American Express id: type: string description: The ID of the parameter option example: amx description: A representation of a parameter option ParameterDefinitionRO_v1: required: - name - type type: object properties: constraints: type: object additionalProperties: $ref: "#/components/schemas/ConstraintRO_v1" description: A map of parameter constraints. The key is the constraint type. description: type: string description: The localized parameter description readOnly: true displayName: type: string description: The localized display name of the parameter readOnly: true example: Expiration Date hidden: type: boolean description: A flag indicating a hidden parameter that is not visible in the UI readOnly: true name: type: string description: The name of an element readOnly: true example: expiryDate options: type: array description: A list of allowable values to choose from for this parameter items: $ref: "#/components/schemas/OptionRO_v1" placeholder: type: string description: A placeholder string for the parameter readOnly: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true example: String updatable: type: boolean description: A flag indicating that a parameter value is updatable via REST readOnly: true description: A representation of a parameter definition readOnly: true PaymentRestrictionRO_v1: required: - code - message type: object properties: code: type: string description: A unique identifier for this restriction readOnly: true example: payment.restriction.MultipleBuckets message: type: string description: A human readable message in the request's locale describing the restriction readOnly: true example: Not available for orders being dispatched to multiple addresses or in multiple shipments. parameters: type: object additionalProperties: type: object description: A map of additional parameters to be used in the description readOnly: true description: A map of additional parameters to be used in the description readOnly: true description: A restriction which limits the use of a payment method readOnly: true responses: "200": description: OK "201": description: Created "202": description: Accepted "204": description: No Content "205": description: Reset Content "206": description: Partial Content "300": description: Multiple Choices "301": description: Moved Permanently "302": description: Found "303": description: See Other "304": description: Not Modified "305": description: Use Proxy "307": description: Temporary Redirect "308": description: Permanent Redirect "400": description: Bad Request "401": description: Unauthorized "402": description: Payment Required "403": description: Forbidden "404": description: Not Found "405": description: Method Not Allowed "406": description: Not Acceptable "407": description: Proxy Authentication Required "408": description: Request Timeout "409": description: Conflict "410": description: Gone "411": description: Length Required "412": description: Precondition Failed "413": description: Request Entity Too Large "414": description: Request-URI Too Long "415": description: Unsupported Media Type "416": description: Requested Range Not Satisfiable "417": description: Expectation Failed "428": description: Precondition Required "429": description: Too Many Requests "431": description: Request Header Fields Too Large "451": description: Unavailable For Legal Reasons "500": description: Internal Server Error "501": description: Not Implemented "502": description: Bad Gateway "503": description: Service Unavailable "504": description: Gateway Timeout "505": description: HTTP Version Not Supported "511": description: Network Authentication Required parameters: loc: name: loc in: path description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using an\ \ underscore, e.g., ```en_US```." required: false style: matrix schema: type: string description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using\ \ an underscore, e.g., ```en_US```." default: en_US examples: en_US: description: English (United States) value: en_US fr_FR: description: French (France) value: fr_FR de_DE: description: German (Germany) value: de_DE x-matrixParamPath: / cur: name: cur in: path description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." required: false style: matrix schema: type: string description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." default: USD examples: FJD: description: Fiji Dollar value: FJD MXN: description: Mexican Peso value: MXN STD: description: São Tomé / Príncipe Dobra value: STD LVL: description: Latvian Lats value: LVL SCR: description: Seychelles Rupee value: SCR CDF: description: Congolese Franc value: CDF BBD: description: Barbados Dollar value: BBD GTQ: description: Guatemalan Quetzal value: GTQ CLP: description: Chilean Peso value: CLP HNL: description: Honduran Lempira value: HNL UGX: description: Ugandan Shilling value: UGX ZAR: description: South African Rand value: ZAR TND: description: Tunisian Dinar value: TND BSD: description: Bahamian Dollar value: BSD SLL: description: Sierra Leonean Leone value: SLL SDG: description: Sudanese Pound value: SDG IQD: description: Iraqi Dinar value: IQD CUP: description: Cuban Peso value: CUP GMD: description: Gambian Dalasi value: GMD TWD: description: New Taiwan Dollar value: TWD RSD: description: Serbian Dinar value: RSD ZRZ: description: Zaire value: ZRZ DOP: description: Dominican Peso value: DOP KMF: description: Comoro Franc value: KMF MYR: description: Malaysian Ringgit value: MYR FKP: description: Falkland Islands Pound value: FKP XOF: description: CFA Franc BCEAO value: XOF GEL: description: Lari value: GEL UYU: description: Uruguayan Peso value: UYU MAD: description: Moroccan Dirham value: MAD CVE: description: Cape Verde Escudo value: CVE TOP: description: Tongan Pa'anga value: TOP AZN: description: Azerbaijanian Manat value: AZN OMR: description: Omani Rial value: OMR PGK: description: Papua New Guinean Kina value: PGK KES: description: Kenyan Shilling value: KES SEK: description: Swedish Krona value: SEK BTN: description: Ngultrum value: BTN UAH: description: Ukrainian Hryvnia value: UAH GNF: description: Guinea Franc value: GNF ERN: description: Nakfa value: ERN MZN: description: Mozambican Metical value: MZN SVC: description: Salvadoran Colón value: SVC ARS: description: Argentine Peso value: ARS QAR: description: Qatari Riyal value: QAR IRR: description: Iranian Rial value: IRR NLG: description: Dutch Guilder value: NLG MRO: description: Mauritanian Ouguiya value: MRO CNY: description: Yuan Renminbi value: CNY THB: description: Thai Baht value: THB UZS: description: Uzbekistani Som value: UZS XPF: description: CFP Franc value: XPF BDT: description: Bangladeshi Taka value: BDT LYD: description: Libyan Dinar value: LYD BMD: description: Bermudian Dollar value: BMD KWD: description: Kuwaiti Dinar value: KWD PHP: description: Philippine Peso value: PHP RUB: description: Russian Ruble value: RUB PYG: description: Paraguayan Guarani value: PYG ISK: description: Iceland Krona value: ISK JMD: description: Jamaican Dollar value: JMD GWP: description: Guinea Peso value: GWP BEF: description: Belgian Franc value: BEF ESP: description: Spanish Peseta value: ESP COP: description: Colombian Peso value: COP MKD: description: Denar value: MKD USD: description: US Dollar value: USD DZD: description: Algerian Dinar value: DZD PAB: description: Panamanian Balboa value: PAB SGD: description: Singapore Dollar value: SGD ETB: description: Ethiopian Birr value: ETB KGS: description: Som value: KGS SOS: description: Somali Shilling value: SOS VEF: description: Venezuelan Bolivar Fuerte value: VEF VUV: description: Vanuatu Vatu value: VUV LAK: description: Lao Kip value: LAK BND: description: Brunei Dollar value: BND ZMK: description: Zambian Kwacha value: ZMK XAF: description: CFA Franc BEAC value: XAF LRD: description: Liberian Dollar value: LRD ATS: description: Austrian Schilling value: ATS CHF: description: Swiss Franc value: CHF HRK: description: Croatian Kuna value: HRK ITL: description: Italian Lira value: ITL ALL: description: Albanian Lek value: ALL DJF: description: Djibouti Franc value: DJF MTL: description: Maltese Lira value: MTL TZS: description: Tanzanian Shilling value: TZS VND: description: Vietnamese Dong value: VND AUD: description: Australian Dollar value: AUD ILS: description: New Israeli Sheqel value: ILS GHS: description: Ghanaian Cedi value: GHS GYD: description: Guyanese Dollar value: GYD KPW: description: North Korean Won value: KPW BOB: description: Boliviano value: BOB KHR: description: Cambodian Riel value: KHR MDL: description: Moldovan Leu value: MDL IDR: description: Indonesian Rupiah value: IDR KYD: description: Cayman Islands Dollar value: KYD AMD: description: Armenian Dram value: AMD BWP: description: Botswana Pula value: BWP SHP: description: Saint Helena Pound value: SHP TRY: description: Turkish Lira value: TRY CYP: description: Cyprus Pound value: CYP LBP: description: Lebanese Pound value: LBP TJS: description: Tajikistani Somoni value: TJS JOD: description: Jordanian Dinar value: JOD AED: description: United Arab Emirates Dirham value: AED HKD: description: Hong Kong Dollar value: HKD RWF: description: Rwanda Franc value: RWF EUR: description: Euro value: EUR LSL: description: Lesotho Loti value: LSL DKK: description: Danish Krone value: DKK CAD: description: Canadian Dollar value: CAD BGN: description: Bulgarian Lev value: BGN EEK: description: Estonian Kroon value: EEK MMK: description: Kyat value: MMK MUR: description: Mauritian Rupee value: MUR NOK: description: Norwegian Krone value: NOK SYP: description: Syrian Pound value: SYP ZWL: description: Zimbabwean Dollar value: ZWL GIP: description: Gibraltar Pound value: GIP RON: description: Romanian New Leu value: RON LKR: description: Sri Lankan Rupee value: LKR NGN: description: Nigerian Naira value: NGN CRC: description: Costa Rican Colon value: CRC CZK: description: Czech Koruna value: CZK IEP: description: Irish Pound value: IEP PKR: description: Pakistani Rupee value: PKR GRD: description: Greek Drachma value: GRD XCD: description: East Carribean Dollar value: XCD ANG: description: Netherlands Antillian Guilder value: ANG HTG: description: Haitian Gourde value: HTG BHD: description: Bahraini Dinar value: BHD SIT: description: Slovenian Tolar value: SIT PTE: description: Portuguese Escudo value: PTE BPP: description: Bonus Point Price value: BPP KZT: description: Kazakhstani Tenge value: KZT SRD: description: Surinam Dollar value: SRD SZL: description: Swazi Lilangeni value: SZL LTL: description: Lithuanian Litas value: LTL SAR: description: Saudi Riyal value: SAR TTD: description: Trinidad and Tobago Dollar value: TTD YER: description: Yemeni Rial value: YER MVR: description: Maldivian Rufiyaa value: MVR AFN: description: Afghani value: AFN BPV: description: Bonus Point Value value: BPV INR: description: Indian Rupee value: INR AWG: description: Aruban Florin value: AWG KRW: description: South Korean Won value: KRW NPR: description: Nepalese Rupee value: NPR JPY: description: Japanese Yen value: JPY MNT: description: Mongolian Tugrik value: MNT AOA: description: Angolan Kwanza value: AOA PLN: description: Polish Złoty value: PLN GBP: description: Pound Sterling value: GBP SBD: description: Solomon Islands Dollar value: SBD HUF: description: Hungarian Forint value: HUF BYR: description: Belarussian Ruble value: BYR LUF: description: Luxembourgian Franc value: LUF BIF: description: Burundi Franc value: BIF MWK: description: Malawian Kwacha value: MWK MGA: description: Malagasy Ariary value: MGA FIM: description: Finnish Mark value: FIM BZD: description: Belize Dollar value: BZD DEM: description: Deutsche Mark value: DEM BAM: description: Convertible Marks value: BAM EGP: description: Egyptian Pound value: EGP MOP: description: Macanese Pataca value: MOP NAD: description: Namibian Dollar value: NAD SKK: description: Slovakian Krona value: SKK NIO: description: Cordoba Oro value: NIO PEN: description: Peruvian Nuevo Sol value: PEN NZD: description: New Zealand Dollar value: NZD WST: description: Samoan Tala value: WST TMT: description: Turkmenistani Manat value: TMT FRF: description: French Franc value: FRF BRL: description: Brazilian Real value: BRL x-matrixParamPath: / regionals: name: regionals in: path required: false style: matrix schema: type: object properties: loc: type: string description: The locale ID example: en_US cur: type: string description: The currency code example: EUR x-matrixParamPath: / pgid: name: pgid in: path description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 spgid: name: spgid in: path description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 securitySchemes: bearerAuth: type: http description: "Bearer token authentication. A request contains a header field\ \ in the form of authorization: ```Bearer ```, where is a string\ \ generated by an authentication service in response to a login request." scheme: bearer bearerFormat: JWT basicAuth: type: http description: "Basic access authentication. In basic authentication, a request\ \ contains a header field in the form of authorization: ```Basic ```,\ \ where credentials is the Base64 encoding of ID and password joined by a\ \ single colon :." scheme: basic authToken: type: apiKey description: User authentication token to authenticate the request. The token is a string generated by the ICM server in the same header in every response of an REST endpoint. name: authentication-token in: header x-apiID: ppcp_basket_ext_v1 x-apiMediaType: application/vnd.intershop.basket.v1+json x-strict-apiMediaType: "true" x-origin-class: "com.intershop.component.rest.capi.resource.RootResource,com.intershop.adapter.payment.paypal.checkout.capi.rest.PaymentItemPaypalExperienceContextResource"