About PaybackPay

General information about PaybackPay

Page properties

Logo

Info

Excerpt
tbd

Type

Payments by eWallet

Further information you will find also on the website of Payback: tbd

Use cases

Supported use cases

Supported interfaces

Use case

Description

Simple process

S-2-S

APP

Batch

Authorization + Capture

Merchant wants to authorize payment and capture on delivery

not supported
use "Sale" instead to authorize and capture a payment within one step

Sale

Merchant wants to collect money from customer via Payback

Merchant's shop initiates Payback payment request
Customer confirms payment in Payback App
Merchant's shop gets a notification about successful payment
Merchant App polls Merchant's server until payment is completed

full or partial Credit

Merchant wants to credit some money back to customer after a payment has been successfully completed

Merchant initiates credit request
Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Partner-Name
PageWithExcerpt Wording
collects Payback details from referred payment and initiates Payback credit
Merchant's shop gets a response about successful credit

Process flow charts

Sale

Multiexcerpt

MultiExcerptName	ProcessFlow-Sale

draw.io Diagram

border	true
diagramName	Prozess-CT
simpleViewer	false
links	auto
tbstyle	top
lbox	true
diagramWidth	1118

Reversal / Credit, Server-to-Server

Multiexcerpt

MultiExcerptName	ProcessFlow Credit

draw.io Diagram

border	true
diagramName	CreditPaygate
simpleViewer	false
links	auto
tbstyle	top
lbox	true
diagramWidth	1109

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Definition
PageWithExcerpt	Definition EN

Calling the interface for a PaybackPay payment (Sale)

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

PaybackPay.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1646660124750_-2095662974
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1646660124753_369886467
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

Table Excerpt Include

static	true
name	TransID
page	TransID
type	page

Key	Format	CND	Description	Beschreibung
RefNr	ans..30	O	Reference which must be unique for each payment

Table Excerpt Include

static	true
name	Amount
page	Amount
type	page

Key	Format	CND	Description	Beschreibung
Currency	A3	M	Three digits DIN / ISO 4217. Currently only EUR is supported. Please find an overview here: A1 Currency table EN	Währung, drei Zeichen DIN / ISO 4217. Derzeit wird nur EUR unterstützt. Hier eine Übersicht: A1 Währungstabelle

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Key	Format	CND	Description	Beschreibung
Language	a2	O	Language: de - German, en – English	Sprache: de - deutsch, en – Englisch, fr- Französisch

Table Excerpt Include

static	true
name	URLSuccess
page	URLSuccess
type	page

Table Excerpt Include

static	true
name	URLFailure
page	URLFailure
type	page

Table Excerpt Include

static	true
name	Response
page	Response
type	page

Table Excerpt Include

static	true
name	URLNotify
page	URLNotify
type	page

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Table Excerpt Include

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

Table Excerpt Include

static	true
name	Plain
page	Plain
type	page

Table Excerpt Include

static	true
name	Custom
page	Custom
type	page

Key	Format	CND	Description
PointAmount	n..10	O	The PAYBACK points amount of the PAY transaction.
VatList	String	M	Base64 encoded value
items.rate	n..10	M	The percentage rate of the vat item.
items.amount	n..10	M	The gross amount of the vat item. Value needs to be > 0. The value needs calculation in order to match with the Gross Amount of the VAT Example: If the gross amount of the transaction is 3 Euro, then the VAT Gross Amount would be 0.48 Euro for a VAT Rate of 19%. This means that the gross amount of the transaction includes the VAT Amounts
ArticleList	String	M	Base64 encoded value
items	array	M	Array of items, e.g.: {"items": [{items1 ...}{item2...}]}
items.itemReference	ans..30	M	Position of the line item in the order
items.id	ans..30	M	Article Number
items.description	ans..30	M	Name / Title of the Article
items.quantity	ans..30	M	Total number of items
items.amount	n..10	M	Gross unit price (incl. VAT) in Cent
items.vatAmount	n..10	M	Tax Amount in cents
items.vatPercent	n..10	M	Tax rate of country tax in % as number 19% = 19
items.type	String	M	GOODS = Article to ship VOUCHER = Voucher to be used SHIPPING = Shipping costs PAYMENT_FEE = Payment fee
DeviceID	ans..50	O	device id set by the merchant during the check-out and sent over with the device check Pixel For E-com it is mandatory. The value has to be the same one which was handed over with the DevicePixel
AccountId	n10	M	It is the 10 digit PAYBACK user ID of the customer handed over by the merchant, used to check if the right user fulfills the Payment
CustomerID	an..	M	The PAYBACK membership identifier is only available in case of an active account binding and used to push users to fulfill transactions
IsBound	enum	M	true \| false
CustomerGroup	enum	M	KNOWN \| UNKNOWN
sdAdditionalInfo	ans..50	O	Shipping details, AdditionalInfo, e.g. Information about the kind of Shipping (e.g. "Click++Collect")
sdCompany	ans..50	O	Shipping details, Company
sdFirstName	ans..50	O	Shipping details, FirstName
sdLastName	ans..50	O	Shipping details, LastName
sdStreet	ans..50	O	Shipping details, Street
sdStreetNr	an..10	O	Shipping details, StreetNr
sdZIP	an..20	O	Shipping details, ZIP
sdCity	ans..50	O	Shipping details, City
sdCountryCode	an2	M	Shipping details, CountryCode

