Introduction and Prerequisites

Use your web-based ERP or shop system to accept card payments in stationery businesses. The communication of your terminals at the point of sale occurs via the Internet directly through

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Platform-Name
PageWithExcerpt	Wording

and makes traditional interfaces such as OPI or ZVT superfluous.

Process diagram

Multiexcerpt

MultiExcerptName	Process diagram

draw.io Diagram

border	true
diagramName	ProcessFlow_CloudPOS_CT
simpleViewer	false
links	auto
tbstyle	top
lbox	true
diagramWidth	1398

Table of Contents

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Definition
PageWithExcerpt	Definition EN

Calling the interface for POS –
Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Partner-Name
PageWithExcerpt Wording
Cloud POS Interface

In order to use the Cloud POS Interface, please use the following URL:

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

catpos.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Multiexcerpt

MultiExcerptName	POS_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1742327943831_90143431
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MerchantID
page	MerchantID
type	page

Key

Format

CND

Description

MessageType

an2

M

Defines the type of payment:

Supported values are:

01 - Sale
02 - Reverse
03 - Credit
05 - Authorization/Reservation
0B - Capture
0C - Card Read
0D - Diagnose
A1 - Terminal Startup

CardReadMode

ans..10

C

Defines the technology to be used to read the card. Valid values are

msr
Required for MessageType=0C (CardRead)

Table Excerpt Include

static	true
name	TransID
page	TransID
type	page

Key

Format

CND

Description

RefNr

ans..21

O

Merchant reference number

POSTerminalID

an..20

M

TerminalID of pin entry device

Printer

an1

M

Possible values that the merchant POS application can send are:

1 - Printer is ready

0 - Printer is not ready

Should be populated with 1 (further clarifications are in progress for usage of value 0)

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Table Excerpt Include

static	true
name	Currency
page	Currency
type	page

Table Excerpt Include

static	true
name	ReqId-ans..32
page	ReqId
type	page

Key	Format	CND	Description
localDate	n8	M	Transaction date: YYYYMMDD
localTime	n6	M	Transaction time: hhmmss
TraceNr	ans8	C	Mandatory for subsequent functions Reversal or Capture (MessageType=02/08). It must be equal to the value *TraceNr* received from the original authorization response. Merchant POS system must provide this in the request.
AppCode	ans6	C	Mandatory for subsequent function Capture (MessageType=08). It must be equal to the value *Approvalcode* received from the original authorization response. Merchant POS system must provide this in the request.
RTF	a1	O	Host protocol specific – COF: RTF parameter. Possible values: I or E
ContractID	n..12	O	Special merchant ID at the acquirer to overrule the default merchant ID

Parameters for payments with POS –

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Partner-Name
PageWithExcerpt	Wording

Cloud POS Interface

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

(Note: List of parameters in response may differ based on the

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Partner-Name
PageWithExcerpt	Wording

Cloud POS Interface function called and the final POS transaction result.)

Multiexcerpt

MultiExcerptName	POS_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1742329271681_211619801
transpose	false
worklog	365\|5\|8\|y w d h m\|y w d h m
separator	.
export-pdf	false
sql	SELECT * FROM T*

Table Excerpt Include

static	true
name	MID
page	mid
type	page

Table Excerpt Include

static	true
name	TransID
page	TransID
type	page

Table Excerpt Include

static	true
name	Status_OK_FAILED
page	Status
type	page

