is_demo

boolean

Optional. Whether the transaction is a demo transaction:

• true for demo transactions;

• false for productive transactions.

Defaults to false, productive transaction.

intent

string

The intent of the transaction. In our case always sale.

contract

object

The contract ID of the merchant ("id": "GCR_..."). You receive this ID during onboarding.

customer

object

The customer, either its ID or its details. (See details below.)

merchantRef

string

Optional. The merchant's own customer ID. This can be helpful to trace back the customer account on your site.

transactionRef

string

Optional. The merchant's own order ID. This can be helpful to trace back the order on your site. It is also used for the purpose line at the bank statements.

basket

object

Optional basket details, like article positions or shipping fee. (See details below.)

basket_info

object

The basket meta data, like currency and total. (See details below.)

application_context

object

Optional application context for Smart Checkout integration, like return URLs. (Described for Smart Checkout; see link below.)

payment_context

object

Control payment context. (See details below.)

id

string

The customer ID ("PCU_..."), if not contact.

contact

object

The customer contact details. (See details directly below.)

company_name

string

Optional company name.

forename

string

First name of the person.

surname

string

Last name of the person.

salutation

string

Optional salutation of the person.

address

object

Optional postal address. (See details below.)

email

string

Email address.

phone

string

Optional landline number.

mobile

string

Optional mobile phone number.

date_of_birth

string

Optional date of birth. (ISO 8601 date like "2023-02-28".)

street

string

Street, or street with house number.

street_number

string

Optional house number.

additional_address_data

string

Optional second address line, for apartment number, etc.

postal_code

string

ZIP code.

city

string

City or town.

country

string

Country. (ISO 3166 two letter country code like "DE".)

products

object[]

Article positions, shipping fee, etc.

id

int

Item ID.

item_type

string

Optionally the function of the item:

• "article" for the goods;

• "coupons" for vouchers;

• "shipping" for shipping fees.

Coupons are considered with the reverse value in the total. For instance one coupon having "priceOne": 500 reduces the total by 5 EUR, or another currency.

There exist more item types that are introduced where relevant.

articleNumber

int

Optional article number of the merchant often called SKU number.

ean

string

Optional European Article Number (EAN) or Global Trade Identification Number (GTIN).

desc

string

Short text that describes the article (article name, perhaps size), coupon or shipping fee.

quantity

int

Quantity.

priceOne

int

Gross unit price in the smallest currency unit.

tax

int

Optional V. A. T rate of that article, coupon, or shipping fee.

sum

int

Total sum of the entire transaction in the smallest currency unit.

currency

string

Currency of the entire transaction. (ISO 4217 three-letter code like "EUR" or "USD".)

auto_capture

boolean

Whether the amount is captured automatically after successful authorisation. This saves an additional API call when the payment process is also the order confirmation, for instance. It controls also whether Smart Checkout returns with an authorised transaction or already captures it.

Defaults to false, needs explicit capture.

id

string

The ID of the new Smart Transaction object ("STX_...").

status

string

The status of the Smart Transaction.