Parameters for payments with PaybackPay payment

VatList

VatList should be sent as a base64 encoded value. Please find the example below.

Multiexcerpt

MultiExcerptName	vatlist

Code Block

{
    "items": [
        {
            "rate": "7",
            "amount": 5000
        },
        {
            "rate": "19",
            "amount": 500
        }
    ]
}
VatList=ew0KICAgICJpdGVtcyI6IFsNCiAgICAgICAgew0KICAgICAgICAgICAgInJhdGUiOiAiNyIsDQogICAgICAgICAgICAiYW1vdW50IjogNTAwMA0KICAgICAgICB9LA0KICAgICAgICB7DQogICAgICAgICAgICAicmF0ZSI6ICIxOSIsDQogICAgICAgICAgICAiYW1vdW50IjogNTAwDQogICAgICAgIH0NCiAgICBdDQp9

Articlelist

Articlelist should be sent as a base64 encoded value. Please find the example below.

Multiexcerpt

MultiExcerptName	articlelist

Code Block

{
    "items": [
        {
            "itemReference": "1",
            "id": "Click++Collect",
            "description": "Click++Collect",
            "quantity": 1,
            "amount": 500,
            "vatAmount": 80, 
            "vatPercent": 19,
			"type":"SHIPPING"
		},
		{
            "itemReference": "2",
			"id": "654327",
			"description": "Test product2",
			"quantity": 1,
			"amount": 5000,
			"vatAmount": 327, 
            "vatPercent": 7,
			"type":"GOODS"
		}
	]
} Articlelist=ew0KICAgICJpdGVtcyI6IFsNCiAgICAgICAgew0KICAgICAgICAgICAgIml0ZW1SZWZlcmVuY2UiOiAiMSIsDQogICAgICAgICAgICAiaWQiOiAiQ2xpY2srK0NvbGxlY3QiLA0KICAgICAgICAgICAgImRlc2NyaXB0aW9uIjogIkNsaWNrKytDb2xsZWN0IiwNCiAgICAgICAgICAgICJxdWFudGl0eSI6IDEsDQogICAgICAgICAgICAiYW1vdW50IjogNTAwLA0KICAgICAgICAgICAgInZhdEFtb3VudCI6IDgwLCANCiAgICAgICAgICAgICJ2YXRQZXJjZW50IjogMTksDQoJCQkidHlwZSI6IlNISVBQSU5HIg0KCQl9LA0KCQl7DQogICAgICAgICAgICAiaXRlbVJlZmVyZW5jZSI6ICIyIiwNCgkJCSJpZCI6ICI2NTQzMjciLA0KCQkJImRlc2NyaXB0aW9uIjogIlRlc3QgcHJvZHVjdDIiLA0KCQkJInF1YW50aXR5IjogMSwNCgkJCSJhbW91bnQiOiA1MDAwLA0KCQkJInZhdEFtb3VudCI6IDMyNywgDQogICAgICAgICAgICAidmF0UGVyY2VudCI6IDcsDQoJCQkidHlwZSI6IkdPT0RTIg0KCQl9DQoJXQ0KfQ==

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_IntroURL
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1646660977732_388274419
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1646660977734_1236696248
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	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
type	page

