Related Documents
Document Properties
Kbid
25485F
Last Modified
23-Jun-2020
Added to KB
13-Jan-2014
Public Access
Everyone
Status
Online
Doc Type
References
Product
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Get list of Customer profile payments


Note

Starting with Intershop 7.10 our REST API is provided in the Open API 3.0 format, see Reference - Intershop Commerce Management REST API 7.10.

URI

/customers/-/payments

Http Method

GET

Short Description

Returns a list of payment methods of the customer profile

Query Parameters

none

Example Requests

/customers/-/payments

HTTP Status Codes

200 OK
401 Unauthorized

Description

Returns a list of all payment methods that are store in the customer profile of the logged in customer.

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.4

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.sellside.rest.common.capi.resource.customer.payment.CustomerPaymentListResource
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO

Response Example

{
    "elements": [
        {
            "type": "Link",
            "uri": "PrimeTech-PrimeTechSpecials-Site/-/customers/-/payments/JD8KDgAb_YAAAAFDDXOSqA__",
            "title": "BPS_DEBIT_TRANSFER"
        },
        {
            "type": "Link",
            "uri": "PrimeTech-PrimeTechSpecials-Site/-/customers/-/payments/UQMKDgAbIy8AAAFDHWeLHAUd",
            "title": "BPS_CREDITCARD"
        },
        {
            "type": "Link",
            "uri": "PrimeTech-PrimeTechSpecials-Site/-/customers/-/payments/0eEKDgAbMFYAAAFD25yLHAU3",
            "title": "BPS_GIFT_CARD"
        },
        {
            "type": "Link",
            "uri": "PrimeTech-PrimeTechSpecials-Site/-/customers/-/payments/YS0KDgAbi3cAAAFDzEGP8HsK",
            "title": "BPS_CASH_ON_DELIVERY"
        },
    ],
    "type": "ResourceCollection",
    "name": "payments"
}

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.resource.customer.payment.CustomerPaymentListResource
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="payments" type="ResourceCollection">
    <elements>
        <Link type="Link">
            <title>BPS_DEBIT_TRANSFER</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/-/customers/-/payments/JD8KDgAb_YAAAAFDDXOSqA__</uri>
        </Link>
        <Link type="Link">
            <title>BPS_CREDITCARD</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/-/customers/-/payments/UQMKDgAbIy8AAAFDHWeLHAUd</uri>
        </Link>
        <Link type="Link">
            <title>BPS_GIFT_CARD</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/-/customers/-/payments/0eEKDgAbMFYAAAFD25yLHAU3</uri>
        </Link>
        <Link type="Link">
            <title>BPS_CASH_ON_DELIVERY</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/-/customers/-/payments/YS0KDgAbi3cAAAFDzEGP8HsK</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
Tickets