More about Create

MerchantOrder Object

This object describes the retailer's payment order.

Parameter	Description	Type	Size	Example
Id	Order identifier used by the retailer. This field is optional, but should be left blank only by retailers that do not handle this information.	String	20	1257981
TotalAmount	Full order amount, including tax and delivery costs	Amount		70.00
VatAmount	Tax amount	Amount		13.72
Currency	Order currency	Currency	3	EUR
Customer	Customer information	Customer		See corresponding XML object
ShippingAddress	Delivery address	Address		See corresponding XML object
BillingAddress	Billing address	Address		See corresponding XML object
CartItems	Details of shopping cart content	Cartitem[]		See corresponding XML object
RawCustom1	Free text field	String	500
RawCustom2	Free text field	String	500
RawCustom3	Free text field	String	500
SearchableCustom1	Can be used to specify a value that will be indexed to optimize search queries	String	20
SearchableCustom2	Can be used to specify a value that will be indexed to optimize search queries	String	20

Customer Object

Information concerning the user

Parameter	Description	Type	Size	Example
CompanyName	Company	String	50	Thunes
Title	Mr, Mrs, Dr, etc.	String	20	Mr
Type	Customer type Accepted values: Professional / Individual	String	20	Individual
Id	Customer identifier used by the retailer	String	50	123abc
FirstName	Customer's first name	String	50	John
LastName	Customer's surname	String	50	Doe
Email	Customer's email address	String	100	[email protected]
HomePhone	Customer's home phone number	String	50	+442012345678
MobilePhone	Customer's mobile phone number	String	50	+442012345678
RawCustom	Free text field	String	500
Culture	Language and country, codified according to ISO 639 and ISO 3166	String	20	en-GB

ShippingAddress and BillingAddress Objects

Delivery address and billing address

Parameter	Description	Type	Size	Example
CompanyName	Company	String	50	Thunes
Title	Mr, Mrs, Dr, etc.	String	20	Mr
FirstName	Customer's first name	String	50	John
LastName	Customer's surname	String	50	Doe
Address1	Address line 1	String	100	123, Main Street
Address2	Address line 2	String	100	Door A
ZipCode	Postal code	String	20	PO17 6DZ
City	City	String	50	Southwick
Country	Country using ISO 3166-2 code	String	2	FR
HomePhone	Customer's home phone number	String	50	+442012345678
MobilePhone	Customer's mobile phone number	String	50	+442012345678
RawCustom	Free text field	String	500

CartItem Object

Detailed information on one shopping cart item (in a CartItems object)

Parameter	Description	Type	Size	Example
Id	Article identifier used by the retailer	String	200	R49203
Label	Retailer's description of the article	String	200
UnitPrice	Article unit price	Amount		65.00
VAT	Tax amount	Amount		13.00
Quantity	Article quantity in the shopping cart	Integer		1
Category	Category Thunes Collections product category Accepted values: ComputersAndSoftware / Electronics / Phones / Appliances / HomeAndGarden / Fashion / HealthAndBeauty / Jewellery / Sport / LeisureAndHobbies / CarsAndMotorbikes / Furniture / / KidsAndBaby / VideoGamesAndConsoles / ToysAndGames / Pets / FoodAndDrink / GiftAndFlowers / Entertainment / Travel / AuctionsAndGroupBuying / ServicesForIndividuals / ServicesForProfessionals	String	100	LeisureAndHobbies
MerchantCategory1	Main retail category with which the article is associated	String	100	568
MerchantCategory2	Secondary retail category with which the article is associated	String	100	MP3 Players
Brand	Article brand	String	100	LG
Url	Article URL	String	2083
Delivery	Delivery method	Delivery		See corresponding XML object
RawCustom	Free text field	String	500

Delivery Object

About Delivery

Parameter	Description	Type	Size	Example
Type	Delivery type Accepted values: StorePickup NetworkPickup TravelPickup Carrier EDelivery Other	String	20	Carrier
Label	Delivery type name	String	20	COLISSIMO
Speed	Delivery lead time Accepted values: Express (within 48 hours or less) / Standard (other)	String	20	Standard
ExpectedDate	Expected delivery date	Datetime		2013-06-11T16:32:11Z
ExpectedDelay	Number of days allowed for delivery	Integer		15
RawCustom	Free text field	String	500

