Related Documents
Document Properties
Kbid28306K
Last Modified23-Jun-2020
Added to KB21-Jun-2017
Public AccessEveryone
StatusOnline
Doc TypeReferences
ProductICM 7.9

REST API - Return payment options for basket (7.9)

URI

/baskets/<basket-id>/payments

Http Method

OPTIONS

Short Description

Returns all available payment methods and their parameters available for this basket

Query Parameters

none

Example Requests

/baskets/BKQKDgAbx6AAAAFCE7KgbJli/payments

HTTP Status Codes

200 OK

Description

Returns all available payment methods and their parameters, which are available for this basket

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Access Restrictions

Requires authentication with user having assigned the following permissions:

  • Purchase (APP_B2B_PURCHASE, only in B2B applications)

Product Version

7.9

Product To Version

7.9
Status

final

JSON

Request Data Format

application/json

Request related java object

n/a

Request Example

n/a

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentOptionsRO
com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource

Response Example

{
  "name": "paymentOptions",
  "type": "PaymentOptions",
  "methods": [
    {
      "name": "paymentOptionsForMethodRO",
      "type": "PaymentOptionsForMethodRO",
      "payments": [
        {
          "name": "paymentOption",
          "type": "PaymentOption",
          "id": "ISH_CREDITCARD",
          "displayName": "ISH Demo Credit Card",
          "paymentParameters": [
            {
              "name": "property",
              "type": "String",
              "key": "creditCardNumber"
            },
            {
              "name": "property",
              "type": "CreditCardType",
              "key": "creditCardType"
            },
            {
              "name": "property",
              "type": "String",
              "key": "creditCardExpiryDate"
            }
          ]
        },
        {
          "name": "paymentOption",
          "type": "PaymentOption",
          "id": "ISH_ONLINEPAY",
          "displayName": "ISH Demo Online Pay",
          "paymentParameters": []
        },
        {
          "name": "paymentOption",
          "type": "PaymentOption",
          "id": "ISH_CASH_ON_DELIVERY",
          "displayName": "Cash on Delivery",
          "paymentParameters": []
        },
        {
          "name": "paymentOption",
          "type": "PaymentOption",
          "id": "ISH_DEBIT_TRANSFER",
          "displayName": "Direct Debit Transfer",
          "paymentParameters": [
            {
              "name": "property",
              "type": "String",
              "key": "holder"
            },
            {
              "name": "property",
              "type": "String",
              "key": "IBAN"
            },
            {
              "name": "property",
              "type": "String",
              "key": "BIC"
            }
          ]
        },
        {
          "name": "paymentOption",
          "type": "PaymentOption",
          "id": "ISH_INVOICE",
          "displayName": "Invoice",
          "paymentParameters": []
        },
        {
          "name": "paymentOption",
          "type": "PaymentOption",
          "id": "ISH_GIFT_CARD",
          "displayName": "Gift Card / Certificate",
          "paymentParameters": [
            {
              "name": "property",
              "type": "String",
              "key": "giftCardNumber"
            },
            {
              "name": "property",
              "type": "String",
              "key": "giftCardPIN"
            }
          ]
        },
        {
          "name": "paymentOption",
          "type": "PaymentOption",
          "id": "ISH_CASH_IN_ADVANCE",
          "displayName": "Cash in Advance",
          "paymentParameters": []
        },
        {
          "name": "paymentOption",
          "type": "PaymentOption",
          "id": "ISH_FASTPAY",
          "displayName": "ISH Demo Fast Pay",
          "paymentParameters": []
        }
      ],
      "method": "POST"
    }
  ]
}

XML

XML Request Data Format

text/xml

XML Request Java Objects

n/a

XML Request Example

n/a

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentOptionsRO
com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentResource

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PaymentOptions name="paymentOptions" type="PaymentOptions">
    <PaymentOptionsForMethodRO name="paymentOptionsForMethodRO" type="PaymentOptionsForMethodRO">
        <method>POST</method>
        <payments name="paymentOption" type="PaymentOption">
            <displayName>ISH Demo Credit Card</displayName>
            <id>ISH_CREDITCARD</id>
            <parameters>
                <Property name="property" type="String">
                    <key>creditCardNumber</key>
                </Property>
                <Property name="property" type="CreditCardType">
                    <key>creditCardType</key>
                </Property>
                <Property name="property" type="String">
                    <key>creditCardExpiryDate</key>
                </Property>
            </parameters>
        </payments>
        <payments name="paymentOption" type="PaymentOption">
            <displayName>ISH Demo Online Pay</displayName>
            <id>ISH_ONLINEPAY</id>
            <parameters/>
        </payments>
        <payments name="paymentOption" type="PaymentOption">
            <displayName>Cash on Delivery</displayName>
            <id>ISH_CASH_ON_DELIVERY</id>
            <parameters/>
        </payments>
        <payments name="paymentOption" type="PaymentOption">
            <displayName>Direct Debit Transfer</displayName>
            <id>ISH_DEBIT_TRANSFER</id>
            <parameters>
                <Property name="property" type="String">
                    <key>holder</key>
                </Property>
                <Property name="property" type="String">
                    <key>IBAN</key>
                </Property>
                <Property name="property" type="String">
                    <key>BIC</key>
                </Property>
            </parameters>
        </payments>
        <payments name="paymentOption" type="PaymentOption">
            <displayName>Invoice</displayName>
            <id>ISH_INVOICE</id>
            <parameters/>
        </payments>
        <payments name="paymentOption" type="PaymentOption">
            <displayName>Gift Card / Certificate</displayName>
            <id>ISH_GIFT_CARD</id>
            <parameters>
                <Property name="property" type="String">
                    <key>giftCardNumber</key>
                </Property>
                <Property name="property" type="String">
                    <key>giftCardPIN</key>
                </Property>
            </parameters>
        </payments>
        <payments name="paymentOption" type="PaymentOption">
            <displayName>Cash in Advance</displayName>
            <id>ISH_CASH_IN_ADVANCE</id>
            <parameters/>
        </payments>
        <payments name="paymentOption" type="PaymentOption">
            <displayName>ISH Demo Fast Pay</displayName>
            <id>ISH_FASTPAY</id>
            <parameters/>
        </payments>
    </PaymentOptionsForMethodRO>
</PaymentOptions>

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets