Related Documents
Document Properties
Kbid2830G1
Last Modified14-Sep-2018
Added to KB21-Jun-2017
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.9
  • ICM 7.10

REST API - Get transaction details after redirect before checkout


Note

Starting with 7.10 our REST API is documented using Swagger notation accessible at developer.cloud.intershop.com.

URI

/baskets/<basket-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 the payment transaction there

Query Parameters

  • redirectType
  • name
  • properties

Example Requests

/baskets/5B0KAB17NC8AAAFGWzgd6nBq/payments/XrUKAB17fbUAAAFG6DEd6nBs/redirect

HTTP Status Codes

  • 200 ok
  • 400 bad request
  • 401 unauthorized
  • 403 forbidden
  • 404 not found

Description

If the user has processed his payment transaction successfully at the payment providers system, he 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
Access Restrictions

Requires authentication with user having assigned the following permissions:

  • Purchase (APP_B2B_PURCHASE, only in B2B applications)

Product Version

7.9

Product To Version

 
Status

final

JSON

Request data format

application/json

Request related java object

com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentRedirectResource

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.basket.BasketPaymentRedirectResource

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.basket.BasketPaymentRedirectResource

Request data example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PaymentRedirectResponse 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>
</PaymentRedirectResponse>

Response data format

text/xml

Response related java object

com.intershop.sellside.rest.common.capi.resource.basket.BasketPaymentRedirectResource

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