Key	Format	CND	Description
RefNr	ans..21	O	Merchant reference number
Description	ans..1024	M	Further details in the event that payment is rejected. Please do not use the Description but the CATCode parameter for the transaction status analysis!
CATCode	ans3	M	Code from the POS Server or POS device
MaskedPAN	an12..19	C	Masked card number (6X4). Only in case of successful credit card transactions.
BankAccount	an64	C	Masked Bank account number for EC transactions
additionalresponsedata	an..128	O	Additional text which the operator’s processing system can send optionally in replies to payment/cutover requests.
Approvalcode	ans6	C	Approval code from authorization host in the response message to the client. Only in case of successful credit card transactions. Merchant must save this value form the response and use it when referencing Capture subsequent action.
CCSeqNr	n3	O	Card sequence number
Brand	an..22	O	Brand: VISA, MasterCard, Maestro, AMEX, DINERS, JCB, CUP
CodeExt	n3	C	Financial transaction Authorization Host response code (Payment).
TraceNr	ans8	C	Merchant must save this value form the response and use it when referencing subsequent actions i.e Reverse, Capture
VUNr	n8	O	Acquirer Contract ID number on which the transaction was processed
Receipt	object	C	Receipt content for the Merchant and the cardholder. The information should be than used from Merchant Printer system to print out the respective receipts.
ReceiptNr	an..10	O	Receipt Number
schemeReferenceID / TransactionID	an..22	O	Unique transaction identifier provided by Schemes/Issuer to reference the transaction in MIT or COF scenarios
dccForeignAmount	n..10	O	Only when DCC was performed
dccCommission	ans..7	O	Only when DCC was performed
dccForeignCurrencyCode	n..4	O	Only when DCC was performed
dccDisclaimer (new Param)	ans..1024	O	Only when DCC was performed
dccMargin	ans..5	O	Only when DCC was performed
dccRateValue	n..13	O	Only when DCC was performed
dccSource	ans..32	O	Only when DCC was performed
dccTimestamp	ans..20	O	Only when DCC was performed
ExpiryDate	n..6	O	YYYYMM. Only when DCC was performed

Table Excerpt Include

isFirstTimeEnter	true
static	true
v	2
name	PCNr
page	PCNr
type	page

Key

Format

CND

Description

VerificationCode

an..40

O

Used authentication mode. Possible values:

Signature
PIN
On consumer device
NoAuth

PayID

an..32

O

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Partner-Name
PageWithExcerpt	Wording

PayID of the respective payment completed and linked with this CPI command

aidParameters

ans..1024

O

Authorisation parameters: if these are present, the authorisation parameters must be printed out on the terminal receipt in unpacked form as 10 hexadecimal numbers. Aid-parameters can contain up to 130 characters for electronic cash payments.

localDate

n..8

O

Transaction date: YYYYMMDD

localTime

n..6

O

Transaction time: hhmmss

RTF

a1

O

Echoed from the request parameter

ContractID

n..12

O

Echoed from the request parameter

POSTerminalId

an..20

O

Echoed from the request parameter

TerminalID

an..12

O

Terminal ID which is forwarded towards acquirer authorization host

Result parameters for payments with POS –

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Partner-Name
PageWithExcerpt	Wording

Cloud POS Interface

JSON Object (Receipt)

Info
Please note that the data within this JSON object is encoded using ISO-8859-1 in contrast to the standard encoding of JSON objects with UTF-8 and then must be also Base64 encoded. This applies in particular to special characters such as "Umlaute" and diactrics.

"receipt"

Multiexcerpt

MultiExcerptName	JSON_receipt

Key	Format	CND	Description
receiptCopies	integer	O	Number of receipt copies to be printed
receiptCustomer	string	O	Customer receipt data
receiptMerchant	string	O	Merchant receipt data
receiptNumber	integer	O	Receipt number

JSON Schema

Multiexcerpt

MultiExcerptName	JSON_receipt_example

Code Block

language	json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://json-schema.org/draft-07/schema#",
  "title": "receipt",
  "description": "Data containing the receipt information which can be printed out by the merchant system",
  "type": "object",
  "properties": {
    "receiptMerchant": {
      "type": "string",
      "description": "Merchant Receipt data"
    },
    "receiptCustomer": {
      "type": "string",
      "description": "Customer Receipt data"
    },
    "receiptCopies": {
      "type": "integer",
      "description": "Number of receipt copies to be printed"
    },
    "receiptNumber": {
      "type": "integer",
      "description": "Receipt Number "
    },
      
  },
  "additionalProperties": false
}

Space shortcuts

Page tree

Versions Compared

Old Version 75

New Version Current

Key

Introduction and Prerequisites

Process diagram

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface

Calling the interface for POS –
Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Partner-Name
PageWithExcerpt Wording
Cloud POS Interface

JSON Object (Receipt)

"receipt"

JSON Schema

Paygate

Computop

Help

Intranet Tools

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 75

New Version Current

Key

Introduction and Prerequisites

Process diagram

Multiexcerpt includeSpaceWithExcerptENMultiExcerptNamePlatform-KurzPageWithExcerptWording interface

Calling the interface for POS – Multiexcerpt includeSpaceWithExcerptENMultiExcerptNamePartner-NamePageWithExcerptWording Cloud POS Interface

JSON Object (Receipt)

"receipt"

JSON Schema

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface

Calling the interface for POS –
Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Partner-Name
PageWithExcerpt Wording
Cloud POS Interface