Related Documents
Document Properties
Kbid25486G
Last Modified23-Jun-2020
Added to KB13-Jan-2014
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9

REST API - Get details of a customer profile payment (until 7.9)

URI

/customers/-/payments/<payment-id>

Http Method

GET

Short Description

Returns the details of a payment method from the customer profile

Query Parameters

none

Example Requests

/customers/-/payments/JF8KDgAbbaYAAAFDThqSqBAE

HTTP Status Codes

200 OK
401 Unauthorized
404 Not found 

Description

Returns the details of a payment method from the customer profile

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.4

Product To Version

7.9

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.CustomerPaymentItemResource
com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO

Response Example

Example for Gift Cards:

{
    "name": "BPS_GIFT_CARD",
    "type": "Payment",
    "attributes": [
        {
            "name": "GiftCardNumber",
            "type": "String",
            "value": "11111111111"
        },
        {
            "name": "GiftCardPIN",
            "type": "String",
            "value": "1111"
        },
        {
            "name": "GiftCardType",
            "type": "String",
            "value": "PHYSICAL"
        },
        {
            "name": "GiftCardID",
            "type": "String",
            "value": "rfMKDgAb4QQAAAFClcidbNbm"
        }
    ]
}

Example for Debit Transfer Account:

{
    "name": "BPS_DEBIT_TRANSFER",
    "type": "Payment",
    "attributes": [
        {
            "name": "AccountNumber",
            "type": "String",
            "value": "123456"
        },
        {
            "name": "AccountHolder",
            "type": "String",
            "value": "Patricia Miller"
        },
        {
            "name": "BankCode",
            "type": "String",
            "value": "83053030"
        }
    ]
}

Example for a simple payment method:

{
    "name": "BPS_CASH_ON_DELIVERY",
    "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.resource.customer.payment.CustomerPaymentItemResource
com.intershop.sellside.rest.common.capi.resourceobject.basket.PaymentRO

XML Response Example

Example for Gift Cards:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Payment name="BPS_GIFT_CARD" type="Payment">
    <attributes>
        <ResourceAttribute name="GiftCardNumber" type="String">
            <value>11111111111</value>
        </ResourceAttribute>
        <ResourceAttribute name="GiftCardPIN" type="String">
            <value>1111</value>
        </ResourceAttribute>
        <ResourceAttribute name="GiftCardType" type="String">
            <value>PHYSICAL</value>
        </ResourceAttribute>
        <ResourceAttribute name="GiftCardID" type="String">
            <value>rfMKDgAb4QQAAAFClcidbNbm</value>
        </ResourceAttribute>
    </attributes>
</Payment>

Example for Debit Transfer Account:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Payment name="BPS_DEBIT_TRANSFER" type="Payment">
    <attributes>
        <ResourceAttribute name="AccountNumber" type="String">
            <value>123456</value>
        </ResourceAttribute>
        <ResourceAttribute name="AccountHolder" type="String">
            <value>Patricia Miller</value>
        </ResourceAttribute>
        <ResourceAttribute name="BankCode" type="String">
            <value>83053030</value>
        </ResourceAttribute>
    </attributes>
</Payment>

Example for a simple payment method:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Payment name="BPS_CASH_ON_DELIVERY" type="Payment"/>

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