REST API - Return payment options for customers


Note

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

URI

/customers/-/payments

Http Method

OPTIONS

Short Description

Returns all available payment methods that can be added to the customer

Query Parameters

none

Example Requests

/customers/-/payments

HTTP Status Codes

200 OK

Description

Returns all available payment methods and its parameters that can be added to the customer

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.6

Product To Version

 

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.customer.payment.CustomerPaymentListResource

Response Example

{
   "name":"paymentOptions",
   "type":"PaymentOptions",
   "methods":[
      {
         "name":"paymentOptionsForMethodRO",
         "type":"PaymentOptionsForMethodRO",
         "method":"POST",
         "payments":[
            {
               "name":"paymentOption",
               "type":"PaymentOption",
               "id":"BPS_CREDITCARD",
               "paymentParameters":[
                  {
                     "name":"property",
                     "type":"String",
                     "key":"creditCardNumber"
                  },
                  {
                     "name":"property",
                     "type":"String",
                     "key":"creditCardExpiryMonth"
                  },
                  {
                     "name":"property",
                     "type":"String",
                     "key":"creditCardExpiryYear"
                  },
                  {
                     "name":"property",
                     "type":"String",
                     "key":"creditCardType"
                  },
                  {
                     "name":"property",
                     "type":"String",
                     "key":"cardOwner"
                  }
               ]
            },
            {
               "name":"paymentOption",
               "type":"PaymentOption",
               "id":"BPS_FASTPAY",
               "paymentParameters":[
               ]
            },
            {
               "name":"paymentOption",
               "type":"PaymentOption",
               "id":"ISH_CASH_IN_ADVANCE",
               "paymentParameters":[
               ]
            },
            {
               "name":"paymentOption",
               "type":"PaymentOption",
               "id":"ISH_CASH_ON_DELIVERY",
               "paymentParameters":[
               ]
            },
            {
               "name":"paymentOption",
               "type":"PaymentOption",
               "id":"ISH_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_GIFT_CARD",
               "paymentParameters":[
                  {
                     "name":"property",
                     "type":"String",
                     "key":"giftCardNumber"
                  },
                  {
                     "name":"property",
                     "type":"String",
                     "key":"giftCardPIN"
                  }
               ]
            },
            {
               "name":"paymentOption",
               "type":"PaymentOption",
               "id":"ISH_INVOICE",
               "paymentParameters":[
               ]
            },
            {
               "name":"paymentOption",
               "type":"PaymentOption",
               "id":"ISH_INVOICE_TOTAL_ZERO",
               "paymentParameters":[
               ]
            }
         ]
      }
   ]
}

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.customer.payment.CustomerPaymentListResource

XML Response Example

<?xml version="1.0" encoding="UTF-8"?>
<PaymentOptions name="paymentOptions" type="PaymentOptions">
   <PaymentOptionsForMethodRO name="paymentOptionsForMethodRO" type="PaymentOptionsForMethodRO">
      <method>POST</method>
      <payments name="paymentOption" type="PaymentOption">
         <id>BPS_CREDITCARD</id>
         <parameters>
            <Property name="property" type="String">
               <key>creditCardNumber</key>
            </Property>
            <Property name="property" type="String">
               <key>creditCardExpiryMonth</key>
            </Property>
            <Property name="property" type="String">
               <key>creditCardExpiryYear</key>
            </Property>
            <Property name="property" type="String">
               <key>creditCardType</key>
            </Property>
            <Property name="property" type="String">
               <key>cardOwner</key>
            </Property>
         </parameters>
      </payments>
      <payments name="paymentOption" type="PaymentOption">
         <id>BPS_FASTPAY</id>
         <parameters />
      </payments>
      <payments name="paymentOption" type="PaymentOption">
         <id>ISH_CASH_IN_ADVANCE</id>
         <parameters />
      </payments>
      <payments name="paymentOption" type="PaymentOption">
         <id>ISH_CASH_ON_DELIVERY</id>
         <parameters />
      </payments>
      <payments name="paymentOption" type="PaymentOption">
         <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">
         <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">
         <id>ISH_INVOICE</id>
         <parameters />
      </payments>
      <payments name="paymentOption" type="PaymentOption">
         <id>ISH_INVOICE_TOTAL_ZERO</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