Related Documents
Document Properties
Kbid28L706
Last Modified23-Jun-2020
Added to KB22-Aug-2018
Public AccessEveryone
StatusOnline
Doc TypeReferences
ProductICM 7.8

REST API - Get transaction details for business customer's recurring order (7.8)

URI

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

Http Method

POST

Short Description

Transfer payment transaction information from the payment service provider, via the REST client to the shop system to activate there the payment transaction for the recurring order of a business customer.

Query Parameters

  • redirectType
  • name
  • properties

Example Requests

/customers/AgroNet/users/educking@test.intershop.de/recurringorders/iLQKDgAe_C8AAAFWoUIjwMCl/payments/XrUKAB17fbUAAAFG6DEd6nBs/redirect

HTTP Status Codes

  • 200 OK
  • 400 Bad Request
  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not Found

Description

Once the payment transaction has been successfully processed at the payment provider's system, the user will be redirected back to his REST client. This return redirect contains various payment transaction attributes which must be transferred from the REST client back to the shop system to process the payment transaction. The redirect POST requests transfers this data from the REST client into the shop system so that the payment transaction can be activated there. For instance:

  • Transaction ID
  • Transaction status
  • And so on

Cartridge

app_sf_rest
ApplicationB2C Web Shop, SMB Web Shop

Product Version

7.8

Product To Version

7.8
Status

final

JSON

Request data format

application/json

Request related java object

com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResource

Request data example

{
    "redirectType":"checkout",
    "name":null,
    "parameters":
            [
 
                {
                    "key":"XID",
                    "property":"789"
                },
 
                {
                    "key":"CAVV",
                    "property":"456"
                },
 
                {
                    "key":"ECI",
                    "property":"123"
                }
 
            ]
}

Response data format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResource

Response data example

{
  "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

Request data format

text/xml

Request related java object

com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResource

Request data example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Payment name="ISH_CREDITCARD" type="Payment"
    xmlns:xs="http://www.w3.org/2001/XMLSchema" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <parameters>
        <Property name="property">
            <key>XID</key>
            <property xsi:type="xs:string">789</property>
        </Property>
        <Property name="property">
            <key>CAVV</key>
            <property xsi:type="xs:string">456</property>
        </Property>
        <Property name="property">
            <key>ECI</key>
            <property xsi:type="xs:string">123</property>
        </Property>
    </parameters>
</Payment>

Response data format

text/xml

Response related java object

com.intershop.sellside.rest.common.capi.resource.recurringorder.RecurringOrderPaymentRedirectResourc

Response data example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Payment name="ISH_CREDITCARD" type="Payment">
  <attributes>
    <ResourceAttribute name="CreditCardExpiryDate" type="String">
      <value>10/20</value>
    </ResourceAttribute>
    <ResourceAttribute name="CreditCardNumber" type="String">
      <value>************1111</value>
    </ResourceAttribute>
    <ResourceAttribute name="CreditCardType" type="CreditCardType">
      <value>vsa</value>
    </ResourceAttribute>
  </attributes>
  <props/>
</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