Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

When integrating our API into your application, we kindly ask you to send special parameters to identify your application in all of our API communication. This helps our support staff in customer communication, and we're able to identify your requests platform-wide to provide better support for your integration.

Integration Parameters

ParameterRequiredExplanation
integrator_name-

Name of the developer (it's you!)

Section


Layout box
cssClasspayoneFormat
floatingleft

Format


Layout box
cssClasspayoneFormatValue
floatingleft
CHAR(1..50)



integrator_version-

Version of the Shopextension (e.g. 1.0.0)

Section


Layout box
cssClasspayoneFormat
floatingleft

Format


Layout box
cssClasspayoneFormatValue
floatingleft
CHAR(1..255)



solution_name-

Name of the shop system (oxid, magento, shopware)

Section


Layout box
cssClasspayoneFormat
floatingleft

Format


Layout box
cssClasspayoneFormatValue
floatingleft
CHAR(1..50)



solution_version-

Version of the shop system (e.g. CE4.10.5)

Section


Layout box
cssClasspayoneFormat
floatingleft

Format


Layout box
cssClasspayoneFormatValue
floatingleft
CHAR(1..255)



Example Request

UI Tabs


UI Tab
titleRequest


Code Block
aid=12345
amount=10000
api_version=3.8
currency=EUR
encoding=UTF-8
key=c4ca4238a0b923820dcc509a6f75849b
mid=12345
mode=test
portalid=123456
reference=your_unique_reference_v1_final_latest
request=capture
txid=987654321
sequencenumber=1
integrator_name=shopsystem
integrator_version=1.2.3
solution_name=SuperDev
solution_version=3.2.1



UI Tab
titleResponse


Code Block
status=APPROVED
txid=987654321
settleaccount=no
clearing_bankaccountholder=BS PAYONE GmbH
clearing_bankaccount=0022520120
clearing_bankcode=21070020
clearing_bankcountry=DE
clearing_bankname=Testbank AG
clearing_bankbic=TESTDEXX210
clearing_bankiban=DE00123456781234567890




Table of Contents
outlinetrue
indent2em