Full example

{
  "PaymentOrder": {
    "MerchantId": "citronrose-fr",
    "PaymentPageId": "creditcard",
    "Amount": 95.0,
    "Currency": "EUR",
    "MerchantUrls": {
      "ReturnUrl": "http://www.citronrose.com/Payment_Return.aspx",
      "AbortedUrl": "http://www.citronrose.com/Payment_Cancelled.aspx",
      "ErrorUrl": "http://www.citronrose.com/Payment_Error.aspx",
      "ServerNotificationUrl": "http://www.citronrose.com/Payment_Notification.aspx"
    },
    "MerchantOrder": {
      "Id": "1257981",
      "TotalAmount": 95.00,
      "VatAmount": 18.62,
      "Currency": "EUR",
      "Customer": {
        "CompanyName": "Thunes",
        "Type": "Individual",
        "Id": "123321",
        "Title": "M",
        "FirstName": "Jean",
        "LastName": "Dupont",
        "Email": "[email protected]",
        "HomePhone": "+33175757575",
        "MobilePhone": "+33675757575",
        "Culture": "fr-FR",
        "RawCustom": "whatever"
      },
      "ShippingAddress": {
        "CompanyName": "Thunes",
        "Title": "M",
        "FirstName": "Jean",
        "LastName": "Dupont",
        "Address1": "8, rue Saint-Fiacre",
        "Address2": "Gate A",
        "ZipCode": "75002",
        "City": "Paris",
        "Country": "FR",
        "HomePhone": "+33175757575",
        "MobilePhone": "+33675757575",
        "RawCustom": "whatever"
      },
      "BillingAddress": {
        "CompanyName": "Thunes",
        "Title": "M",
        "FirstName": "Jean",
        "LastName": "Dupont",
        "Address1": "8, rue Saint-Fiacre",
        "Address2": "Gate A",
        "ZipCode": "75002",
        "City": "Paris",
        "Country": "FR",
        "HomePhone": "+33175757575",
        "MobilePhone": "+33675757575",
        "RawCustom": "whatever"
      },
      "CartItems": [
        {
          "Id": "R49203",
          "Label": "MP3PlayerLG4Go",
          "UnitPrice": 65.00,
          "VAT": 12.74,
          "Quantity": 1,
          "Category": "Electronics",
          "MerchantCategory1": "568",
          "MerchantCategory2": "MP3Players",
          "Brand": "LG",
          "Url": "http://www.citronrose.com/catalog/MP3PlayerLG4Go",
          "Delivery": {
            "Type": "Carrier",
            "Label": "COLISSIMO",
            "Speed": "Standard",
            "ExpectedDate": "2018-02-01T22:59:59Z",
            "ExpectedDelay": 15,
            "RawCustom": "whatever"
          },
          "RawCustom": "whatever"
        },
        {
          "Id": "J89214",
          "Label": "HousseMP3Player",
          "UnitPrice": 20.00,
          "VAT": 3.92,
          "Quantity": 1,
          "Category": "Electronics",
          "MerchantCategory1": "788",
          "MerchantCategory2": "accessory",
          "Brand": "Logicase",
          "Url": "http://www.citronrose.com/catalog/HousseMP3Player",
          "Delivery": {
            "Type": "Carrier",
            "Label": "COLISSIMO",
            "Speed": "Standard",
            "ExpectedDate": "2018-02-01T22:59:59Z",
            "ExpectedDelay": 15,
            "RawCustom": "whatever"
          },
          "RawCustom": "whatever"
        }
      ],
      "RawCustom1": "whatever",
      "RawCustom2": "whatever",
      "RawCustom3": "whatever",
      "SearchableCustom1": "whatever",
      "SearchableCustom2": "whatever"
    }
  }
}

