Related Documents
Document Properties
Kbid28303T
Last Modified23-Jun-2020
Added to KB21-Jun-2017
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.9
  • ICM 7.10

REST API - Get payments of basket


Note

Starting with 7.10 our REST API is documented using Redoc accessible at docs.intershop.com.

URI

/baskets/<basket-id>/payments

Http Method

GET

Short Description

Returns a list with all selected payments for the basket

Query Parameters

none

Example Requests

/baskets/maAKABvizNsAAAFCTy.JWP_H/payments

HTTP Status Codes

200 OK
401 Unauthorized
403 Forbidden
404 Not found (basket not found)

Description

Returns a list of links of all selected payment methods for the 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


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.component.rest.capi.resourceobject.LinkRO
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO

Response Example

{
    "elements": [
        {
            "type": "Link",
            "title": "BPS_DEBIT_TRANSFER",
            "uri": "PrimeTech-PrimeTechSpecials-Site/-/baskets/W1oKDgAbKPwAAAFDeTyXcGaV/payments/0VAKDgAbdb0AAAFDrbCXcGfT"
        },
        {
            "type": "Link",
            "title": "BPS_GIFT_CARD",
            "uri": "PrimeTech-PrimeTechSpecials-Site/-/baskets/W1oKDgAbKPwAAAFDeTyXcGaV/payments/u20KDgAbV2IAAAFDe96XcGfO"
        },
        {
            "type": "Link",
            "title": "BPS_CASH_ON_DELIVERY",
            "uri": "PrimeTech-PrimeTechSpecials-Site/-/baskets/W1oKDgAbKPwAAAFDeTyXcGaV/payments/T7sKDgAb6MkAAAFDG_iXcGfJ"
        }
    ],
    "type": "ResourceCollection"
}

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.component.rest.capi.resourceobject.LinkRO
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection type="ResourceCollection">
    <elements>
        <Link type="Link">
            <title>BPS_DEBIT_TRANSFER</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/-/baskets/W1oKDgAbKPwAAAFDeTyXcGaV/payments/0VAKDgAbdb0AAAFDrbCXcGfT</uri>
        </Link>
        <Link type="Link">
            <title>BPS_GIFT_CARD</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/-/baskets/W1oKDgAbKPwAAAFDeTyXcGaV/payments/u20KDgAbV2IAAAFDe96XcGfO</uri>
        </Link>
        <Link type="Link">
            <title>BPS_CASH_ON_DELIVERY</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/-/baskets/W1oKDgAbKPwAAAFDeTyXcGaV/payments/T7sKDgAb6MkAAAFDG_iXcGfJ</uri>
        </Link>
    </elements>
</ResourceCollection>

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