E-Commerce
Payment
Payment with Flex.API
About This Guide
Getting started
Reference
Integration Process
Workflow immediate payment
Workflow payment after authorization
Test or production environment
Content negotiation headers
Request body
Response body
Demo transactions
Obtain available payment methods
Create Payment Transaction
Pass delivery address
Pass merchant information
Pass detailed basket
Pass shipping fee
Show payment hint
Various display options
Define return URLs
Pass shop module information
Improve customer rating
Obtain transaction status and details
Payment status
Capture authorized payment
Add shipping note on partial delivery
Capture invoice payment on full delivery
Cancel payment
Status notifications (Push API)
Troubleshooting
TL;DR
Payment with Smart Checkout
About This Guide
Getting Started
Step 1: Authenticate with OAuth 2.0
Step 2: Create the Smart Transaction
Step 3: Start Smart Checkout
Summary
Reference
Integration Process
Key Terms
secuconnect API Basics
Secuconnect SDKs
Authentication with OAuth 2.0
Error Handling
Prerequisites for PayPal Payments
Process Workflow
Create or Update a Smart Transaction
Demo or Productive Transaction
Authorise Only or Capture Automatically
Customer Details
Basket Items
Return URLs
Pass Order ID or Purpose
Advanced Display Options
Start Smart Checkout
Start Smart Checkout by URL
Start Smart Checkout in a Layer
Capture the Payment
Read a Smart Transaction
Read a Payment Transaction
Subscriptions
Process for Subscriptions
Create a Smart Transaction for Subscription
Get the Subscription ID
Cancel a Subscription
Suspend a Subscription
Reactivate a Subscription
Read a Subscription
Read a Payment Transaction
Push Notifications
Set a Push URL
Process a Push Notification
Push Events for Payments
Push Events for Subscriptions
Troubleshooting
TL;DR
Smart Checkout
HTML Integration of Smart Checkout
About This Guide
Getting Started
Checkout Workflow
Example Integration HTML
Reference
Integration Process
Key Terms
Prerequisites for PayPal Payments
Process Workflow
Set the Contract ID
Demo or Productive Transaction
Test or Production Server
Article Definition Basics
Articles with Text Boxes
Articles with Number Spinners
Articles with Dropdowns
Articles with Radio Buttons
Articles with Checkboxes
Pass a Shipping Fee
Display the Order Total
Display a Detailed Basket Summary
Start Fullscreen or in a Layer
Change the Default Language
Return URLs for Success or Failure
Go Live
Troubleshooting
TL;DR
JavaScript Integration of Smart Checkout
About This Guide
Getting Started
Checkout Workflow
Example Integration JavaScript
Reference
Integration Process
Key Terms
Prerequisites for PayPal Payments
Process Workflow
Global Options
Server Environments
Basket Management
Stakeholder Payment
Pass Customer Data
Start Smart Checkout
Troubleshooting
TL;DR
API Integration of Smart Checkout
About This Guide
Getting Started
Checkout Workflow
Step 1: Authenticate with OAuth 2.0
Step 2: Create the Smart Transaction
Step 3: Start Smart Checkout
Summary
Reference
Integration Process
Key Terms
secuconnect API Basics
Secuconnect SDKs
Production or Test Environment
Authentication with OAuth 2.0
Error Handling
Prerequisites for PayPal Payments
Process Workflow
Create a Smart Transaction
Demo or Productive Transactions
Payment or Order (Intent)
Basket Item Details
Delivery Details of an Order
Pass Order ID or Purpose
Change the Default Language
Return URLs
Manage the Customer Details
Set Customer Details Inline
Create a Payment Customer
Use an Existing Payment Customer
Details of a Payment Customer
Start Smart Checkout
Start Checkout by URL
Start Checkout in a Layer
Capture the Payment
Mark as Shipped
Read a Smart Transaction
Read a Payment Transaction
Push Notifications
Set a Push URL
Process a Push Notification
Push Events for Payments
Click & Collect
Create a Smart Transaction
Execute the Payment
Mark as Collected or Shipped
Troubleshooting
TL;DR
Custom Checkout
About This Guide
Getting Started
Step 1: Authenticate with OAuth 2.0
Step 2: Create the Smart Transaction
Step 3: Authorise and Capture
Step 4: Receive Push Notifications
Summary
Reference
Integration Process
Key Terms
secuconnect API Basics
Secuconnect SDKs
Production or Test Environments
OAuth 2.0 Authentication
Error Handling
Prerequisites for PayPal Payments
Process Workflow
Create or Update a Smart Transaction
Create a Smart Transaction with Minimal Data
Update the Smart Transaction
Authorise Only or Capture Automatically
Manage the Customer Details
Set Customer Details Inline
Create a Payment Customer
Use an Existing Payment Customer
Details of a Payment Customer
Delivery Details for Shipping
Basket Item Details
Pass Order ID or Purpose
Pass a Shipping Fee
Authorise and Capture the Payment
Payment Process
Direct Debit Payment
Authorise for Direct Debit Payment
Capture the Authorised Payment
Use an Existing Payment Container
Create a Payment Container
Credit Card Payment
Frontend Integration of Credit Card Iframe
Authorise for Credit Card Payment
Capture the Authorised Payment
Use an Existing Payment Container
Create a Payment Container
Invoice Payment
Authorise for Invoice Payment
Capture the Authorised Payment
Capture the Payment without Prior Authorisation
Advance Payment
PayPal Payment
Authorise for PayPal Payment
Capture the Authorised Payment
Sofort Payment
Google Pay Payment
Process Details
Google Pay Button Integration
Authorise for Google Pay Payment
Authorise with Payment Container
Capture the Authorised Payment
Apple Pay Payment
Process Details
Apple Pay Button Integration
Authorise for Apple Pay Payment
Authorise with Payment Container
Capture the Authorised Payment
Mark as Shipped
Read a Smart Transaction
Read a Payment Transaction
Cancel or Refund the Payment
Click & Collect
Create the Smart Transaction
Capture the Payment
Mark as Collected or Shipped
Subscriptions
Process for Subscriptions
Create a Smart Transaction for Subscription
Authorise and Capture the Payment
Cancel a Subscription
Suspend a Subscription
Reactivate a Subscription
Read a Subscription
Read a Payment Transaction
Push Notifications
Set a Push URL
Process a Push Notification
Push Events for Payments
Push Events for Subscriptions
Attach an Invoice
Document Upload with Multipart Message
Document Upload with JSON Request
Assign Document to Payment Transaction
On-Site Testing
TL;DR
Recurring Payment
About This Guide
Getting Started
Authenticate with OAuth 2.0
Make the Initial Payment
Step 1: Create the Payment Transaction
Step 2: Direct the Customer to the Payment Iframe
Step 3: Check the Status
Make the Subsequent Payments
Summary
Reference
Integration Process
Key Terms
secuconnect API Basics
Use secuconnect SDKs
Production or Test Environments
Authentication with OAuth 2.0
Error Handling
Demo or Productive Transactions
Make the Payments
Common Workflow for Recurring Payment
SEPA Direct Debit
Make the Initial Payment
Make the Subsequent Payments
Credit Card
Make the Initial Payment
Make the Subsequent Payments
Create the Payment Customer Explicitly
Check the Payment Status
Payment Status
Status Notifications
Set the Push URL
Consume the Push Message
TL;DR
Loyalty
About This Guide
Getting Started
Step 1: Authenticate Your Application
Step 2: Create the Smart Transaction
Step 3: Apply the Loyalty Card for Payment
Step 4: Authorise and Capture for SEPA Direct Debit Payment
Summary
Reference
Integration Process
Key Terms
secuconnect API Basics
Use a secuconnect SDK
Production and Test Environments
Authentication with OAuth 2.0
Error Handling
Recognise and Check a Card
Recognise a Secucard Card Number
Check a Card to be Valid
Check the Card Security Code
Obtain Details of a Merchant Card
Create and Update a Smart Transaction
Create a Smart Transaction with Minimal Data
Update the Smart Transaction with Card and Basket
Create the Same Smart Transaction at Once
Authorise and Capture the Payment
Apply the Loyalty Card for Payment
Pay Fully with the Secucard
Pay the Remainder by Credit Card or SEPA Direct Debit
Print the Receipt
Example Smart Transaction with Receipt
Separator Line
Text Line
Name-Value Line
Space Line
Status Flow of the Smart Transaction
Check the Status
Collect and Spend Bonus
Process and Settings Overview
Configure the Bonus Products
Configure a Product Blacklist or Whitelist
Spend Bonus Balance
Create the Smart Transaction
Apply the Loyalty Card for Payment
Execute the Payment
Load the Loyalty Card with Cash Balance
Process to Load a Loyalty Card
Create the Smart Transaction
Capture the Payment
Send a Customer Notification
Create a Loyalty Card on-the-Fly
Process to Create a Loyalty Card
Create the Smart Transaction
Capture the Payment
TL;DR
Marketplace
Custom Checkout for Marketplace
About This Guide
Getting Started
Step 1: Authenticate with OAuth 2.0
Step 2: Create the Smart Transaction
Step 3: Authorise and Capture
Step 4: Receive Push Notifications
Summary
Reference
Key Terms
Integration Process
secuconnect API Basics
Secuconnect SDKs
Production or Test Environments
Authentication with OAuth 2.0
Error Handling
Merchant Onboarding
Onboarding Process
Create a Merchant Contract
Upload Registration Documents
Document Upload with Multipart Message
Document Upload with JSON Request
Create a Service Case
Check the Activation Status
Checkout and Payment
Checkout Process
Prerequisites for PayPal Payments
Create or Update a Smart Transaction
Create the Smart Transaction
Update the Smart Transaction
Manage the Customer Details
Set Customer Details Inline
Create a Payment Customer
Use an Existing Payment Customer
Details of a Payment Customer
Basket Details
Full Example
Outline with Sub-Baskets
Regular Product Items
Coupons
Shipping Fee
Stakeholder Share
Authorise Only or Capture Automatically
Delivery Details for Shipping
Pass Order ID or Purpose
Authorise and Capture the Payment
Payment Process
Direct Debit Payment
Authorise for Direct Debit Payment
Capture the Authorised Payment
Use an Existing Payment Container
Create a Payment Container
Credit Card Payment
Frontend Integration of Credit Card Iframe
Authorise for Credit Card Payment
Capture the Authorised Payment
Use an Existing Payment Container
Create a Payment Container
Invoice Payment
Authorise for Invoice Payment
Capture the Authorised Payment
Capture the Payment without Prior Authorisation
Advance Payment
PayPal Payment
Authorise for PayPal Payment
Capture the Authorised Payment
Sofort Payment
Mark as Shipped
Read a Payment Transaction
Read a Smart Transaction
Push Notifications
Set a Push URL
Process a Push Notification
Push Events for Payments
Push Events for Contracts
On-Site Testing
TL;DR
Platforms
POS
Payment with SmartZVT
TL;DR
About This Guide
Getting Started
Key Terms
Step 1: Authenticate the Device
Step 2: Create the Smart Transaction
Step 3: Make the Payment
Summary
Reference
Integration Process
secuconnect API Basics
Use a secuconnect SDK
Server Environments
Error Handling
Register a New Device
Coordinate the Client Credentials and Device IDs
Request the Device Registration
Confirm the Registration in SecuOffice
Confirm the Registration Via Hotline
Manage the Device Session
Start a Device Session
Renew the Device Session
Process Workflow
Make a Card Payment
Create the Smart Transaction
Make the Payment
Print the Receipt
Example Smart Transaction
Separator Line
Text Line
Name-Value Line
Space Line
Cancel a Former Transaction
Status Flow of the Smart Transaction
End-Of-Day Report
Terminal Diagnosis and Configuration Update
Loyalty
TL;DR
About This Guide
Getting Started
Key Terms
Step 1: Authenticate the Device
Step 2: Create the Smart Transaction
Step 3: Apply the Loyalty Card for Payment
Step 4: Capture the Payment
Summary
Reference
Integration Process
secuconnect API Basics
Use a secuconnect SDK
Server Environments
Error Handling
Register a New Device
Coordinate the Client Credentials and Device IDs
Request the Device Registration
Confirm the Registration in SecuOffice
Confirm the Registration Via Hotline
Manage Device Sessions
Start a Device Session
Renew the Device Session
Recognise and Check a Card
Recognise a Secucard Card Number
Check a Card to Be Valid
Check the Card Security Code
Obtain the Card Details
Create or Update a Smart Transaction
Create a Smart Transaction with Minimal Data
Update the Smart Transaction
Create the Same Smart Transaction at Once
Authorise and Capture the Payment
The Payment Process
Apply the Loyalty Card for Payment
Pay the Full Amount with Secucard
Pay the Missing Sum at the Cash Register
Print the Receipt
Example Smart Transaction with Receipt
Separator Line
Text Line
Name-Value Line
Space Line
Pay the Full Amount at the Cash Register
Pay the Full Amount or the Missing Sum at the POS Terminal
Status Flow of the Smart Transaction
Collect and Spend Bonus
Process and Settings Overview
Configure the Bonus Products
Configure a Product Blacklist or Whitelist
Spend Bonus Balance
Create the Smart Transaction
Apply the Loyalty Card for Payment
Execute the Payment
Load the Loyalty Card with Cash Balance
Process to Load a Loyalty Card
Create the Smart Transaction
Capture the Payment
E-Goods
Authentifizierung und Autorisierung
Transaktion anlegen
secuconnect API
API-Credentials
AppUserCredentials
ClientCredentials
DeviceCredentials
Public test account
API-Errors
Errors
API-Models
Payment-Models
PaymentCustomersDTO
PaymentCustomersList
PaymentCustomersProductModel
PaymentTransactionsList
API Release Notes
API-Services
Document
General
Loyalty
Payment
Secupay Payout
Get a list of payment transactions
Payment Customer
Create Payment Customer
Get Payment Customer
Get a list of Payment Customers
Search for Payment Customer
Update Payment Customer
Delete Payment Customer
Subscription
Transaction States
Prepaid
Public
Services
Smart
Push-Service
secuconnect SDKs
Java SDK
Authentication
Sample application
Payment Module
Payment Containers
Payment Contracts
Payment Customers
Payment Secupay Creditcards
Payment Secupay Debits
Payment Secupay Invoices
Payment Secupay Prepays
ApiClient (Java-SDK)
JavaScript SDK
Authentication
Sample application
Payment Module
Payment Containers
Payment Contracts
Payment Customers
Payment Secupay Creditcards
Payment Secupay Debits
Payment Secupay Invoices
Payment Secupay Prepays
PHP SDK
Installing the SDK
Authentication
Configuration PHP SDK
Query parameters PHP
Payment Module
Managing Containers
Managing Contracts
Managing Secupay Creditcards
Managing Secupay Debits
Managing Secupay Invoices
Managing Secupay Prepays
PaymentContainersDTO
Managing Customers
Payment Data Models
PaymentContainersProductModel
SecupayTransactionProductDTO
SecupayTransactionProductModel
Glossary
Access Token
Back-end
Cash Register
Client Credentials
Client ID
Client SDK
Client Secret
Client UID
Cashier
Customer
Integrator
Support
Vendor
Grant Type
OAS
POS-Terminal
Smart Ident
Smart Ident Service
Storage Interface
Swagger
Validation Token
Imprint
Privacy Policy