<Request>
  <PaymentOrder>
    <MerchantId>citronrose-fr</MerchantId>
    <PaymentPageId>creditcard</PaymentPageId>
    <Amount>95</Amount>
    <Currency>EUR</Currency>

    <MerchantUrls>
      <ReturnUrl>http://www.citronrose.com/Payment_Return.aspx</ReturnUrl>
      <AbortedUrl>http://www.citronrose.com/Payment_Aborted.aspx</AbortedUrl>
      <ErrorUrl>http://www.citronrose.com/Payment_Error.aspx</ErrorUrl>
    </MerchantUrls>

    <MerchantOrder>
      <Id>1257981</Id>
      <TotalAmount>95.00</TotalAmount>
      <VatAmount>18.62</VatAmount>
      <Currency>EUR</Currency>

      <Customer>
        <CompanyName>Limonetik</CompanyName>
        <Type>Individual</Type>
        <Id>123321</Id>
        <Title>M</Title>
        <FirstName>Jean</FirstName>
        <LastName>Dupont</LastName>
        <Email>[email protected]</Email>
        <HomePhone>+33175757575</HomePhone>
        <MobilePhone>+33675757575</MobilePhone>
        <RawCustom>whatever</RawCustom>
        <Culture>fr-FR</Culture>
      </Customer>

      <ShippingAddress>
        <CompanyName>Limonetik</CompanyName>
        <Title>M</Title>
        <FirstName>Jean</FirstName>
        <LastName>Dupont</LastName>
        <Address1>8, rue Saint-Fiacre</Address1>
        <Address2>Gate A</Address2>
        <ZipCode>75002</ZipCode>
        <City>Paris</City>
        <Country>FR</Country>
        <HomePhone>+33175757575</HomePhone>
        <MobilePhone>+33675757575</MobilePhone>
        <RawCustom>whatever</RawCustom>
      </ShippingAddress>

      <BillingAddress>
        <CompanyName>Limonetik</CompanyName>
        <Title>M</Title>
        <FirstName>Jean</FirstName>
        <LastName>Dupont</LastName>
        <Address1>8, rue Saint-Fiacre</Address1>
        <Address2>Gate A</Address2>
        <ZipCode>75002</ZipCode>
        <City>Paris</City>
        <Country>FR</Country>
        <HomePhone>+33175757575</HomePhone>
        <MobilePhone>+33675757575</MobilePhone>
        <RawCustom>whatever</RawCustom>
      </BillingAddress>

      <CartItems>
        <CartItem>
          <Id>R49203</Id>
          <Label>MP3PlayerLG4Go</Label>
          <UnitPrice>70.00</UnitPrice>
          <VAT>13.72</VAT>
          <Quantity>1</Quantity>
          <Category>Electronics</Category>
          <MerchantCategory1>568</MerchantCategory1>
          <MerchantCategory2>MP3Players</MerchantCategory2>
          <Brand>LG</Brand>
          <Url>http://www.citronrose.com/catalog/MP3PlayerLG4Go</Url>
          <Delivery>
            <Type>Carrier</Type>
            <Label>COLISSIMO</Label>
            <Speed>Standard</Speed>
            <ExpectedDate>2013-03-07T09:39:55.6293929Z</ExpectedDate>
            <ExpectedDelay>15</ExpectedDelay>
            <RawCustom>whatever</RawCustom>
          </Delivery>
          <RawCustom>whatever</RawCustom>
        </CartItem>

        <CartItem>
          <Id>J89214</Id>
          <Label>CleUSB32Go</Label>
          <UnitPrice>30.00</UnitPrice>
          <VAT>5.88</VAT>
          <Quantity>1</Quantity>
          <Category>Electronics</Category>
          <MerchantCategory1>788</MerchantCategory1>
          <MerchantCategory2>accessory</MerchantCategory2>
          <Brand>Lexar</Brand>
          <Url>http://www.citronrose.com/catalog/CleUsbLexar32Go</Url>
          <Delivery>
            <Type>Carrier</Type>
            <Label>COLISSIMO</Label>
            <Speed>Standard</Speed>
            <ExpectedDate>2013-03-07T09:39:55.6293929Z</ExpectedDate>
            <ExpectedDelay>15</ExpectedDelay>
            <RawCustom>whatever</RawCustom>
          </Delivery>
          <RawCustom>whatever</RawCustom>
        </CartItem>
      </CartItems>

      <RawCustom1>whatever</RawCustom1>
      <RawCustom2>whatever</RawCustom2>
      <RawCustom3>whatever</RawCustom3>
      <SearchableCustom1>whatever</SearchableCustom1>
      <SearchableCustom2>whatever</SearchableCustom2>

    </MerchantOrder>
  </PaymentOrder>
</Request>