PAYBACK PAY

Logo

Info

tbd

Type

Payments by eWallet

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

• Computop collects Payback details from referred payment and initiates Payback credit

• Merchant's shop gets a response about successful credit

Format

Description

a

alphabetical

as

alphabetical with special characters

n

numeric

an

alphanumeric

ans

alphanumeric with special characters

ns

numeric with special characters

bool

boolean expression (true or false)

3

fixed length with 3 digits/characters

..3

variable length with maximum 3 digits/characters

enum

enumeration of allowed values

dttm

ISODateTime (YYYY-MM-DDThh:mm:ss)

Abbreviation

Description

Comment

CND

condition

M

mandatory

If a parameter is mandatory, then it must be present

O

optional

If a parameter is optional, then it can be present, but it is not required

C

conditional

If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

refnr

ans..30

O

Merchant’s unique reference number

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

Language

a2

O

Language: de - German, en – English

URLSuccess

ans..256

M

Complete URL which calls up Paygate if payment has been successful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

Common notes:

• We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate

• However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

URLFailure

ans..256

M

Complete URL which calls up Paygate if payment has been unsuccessful. The URL may be called up only via port 443. This URL may not contain parameters: In order to exchange values between Paygate and shop, please use the parameter UserData.

Common notes:

• We recommend to use parameter "response=encrypt" to get an encrypted response by Paygate

• However, fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

Response

a7

O

Status response sent by Paygate to URLSuccess and URLFailure, should be encrypted. For this purpose, transmit Response=encrypt parameter.

URLNotify

ans..256

M

Complete URL which Paygate calls up in order to notify the shop about the payment result. The URL may be called up only via port 443. It may not contain parameters: Use the UserDataparameter instead.

Common notes:

• Before follow-up actions (capture / credit / reversal) are carried out on an existing transaction, the first Notify must have been answered by the shop.

• Fraudster may just copy the encrypted DATA-element which are sent to URLFailure and send the DATA to URLSuccess/URLNotify. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID.

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation.

Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer.

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose.

Please find a sample here: Custom

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

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.name

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

an..20

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

ans..30

M

The PAYBACK membership identifier is only available in case of an active account binding and used to push users to fulfill transactions

IsBound

bool

M

Information if the PAYBACK account is bounded on the merchant side. Only in this case users can be pushed: True | False

CustomerGroup

enum

M

Information by the merchant about the customer which are used by Verifone Payments for risk evaluation: 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

mid

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..30

M

Unique reference number for your accounts – it is the unique reference with Payback, too.

Status

a..50

M

OK or AUTHORIZED (URLSuccess) as well as FAILED (URLFailure)

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

refnr

ans..30

O

Merchant’s unique reference number

UserData

ans..1024

O

If specified at request, Paygate forwards the parameter with the payment result to the shop.

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

Plain

ans..50

O

A single value to be set by the merchant to return some information unencrypted in response/notify, e.g. the MID.

"Plain"-parameter is part of encrypted "Data" in Computop Paygate and therefore protected against manipulation.

Custom

ans..1024

O

"Custom"-parameter is added to the request data before encryption and is part of encrypted "Data" in Computop Paygate request. By this they are protected against manipulation by a consumer.

The Custom-value is added to the Computop Paygate response in plain text and the "|" is replaced by a "&". By this you can put a single value into Custom-parameter and get multiple key-value-pairs back in response for your own purpose.

Please find a sample here: Custom

TransactionID

ans..64

M

Unique transaction number returned by Payback

redemptionfactor

an..5

O

The redemption factor can be used to calculate the equivalent value of the redeemed points in Euros. As 100 points are the equivalent of 1 EUR the factor in Germany will be 0.01

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 a 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.

paymentmethod

enum

O

BesThis field represents the detailed payment method which is used to pay the PAY amount: Sepa, VISA, MasterCard

PointAmount

n..10

O

The PAYBACK points amount of the PAY transaction

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

ans..30

M

The PAYBACK membership identifier is only available in case of an active account binding and used to push users to fulfill transactions

IsBound

bool

M

Information if the PAYBACK account is bounded on the merchant side. Only in this case users can be pushed: True | False

CustomerGroup

enum

M

Information by the merchant about the customer which are used by Verifone Payments for risk evaluation: KNOWN | UNKNOWN

MerchantID

ans..30

M

MerchantID, assigned by Computop. Additionally this parameter has to be passed in plain language too.

PayID

an32

M

ID assigned by Paygate for the payment to be credited

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

refnr

ans..30

O

Merchant’s unique reference number

MAC

an64

M

Hash Message Authentication Code (HMAC) with SHA-256 algorithm. Details can be found here:

• HMAC Authentication (Request)

• HMAC Authentication (Notify)

ReqId

ans..32

O

To avoid double payments or actions (e.g. by ETM), enter an alphanumeric value which identifies your transaction and may be assigned only once. If the transaction or action is submitted again with the same ReqID, Computop Paygate will not carry out the payment or new action, but will just return the status of the original transaction or action.

Please note that the Computop Paygate must have a finalized transaction status for the first initial action (authentication/authorisation). This does not apply to 3-D Secure authentications that are terminated by a timeout. The 3-D Secure Timeout status does not count as a completed status in which the ReqID functionality on Paygate does not take effect. Submissions with identical ReqID for an open status will be processed regularly.

Notice: Please note that a ReqID is only valid for 12 month, then it gets deleted at the Paygate.

mid

ans..30

M

MerchantID, assigned by Computop

PayID

an32

M

ID assigned by Paygate for the payment, e.g. for referencing in batch files as well as for capture or credit request.

XID

an32

M

ID for all single transactions (authorisation, capture, credit note) for one payment assigned by Paygate

TransID

ans..64

M

TransactionID provided by you which should be unique for each payment

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

Description

ans..1024

M

Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis!

Code

an8

M

Error code according to Paygate Response Codes (A4 Error codes)

Amount

n..10

M

Amount in the smallest currency unit (e.g. EUR Cent). Please contact the Computop Helpdesk, if you want to capture amounts <100 (smallest currency unit).

Currency

a3

M

Currency, three digits DIN / ISO 4217, e.g. EUR, USD, GBP. Please find an overview here: A1 Currency table

paymentmethod

enum

M

Payment method used for refund: Sepa, VISA, MasterCard

payamount

n..10

M

The amount (e.g. -5500) that has been refunded by Sepa or credit card

pointamount

n..10

M

The PAYBACK points amount of the PAY transaction

pointsredeemed

n..10

M

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 a natural number.

RedemptionFactor

an..5

M

The redemption factor can be used to calculate the equivalent value of the redeemed points in Euros. As 100 points are the equivalent of 1 EUR the factor in Germany will be 0.01

• 55,00 EUR to pay

• can be paid with PAYBACK Points or direct debit or card

• 200 points have been selected for payment

• 53,00 EUR will be paid via direct debit

• Payment was successful