Related Documents
Document Properties
Kbid2X8539
Last Modified23-Jun-2020
Added to KB08-Jan-2018
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Get payment details of business customer's recurring order payments


Note

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

URI

/customers/<customer-id>/users/<user-id>/recurringorders/<recurringorder-id>/payments/<payment-id>

Http Method

GET

Short Description

Returns details of the payment method

Query Parameters

none

Example Requests

/customers/AgroNet/users/educking@test.intershop.de/recurringorders/iLQKDgAe_C8AAAFWoUIjwMCl/payments/5FcKABviZ.kAAAFC2ROJWP._

HTTP Status Codes

200 OK
401 Unauthorized
403 Forbidden
404 Not found

Description

Returns details of the selected payment method for the recurring order of a business customer

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.8

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

Response Example

Example for gift cards:

{
  "name": "ISH_GIFT_CARD",
  "type": "Payment",
  "attributes": [
    {
      "name": "giftCardNumber",
      "type": "String",
      "value": "*******1049"
    },
    {
      "name": "giftCardPIN",
      "type": "String",
      "value": "_PROVIDED_"
    }
  ],
  "id": "ISH_GIFT_CARD",
  "parameters": []
}

Example for debit transfer account:

{
  "name": "ISH_DEBIT_TRANSFER",
  "type": "Payment",
  "attributes": [
    {
      "name": "holder",
      "type": "String",
      "value": "Susi Franke"
    },
    {
      "name": "IBAN",
      "type": "String",
      "value": "*******************6789"
    },
    {
      "name": "BIC",
      "type": "String",
      "value": "12345678"
    }
  ],
  "id": "ISH_DEBIT_TRANSFER",
  "parameters": []
}

Example for a simple payment method:

{
  "name": "ISH_INVOICE",
  "type": "Payment",
  "id": "ISH_INVOICE",
  "parameters": []
}

Example for credit card:

{
  "name": "ISH_CREDITCARD",
  "type": "Payment",
  "attributes": [
    {
      "name": "creditCardNumber",
      "type": "String",
      "value": "************1111"
    },
    {
      "name": "creditCardType",
      "type": "CreditCardType",
      "value": "vsa"
    },
    {
      "name": "creditCardExpiryDate",
      "type": "String",
      "value": "12/20"
    }
  ],
  "id": "ISH_CREDITCARD",
  "parameters": []
}

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.resource.recurringorder.RecurringOrderPaymentItemResource
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="ISH_GIFT_CARD" type="Payment">
    <attributes>
        <ResourceAttribute name="giftCardNumber" type="String">
            <value>*******1049</value>
        </ResourceAttribute>
        <ResourceAttribute name="giftCardPIN" type="String">
            <value>_PROVIDED_</value>
        </ResourceAttribute>
    </attributes>
    <id>ISH_GIFT_CARD</id>
    <parameters/>
</Payment>

Example for debit transfer account:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Payment name="ISH_DEBIT_TRANSFER" type="Payment">
    <attributes>
        <ResourceAttribute name="holder" type="String">
            <value>Susi Franke</value>
        </ResourceAttribute>
        <ResourceAttribute name="IBAN" type="String">
            <value>*******************6789</value>
        </ResourceAttribute>
        <ResourceAttribute name="BIC" type="String">
            <value>12345678</value>
        </ResourceAttribute>
    </attributes>
    <id>ISH_DEBIT_TRANSFER</id>
    <parameters/>
</Payment>

Example for a simple payment method:

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

Example for credit card:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Payment name="ISH_CREDITCARD" type="Payment">
    <attributes>
        <ResourceAttribute name="creditCardNumber" type="String">
            <value>************1111</value>
        </ResourceAttribute>
        <ResourceAttribute name="creditCardType" type="CreditCardType"/>
        <ResourceAttribute name="creditCardExpiryDate" type="String">
            <value>12/20</value>
        </ResourceAttribute>
    </attributes>
    <id>ISH_CREDITCARD</id>
    <parameters/>
</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
Tickets