Skip to content

REST API ICEX1 Connect

API URL = https://connect.icepay.com/webservice/api/v1/
We'll be adding the following fields to our API.

ShoppingCartType

This categorizes the shopping cart of a checkout based on the properties of the goods it contains.

  • PHYSICAL: The shopping cart contains only physical goods.

  • DIGITAL: The shopping cart contains only digital goods.

Depending on the value of ShoppingCartType, the following newly added fields are either mandatory or optional:

  • ShippingAddress.FirstName
  • ShippingAddress.LastName
  • ShippingAddress.PostalCode
  • ShippingAddress.City
  • ShippingAddress.Country
  • ShippingAddress.Email

Warning

Note that ShippingAddress is a JSON object

To determine which fields are mandatory or optional (based on the value of ShoppingCartType), we provide the following table.

ShoppingCartType PHYSICAL DIGITAL
FirstName Mandatory Mandatory
LastName Mandatory Mandatory
PostalCode Mandatory Optional
City Mandatory Optional
Country Mandatory Optional
Email Optional Mandatory

Some examples on our API

PHYSICAL

{
"Timestamp" : "{{timestamp}}",
    "Amount": 1000,
    "Country": "nl",
    "Currency": "eur",
    "Description": "",
    "Issuer": "DEFAULT",
    "Language": "en",
    "OrderID": "",
    "PaymentMethod": "GIROPAY",
    "Reference": "",
    "URLCompleted": "",
    "URLError": "",
    "URLPostback": [],
    "EndUserIP": "127.0.0.1",
    "ShippingAddress": {
        "FirstName": "John",
        "LastName": "Doe",
        "PostalCode": "1114AN",
        "City": "Amsterdam",
        "Country": "NL",
    }    
    "ShoppingCartType": "PHYSICAL"
}

DIGITAL

{
"Timestamp" : "{{timestamp}}",
    "Amount": 1000,
    "Country": "nl",
    "Currency": "eur",
    "Description": "",
    "Issuer": "DEFAULT",
    "Language": "en",
    "OrderID": "",
    "PaymentMethod": "GIROPAY",
    "Reference": "",
    "URLCompleted": "",
    "URLError": "",
    "URLPostback": [],
    "EndUserIP": "127.0.0.1",
    "ShippingAddress": {
        "FirstName": "John",
        "LastName": "Doe",
        "Email": "info@icepay.com"
    },
    "ShoppingCartType": "DIGITAL"
}