Key	Format	CND	Description	Beschreibung
TransID	ans..30	M	Unique reference number for your accounts - it is the unique reference with Payback, too.	Eindeutige Referenznummer für Ihre Buchhaltung – sie ist auch die eindeutige Referenz für Payback.
RefNr	ans..30	M	Unique reference number.	Eindeutige Referenznummer.
TransactionID	ans..64	M	Unique transaction number returned by Payback.	Eindeutige Transaktionsnummer von Payback.
PointsRedeemed	n..10	O	The amount of the points in a PAY redemption transaction. It will exist only in case of mobile redemption. If exists it has to be natural number.
PAYAmount	n..10	O	The PAY amount of the PAY transaction including VAT. It will exist only in case of mobile redemption. If redemption transaction is fully paid with points this will be 0.
ApprovalCode	an..10	O	Optional external authorization identifier for the PAY transaction. Populated by Verifone Payments as the unique authorization identifier of the payment transaction.
PayType	enum	O	This field represents the detailed payment method which is used to pay the PAY amount. SEPA, VISA, MASTERCARD, AMEX
PointAmount	n..10	O	The PAYBACK points amount of the PAY transaction.
AccountId	an..10	M	It is the 10 digit PAYBACK user ID of the customer handed over by the merchant, used to check if the right user fulfills the Payment
CustomerID		M	The PAYBACK membership identifier is only available in case of an active account binding and used to push users to fulfill transactions
IsBound	true \| false	M	Information if the PAYBACK account is banded on the merchant side. Only in this case users can be pushed
CustomerGroup	KNOWN \| UNKNOWN	M	Information by the merchant about the customer which are used by Verifone Payments for risk evaluation

Table Excerpt Include

static	true
name	Status
page	Status
type	page

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Table Excerpt Include

static	true
name	UserData
page	UserData
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Table Excerpt Include

static	true
name	Plain
page	Plain
type	page

Table Excerpt Include

static	true
name	Custom
page	Custom
type	page

Key	Format		CND	Description	Beschreibung
CodeExt	an3..30		O	Payback error Code	Fehlercode von Payback

Result parameters for URLNotify, URLSuccess and URLFailure in case of PaybackPay payment

Credit with reference

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Credit_Intro
PageWithExcerpt	Reuse API

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	BaseURL
PageWithExcerpt	Wording

credit.aspx

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Request_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1697736581295_1103122892
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	credit_request

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1697736581297_478316361
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

Table Excerpt Include

static	true
name	PayID_Credit
page	PayID
type	page

Table Excerpt Include

static	true
name	TransID
page	TransID
type	page

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	RefNr
page	refnr
type	page

Table Excerpt Include

static	true
name	MAC
page	MAC
type	page

Table Excerpt Include

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

Parameters for credit payments with PaybackPay via socket connection

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Response_Intro
PageWithExcerpt	Reuse API

Table Filter

default	Beschreibung
isFirstTimeEnter	false
hideColumns	true
sparkName	Sparkline
hidePane	true
datepattern	dd M yy
id	1697736611452_1927449587
worklog	365\|5\|8\|y w d h m\|y w d h m
isOR	AND
separator	Point (.)
order	0

Multiexcerpt

MultiExcerptName	credit_response

Table Transformer

dateFormat	dd M yy
export-word	false
show-source	false
export-csv	false
id	1697736611454_1758635080
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	PayID
page	PayID
type	page

Table Excerpt Include

static	true
name	XID
page	XID
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

Table Excerpt Include

static	true
name	Description
page	Description
type	page

Table Excerpt Include

static	true
name	Code
page	Code
type	page

Key

Format

CND

Description

Beschreibung

CodeExt

n..10

O

Error code from Payback, if agreed with

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

Fehlercode von Payback, wenn mit

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

abgesprochen

ErrorText

ans..256

O

Error text from Payback, if agreed with

Multiexcerpt include

SpaceWithExcerpt	EN
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	Wording

Fehlertext von Payback, wenn mit

Multiexcerpt include

SpaceWithExcerpt	DE
MultiExcerptName	Helpdesk-Name
PageWithExcerpt	DE:Wording

abgesprochen

Response parameters for credit payments with PaybackPay via socket connection

Space shortcuts

Page tree

Versions Compared

Old Version 25

New Version 26

Key

About PaybackPay

General information about PaybackPay

Use cases

Process flow charts

On this page

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface

Calling the interface for a PaybackPay payment (Sale)

VatList

Articlelist

Credit with reference

Paygate

Computop

Help

Intranet Tools

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 25

New Version 26

Key

About PaybackPay

General information about PaybackPay

Use cases

Process flow charts

On this page

Multiexcerpt includeSpaceWithExcerptENMultiExcerptNamePlatform-KurzPageWithExcerptWording interface

Calling the interface for a PaybackPay payment (Sale)

VatList

Articlelist

Credit with reference

Multiexcerpt include
SpaceWithExcerpt EN
MultiExcerptName Platform-Kurz
PageWithExcerpt Wording
interface