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


interface


Call of interface for Paytweak

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

paybylinkexternal.aspx


Key

REST

Format

CND

Description

Beschreibung

bdEmail

"billing": {"contactInfo": {"email": "..." }}

ans..32

M

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

E-Mail-Adresse des Kunden. Falls Pay By Link per E-Mail versendet wird, erfolgt der Versand an diese Adresse.

bdPhone

"billing": {"contactInfo": {"mobilePhone": "..." }}

n..16

M

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

Telefonnummer des Kunden. Falls der Pay-By-Link per SMS gesendet wird, wird er an diese Nummer gesendet.

bdFirstName

"billing": {"contactInfo": {"firstName": "..." }}

ans..32

O

First name of the customer

Vorname des Kunden

bdLastName

"billing": {"contactInfo": {"lastName": "..." }}

ans..32

O

Last name of the customer

Nachname des Kunden

Gender

"billing": {"contactInfo": {"gender": "..." }}

a1

O

Gender

Geschlecht

bdStreet

"billing": {"addressInfo": {"addressLine1": {"street": "..." }}}

ans..100

O

Street name

Straßenname

bdStreetNr

"billing": {"addressInfo": {"addressLine1": {"streetNumber": "..." }}}

ans..30

O

House number

Hausnummer

bdStreet2

"billing": {"addressInfo": {"addressLin2": "..." }}

ans..100

O

Additional address information

Zusätzliche Adressinformationen

bdZIP

"billing": {"addressInfo": {"postalCode": ... }}

n..9

M

Postal code

Postleitzahl

bdCity

"billing": {"addressInfo": {"city": "..." }}

ans..20

O

City

Ort

bdCountryCode

"billing": {"addressInfo": {"country": {"A2": "..." }}}

a2

M

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

Ländercode der Adresse des Kontoinhabers, 2 Zeichen gemäß ISO 3166

OrderId

"order": {"id": "..."}

ans..30

O

Contract ID (BNP specific)

Vertrags-ID (BNP-spezifisch)

InvoiceId

"order": {"number": "..."}

ans..30

O

Invoice ID (BNP specific)

Rechnungs-ID (BNP-spezifisch)

partialPayment

"metadata[partialPayment]": "..."

bool

O

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

Gibt an, ob die Zahlung teilweise erfolgt oder nicht. Wird bei der Duplikatsprüfung verwendet.

Key

REST

Format

CND

Description

Beschreibung

Service

"payment": {"paybalinkexternal": {"serviceType": "..."}}

a..16

M

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

Possible values:

  • link
  • email
  • SMS

Dieser Wert dient zur Identifizierung der Versandmethode für den Zahlungslink an den Kunden.

Mögliche Werte:

  • link
  • email
  • SMS

language

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

Sprache der Zahlungsseite (falls aktiviert, auch Sprache der Bestätigungs-E-Mail und der Bestätigungsseite). Zusätzlich Sprache der E-Mail/SMS mit dem Bezahllink.

externalTemplate

"payment": {"paybalinkexternal": {"externalTemplate": "..."}}

ans..32

C

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

Mandatory for service SMS/Email

Name der für E-Mail oder SMS zu verwendenden Vorlage.

Obligatorisch für den Dienst SMS/E-Mail

Expiration

"payment": {"paybalinkexternal": {"lifeTime": ...}}

n..3

O

Pay by link expiration (in days)

Ablaufdatum von "Pay by link" (in Tagen)

Parameters for payments with Paytweak


Key

REST

Format

CND

Description

Beschreibung

redirecturl

"links": {"redirect": {"href": "..." }}

ans..256

M

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

Enthält die URL der -Zahlungsseite. Diese dient nur als Referenz. Geben Sie sie nicht an den Kunden weiter.

externalresponse

"payment": "..."

ans..256

M

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

Enthält die URL des Bezahllinks und die Bestellnummer als Referenz. Der QR-Code ist ein Platzhalter und wird in Zukunft verwendet.

externallink

"payment": {"url": "..."}

ans..128

M

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

Enthält die URL zum Bezahlen per Link. Diese URL wird vom Kunden für die Zahlung verwendet.

linkchannel

"linkchannel": "..."

a..16

M

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

Enthält Informationen darüber, wie der Link an den Kunden gesendet wird, per E-Mail, SMS oder manuell vom Händler

linkexpiry

"linkexpiry": "..."

ans..32

M

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

Datums-/Zeitstempel, wann der Link abläuft und nicht mehr verwendet werden kann

linkcreated

"linkcreated": "..."

ans..32

M

Date/time stamp when the link was created

Datums-/Zeitstempel, wann der Link erzeugt wurde

Results parameters for URLNotify, URLSuccess and URLFailure with Paytweak