Related Documents
Document Properties
Kbid25V396
Last Modified23-Jun-2020
Added to KB02-Dec-2013
Public AccessEveryone
StatusOnline
Doc TypeReferences

REST API - Return payment options for basket (valid from 7.4 to 7.4 CI)

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

Product Version

7.4

Product To Version

7.4.6

Status

final

JSON

Request Data Format

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": [
        {
            "type": "PaymentOption",
            "method": "POST",
            "payments": [
                {
                    "name": "BPS_CREDITCARD",
                    "type": "Payment"
                },
                {
                    "name": "BPS_CASH_ON_DELIVERY",
                    "type": "Payment"
                },
                {
                    "name": "BPS_DEBIT_TRANSFER",
                    "type": "Payment",
                    "id": "[String] The ID of a stored account"
                },
                {
                    "name": "BPS_DEBIT_TRANSFER",
                    "type": "Payment",
                    "accountNumber": "[String] The account number",
                    "accountHolder": "[String] The name of the account holder",
                    "bankCode": "[String] The code for the bank"
                },
                {
                    "name": "BPS_ONLINEPAY",
                    "type": "Payment"
                },
                {
                    "name": "BPS_INVOICE",
                    "type": "Payment"
                },
                {
                    "name": "BPS_GIFT_CARD",
                    "type": "Payment",
                    "id": "[String] The ID of a stored Gift Card"
                },
                {
                    "name": "BPS_GIFT_CARD",
                    "type": "Payment",
                    "giftCardPIN": "[String] The PIN for the Gift Card",
                    "giftCardNumber": "[String] The number of the Gift Card"
                },
                {
                    "name": "BPS_CASH_IN_ADVANCE",
                    "type": "Payment"
                },
                {
                    "name": "BPS_FASTPAY",
                    "type": "Payment"
                }
            ]
        }
    ]
}

XML

XML Request Data Format

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">
    <methods type="PaymentOption">
        <method>POST</method>
        <payments name="BPS_CREDITCARD" type="Payment"/>
        <payments name="BPS_CASH_ON_DELIVERY" type="Payment"/>
        <payments name="BPS_DEBIT_TRANSFER" type="Payment">
            <id>[String] The ID of a stored account</id>
        </payments>
        <payments name="BPS_DEBIT_TRANSFER" type="Payment">
            <accountHolder>[String] The name of the account holder</accountHolder>
            <accountNumber>[String] The account number</accountNumber>
            <bankCode>[String] The code for the bank</bankCode>
        </payments>
        <payments name="BPS_ONLINEPAY" type="Payment"/>
        <payments name="BPS_INVOICE" type="Payment"/>
        <payments name="BPS_GIFT_CARD" type="Payment">
            <id>[String] The ID of a stored Gift Card</id>
        </payments>
        <payments name="BPS_GIFT_CARD" type="Payment">
            <giftCardNumber>[String] The number of the Gift Card</giftCardNumber>
            <giftCardPIN>[String] The PIN for the Gift Card</giftCardPIN>
        </payments>
        <payments name="BPS_CASH_IN_ADVANCE" type="Payment"/>
        <payments name="BPS_FASTPAY" type="Payment"/>
    </methods>
</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