About Paytweak

General information about Paytweak

Paytweak PayByLink solution by Email and SMS. The payment link generated by Paytweak is directly connected to 500 banks and PSP around the world. It secures, speeds up, and removes frictions for all incoming payments.

Logo

Info

Paytweak PayByLink solution by Email and SMS. The payment link generated by Paytweak is directly connected to 500 banks and PSP around the world. It secures, speeds up, and removes frictions for all incoming payments.

TypeMixed payment methods

Further information can be found on the webpage of Paytweak (https://www.paytweak.com/).


Process flow chart

Paytweak process flow


Paygate interface

Definitions

Data formats

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)


Abbreviations

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


Notice: Please note that the names of parameters can be returned in upper or lower case.


Call of interface for Paytweak

To make a payment with Paytweak, please use the following URL:

https://www.computop-paygate.com/paybylinkexternal.aspx


Notice: For security reasons, Computop Paygate rejects all payment requests with formatting errors. Therefore, please use the correct data type for each parameter.

The following table describes the encrypted payment request parameters:

KeyFormatCNDDescription

MerchantID

ans..30

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Amountn..10M

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

KeyFormatCNDDescription
Currency

a3

M

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

KeyFormatCNDDescription

MAC

an64

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

Key

Format

CND

Description

bdEmail

ans..32

M

Email address of the customer. In case Pay By Link is sent via email, it will be sent to this address.

bdPhone

n..16

M

Customer phone number. In case Pay By Link is sent via SMS it will be sent to this number.

bdFirstName

ans..32

O

First name of the customer

bdLastName

ans..32

O

Last name of the customer

Gender

a1

O

Gender

bdStreet

ans..100

O

Street name

bdStreetNr

ans..30

O

House number

bdStreet2

ans..100

O

Additional address information

bdZIP

n..9

M

Postal code

bdCity

ans..20

O

City

bdCountryCode

a2

M

Country code for the account holder’s address, 2 characters according to ISO 3166

OrderId

ans..30

O

Contract ID (BNP specific)

InvoiceId

ans..30

O

Invoice ID (BNP specific)

partialPayment

bool

O

Indicates if payment is partial or not. It is used during duplication check.

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

(info) 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. Therefore ensure to check the "code"-value which indicates success/failure of the action. Only a result of "code=00000000" should be considered successful.

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

(info) 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.

KeyFormatCNDDescription
Response

a7

O

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

KeyFormatCNDDescription
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 UserData parameter instead.

(info) 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.

Key

Format

CND

Description

Service

a..16

M

This value is used to identify the method of sending Pay By Link to the customer.

Possible values:

  • link
  • email
  • SMS

language

a2

O

Language of the payment page, (if activated, also language of confirmation email and confirmation page). Additionally language of the email/SMS containing the pay by link.

externalTemplate

ans..32

C

Name of the template to be used for email or SMS.

Mandatory for service SMS/Email

Expiration

n..3

O

Pay by link expiration (in days)

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

KeyFormatCND

Description

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.

Parameters for payments with Paytweak


The following table gives the result parameters which Computop Paygate transmits to URLSuccess or URLFailure and URLNotify. If you have specified the Response=encrypt parameter, the following parameters are sent Blowfish encrypted to your system:

(info) pls. be prepared to receive additional parameters at any time and do not check the order of parameters

(info) the key (e.g. mid, RefNr) should not be checked case-sentive

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

KeyFormatCNDDescription

mid

ans..30

M

MerchantID, assigned by Computop

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

KeyFormatCNDDescription
XID

an32

M

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

KeyFormatCNDDescription
TransID

ans..64

MTransactionID provided by you which should be unique for each payment

KeyFormatCNDDescription
Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

KeyFormatCNDDescription
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!

KeyFormatCNDDescription
Code

an8

M

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

KeyFormatCNDDescription

MAC

an64

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

Key

Format

CND

Description

redirecturl

ans..256

M

Contains Computop payment page URL. This is only for reference. Do not share with the customer.

externalresponse

ans..256

M

Contains pay by link URL and order ID for reference. QR code is a placeholder and will be used in future.

externallink

ans..128

M

Contains pay by link URL. This URL will be used by customer for payment.

linkchannel

a..16

M

It provides an information how link is sent to the customer, via email, sms or manually by merchant

linkexpiry

ans..32

M

Date/time stamp when the link will expire and can not be used anymore

linkcreated

ans..32

M

Date/time stamp when the link was created

Results parameters for URLNotify, URLSuccess and URLFailure with Paytweak