Pass Detailed Basket

DEPRECATED

This guide is for the deprecated Flex.API. Please don't use it for new implementations.

See Integration Options, and feel welcome to ask our friendly help desk.

You can optionally pass a detailed basket during the creation of the transaction. If you want to display the basket instead of the total amount, you need our customer service to activate a contract option for you.

Example request:

Request

POST /payment/init HTTP/1.1
Host: api-testing.secupay-ag.de
Content-Type: application/json; charset=utf-8;
Accept: application/json
Accept-Charset: utf-8
 
{
  "data": {
    "apikey": "6801fxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx7ace",
    "payment_type": "debit",
    ...
    "currency": "EUR",
    "amount": "14485",
    "basket": [
      {
        "item_type": "article",
        "article_number": "4124",
        "quantity": "2",
        "name": "Book shelf Peter, 201 x 59 x 28",
        "ean": "4123412341243",
        "tax": "19",
        "total": "11990",
        "price": "5995"
      },
      {
        "item_type":"article",
        "article_number":"4123",
        "quantity":"1",
        "name":"Desk lamp Eric, white",
        "ean":"4123412341236",
        "tax":"19",
        "total":"2495",
        "price":"2495"
      }
    ]
  }
}

This creates a Payment Transaction for two furniture parts, for a total of €144.85.

Monetary amounts are expressed in the smallest currency unit (e. g. Euro Cent).

Detailed description of the objects for the basket items:

Attribute	Type	Description
`item_type`	`string`	Must be `article` for regular basket items.
`id`	`number`	The item ID as integer. It is necessary as handle for further changes.
`quantity`	`number`	The amount as integer.
`articleNumber`	`string`	Optional. Your internal article number, or storage keeping unit (SKU). Currently we accept only numeric digits here.
`ean`	`string`	Optional. The official EAN or GTIN of this product. Note: If your product has no EAN or GTIN, please omit this attribute. It might conflict with real GTINs that need to be evaluated by use. We need to evaluate EANs when you start a loyalty card programme to detect loyalty cards, or articles with special tax handling. We also need to evaluate EANs when you start to sell e-goods, phone credit for example.
`name`	`string`	The article name.
`price`	`number`	The gross unit price in the smallest currency unit (e. g. Euro Cent), and including the value-added tax (VAT). If you pass a value of `1595` for a order in Euros, this means 1595 Euro Cents, or €15,95.
`tax`	`number`	The value-added tax (VAT) rate in percent. If you pass a value of `19`, this means a VAT rate of 19%.

If there is a basket, the field amount must be equal to the sum of gross item totals. It is calculated (quantity1 × price1) + (quantity2 × price2) + … + (quantityn × pricen). If present, also the shipping fee needs to be included. (See more in the next section.)

If the basket display is active for the contract, it would look so:

images/download/attachments/141535532/image2020-3-18_16-24-4-version-1-modificationdate-1649338226000-api-v2.png

When the basket is displayed, you can also change its headline. Read more in the section about display options.