Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ENWORK and version Documentation

About
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
Instant Payment


General information about
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
Instant Payment

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
Instant Payment is based on the Standard Open Banking and belongs to payment category Online Bank Transfer.

The merchant initiates a payment, the customer is forwarded to an Open Banking Operator to allow country and bank selection and finally forwards the customer to their bank to approve and complete the payment.

Instant Banking allows different modes:

ModeDescription
sepaSupported by all banks and is based on SEPA payments.
sepaInstant

Supported by most banks and is based on SEPA Instant payments so money is transferred to merchant account typically within 10 seconds.

fasterPaymentsUsed specially in the United Kingdom and is using AccountNumber and SortCode.



Page properties
Logo


Info

Instant Payment is based on SEPA Instant Payment or Standard SEPA Payments and therefore widely supported and based on Open Banking Standards.

The implementation is currently based on platform Token.io.

TypePayments by Online Bank Transfer
 

Table of Contents

Use cases

Supported use cases

Supported interface

Use case

Description

Simple process

S-2-S

HPP

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 (one-shot)

Merchant wants to collect money from customer via OpenBanking

  • Merchant's shop initiates Instant payment request and receives URL to Open Banking Operator

  • Merchant redirects customer to Open Banking Operator URL
  • Customer enters bank account data (IBAN) and his/her name (account holder name) and confirms payment

  • Merchant's shop gets a notification about successful payment

(tick)

coming soon

full or partial Credit

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

  • not supported

coming soon


full or partial Reversal

Merchant wants to cancel a payment which has not been completed

  • not supported



Process flow chart

draw.io Diagram
bordertrue
diagramNameInstantPayment Sale
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109

Instant Payment process flow


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
interface

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameDefinition
PageWithExcerptDefinition EN


Calling the Instant Banking interface

To process a payment with online transfer with Instant Payment, call up the following URL:

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
OpenBanking.aspx


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameRequest_Intro
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1623741378316_1056203061
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNamerequest
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1623741378318_-1881547046
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMerchantID
pageMerchantID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

RefNr

an..18

M

Reference is mandatory and must be unique for each payment, allowed characters: A..Za..z0..9.

Die Referenznummer des Zahlungsvorganges. Sie muss eindeutig und einmalig sein und darf nur aus folgenden Zeichen bestehen: A..Za..z0..9

Table Excerpt Include
statictrue
nameAmount
pageAmount
typepage

Table Excerpt Include
statictrue
nameCurrency
pageCurrency
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Key

Format

CND

Description

Beschreibung

PayTypea..11O

Defines type of InstantPayment payment:

ValueMeaning
sepaInstant

InstantPayment type "sepaInstant" is used; default, if not specified

sepaInstantPayment type "sepa" is used
fasterPaymentsPayment type used in GB (UK)

Definiert die Art der InstantPayment Zahlung:

WertBedeutung
sepaInstant

InstantPayment type "sepaInstant" (default)

sepaInstantPayment type "sepa"
fasterPaymentsZahlung für GB (UK)
Accountan..30O

If you have multiple Bank Accounts configured at Open Banking Operator and setup in

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
, you may select another one than the default.

The account can be named, e.g.

  • MerchantShop1 → referring to bank account IBAN1 DE01123456781234567890
  • MerchantShop2 → referring to bank account IBAN2 FR02123456781234567890
  • MerchantUK → referring to a fasterPayments-Setup using another bank account (via AccountNo, Sortcode)

The naming for "account" needs to be agreed with

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
.

Wenn Sie beim Open Banking Operator mehrere Bankverbindungen konfiguriert und in

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNamePlatform-Name
PageWithExcerptDE:Wording
eingerichtet haben, können Sie eine andere als die Standard-Bankverbindung auswählen.

Das Konto kann benannt werden, z.B.

  • MerchantShop1 → verwendet Bankkonto IBAN1 DE01123456781234567890
  • MerchantShop2 → verwendet  Bankkonto IBAN2 FR02123456781234567890
  • MerchantUK → verwendet das FasterPayments-Setup (UK) (über AccountNo, Sortcode)

Der Wert für "Account" ist bitte mit unserem

Multiexcerpt include
SpaceWithExcerptDE
MultiExcerptNameHelpdesk-Name
PageWithExcerptDE:Wording
abzustimmen.

OrderDesc

ans..768

O

Description of purchased goods, unit prices etc.

That value is shown to the consumer in the OpenBanking Payment Form.

Beschreibung der gekauften Waren, Einzelpreise etc.

Dieser Wert wird dem Endkunden im OpenBanking Zahlungsformular angezeigt.

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameURLSuccess
pageURLSuccess
typepage

Table Excerpt Include
statictrue
nameURLFailure
pageURLFailure
typepage

Table Excerpt Include
statictrue
nameResponse
pageResponse
typepage

Table Excerpt Include
statictrue
nameURLNotify
pageURLNotify
typepage

Table Excerpt Include
statictrue
nameReqId-ans..32
pageReqId
typepage

Table Excerpt Include
statictrue
namePlain
pagePlain
typepage

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

Parameters for online transfers with Instant Payment


Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameResponse_IntroURL
PageWithExcerptReuse API

Table Filter
defaultBeschreibung
isFirstTimeEnterfalse
hideColumnstrue
sparkNameSparkline
hidePanetrue
datepatterndd M yy
id1623742037710_1376413864
worklog365|5|8|y w d h m|y w d h m
isORAND
separatorPoint (.)
order0
Multiexcerpt
MultiExcerptNameresponse
Table Transformer
dateFormatdd M yy
export-wordfalse
show-sourcefalse
export-csvfalse
id1623742037712_1947564843
transposefalse
worklog365|5|8|y w d h m|y w d h m
separator.
export-pdffalse
sqlSELECT * FROM T*

Table Excerpt Include
statictrue
nameMID
pagemid
typepage

Table Excerpt Include
statictrue
namePayID
pagePayID
typepage

Table Excerpt Include
statictrue
nameXID
pageXID
typepage

Table Excerpt Include
statictrue
nameTransID
pageTransID
typepage

Key

Format

CND

Description

Beschreibung

Status

a..50

M

OK (URLSuccess) or FAILED (URLFailure)

AUTHORIZE_REQUEST (URLSuccess), Description=PENDING: it may take up to an hour to get final status

OK (URLSuccess) oder FAILED (URLFailure)

AUTHORIZE_REQUEST (URLSuccess), Description=PENDING: es dauert bis zu einer Stunde bis zum finalen Status

Table Excerpt Include
statictrue
nameStatus_OK_FAILED
pageStatus
typepage

Table Excerpt Include
statictrue
nameDescription
pageDescription
typepage

Table Excerpt Include
statictrue
nameCode
pageCode
typepage

Key

Format

CND

Description

Beschreibung

RefNr

ans..30

M

Reference is mandatory and must be unique for each payment, allowed characters: A..Za..z. Digits are not allowed!

Die Referenznummer des Zahlungsvorganges. Sie muss eindeutig und einmalig sein und darf nur aus folgenden Zeichen bestehen: A..Za..z. Ziffern sind nicht erlaubt!
TransactionIDans..64MUnique transaction id returned by InstantPayment (transfer-id).Eindeutige TransaktionsId von InstantPayment (transfer-id).
ExtCoden..3OExternal Response Code from Open Banking Operator

Table Excerpt Include
statictrue
nameUserData
pageUserData
typepage

Table Excerpt Include
statictrue
nameMAC
pageMAC
typepage

Table Excerpt Include
statictrue
namePlain
pagePlain
typepage

Table Excerpt Include
statictrue
nameCustom
pageCustom
typepage

Return parameters for URLSuccess, URLFailure and URLNotify with Instant Payment


Setup with OpenBanking-provider Token.io

As

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePartner-Name
PageWithExcerptWording
does not have access to your Token.io setup you need to send us the information required for setup in
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
.

You will have access to your Token.io-Dashboard after signing the contract.

Please login into your Token.io Dashboard (https://dashboard.token.io/) and send the information to

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
- in clear text, not as a screenshot:

A sample mail to

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
could look like:

Panel

My Token.io setup

Table Filter
hideControlsfalse
inversefalse
totalrow,,,,,
hidelabelsfalse
sparkNameSparkline
hidePanetrue
disableSavefalse
separatorPoint (.)
sparklinefalse
labelsHide Columns
defaultKategorie&&Kommentar&&Wert
isFirstTimeEnterfalse
cell-width150
hideColumnstrue
datepatterndd M yy
disabledfalse
enabledInEditorfalse
globalFilterfalse
id1684488845587_251515740
updateSelectOptionsfalse
worklog365|5|8|y w d h m|y w d h m
isORAND
order0
Multiexcerpt
MultiExcerptNameTokenSetup
CategoryKategorieValueWertCommentKommentar
Account SettingAccount Setting



Company NameCompany NameJohn Doe LimitedMax Mustermann GmbH

Member InformationMember Information



Member IDMember IDm:YCkxxxxxxxxxxxxxxxxxxxxxxxv:5zKtXEAqm:YCkxxxxxxxxxxxxxxxxxxxxxxxv:5zKtXEAq

AliasAlias{"type":"DOMAIN","value":"xxxxxxxxxxxxx"}{"type":"DOMAIN","value":"xxxxxxxxxxxxx"}

Public Token KeyPublic Token KeyiYCC0wJXDO0Q-Bqqyi49mD_z-_IWqfmlP_jwGWWNKdsiYCC0wJXDO0Q-Bqqyi49mD_z-_IWqfmlP_jwGWWNKdsShould always be this value; Pls. let us know if it's a different one.Es sollte immer dieser Wert sein; wenn nicht, teilen Sie uns diesen bitte mit.
Authentication KeysAuthentication Keys



API KeyAPI KeybS1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxzJmbS1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxzJm

Beneficiary InformationBeneficiary Information



BeneficiaryBeneficiary
Account NameCountryCurrencyIBAN / Account NumberBIC / Sort Code
DE01GermanyEURYour IBAN used as standardYour BIC used as standard
DE02GermanyEUR
Optional: Another IBAN which could be selected via
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
-parameter "Account"
BIC for this IBAN
UK01United KingdomGBPOptional: Your Account Number for UK / FasterPaymentsYour Sort Code for UK / FasterPayments
Account NameCountryCurrencyIBAN / Account NumberBIC / Sort Code
DE01GermanyEURDie IBAN, welche standardmäßig verwendet werden sollDie BIC, welche standardmäßig verwendet werden soll
DE02GermanyEUR
Optional: Eine weitere IBAN, welche mit dem 
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
-Parameter "Account" selektiert werden kann
BIC für diese IBAN
UK01United KingdomGBPOptional: Ihre Kontonummer für UK / FasterPaymentsIhr Sort Code für UK / FasterPayments


Customization and Testing with OpenBanking-provider Token.io

How a payment looks like

Multiexcerpt
MultiExcerptNamesamplePayment
Table Filter
hideControlsfalse
inversefalse
totalrow,,,
hidelabelsfalse
sparkNameSparkline
hidePanetrue
disableSavefalse
separatorPoint (.)
sparklinefalse
labelsHide Columns
defaultBeschreibung
isFirstTimeEnterfalse
cell-width150
hideColumnstrue
datepatterndd M yy
disabledfalse
enabledInEditorfalse
globalFilterfalse
id1684743378904_-1206727663
updateSelectOptionsfalse
worklog365|5|8|y w d h m|y w d h m
isORAND
order0
Multiexcerpt
MultiExcerptNameParameterMapping
EnglishGermanDescriptionBeschreibung

Static:

  • Logo is taken from Token.io-Dashboard → Configuration → CSS
  • To / Empfänger is from Token.io-Dashboard → Configuration → Display name


Dynamic / from API request:

  • One-time payment of / Einmalzahlung is taken from API-amount (e.g. amount=123)
  • Transaction Ref No / Ende-zu-Ende Referenz is taken from API-RefNr
  • Description / Verwendungszweck is taken from API-OrderDesc


Consumer:

  • selects From / Von to choose consumer bank
  • and enters IBAN
  • then Accept payment to login into consumer bank and confirm payment


How to customize your payment / Token.io-account

After signing your contract with the Open Bank Operator (Token.io) you will get access to their dashboard.

There you can set up:

  • your user details and company information (e.g. Company name, Billing details, ...)

Settings → Configuration

General

Here the "Display Name" can be changed. This is the recipient shown to the consumer ("To" / "Empfänger"):

Multiexcerpt
MultiExcerptNameTokenGeneral

Webhook

Webhook must be set to technical

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Name
PageWithExcerptWording
URL:
Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameBaseURL
PageWithExcerptWording
/OpenBankingComplete.aspx

Multiexcerpt
MultiExcerptNameTokenWebhook

Web App Bank Selection

It's possible to limit bank selection for your consumers. It's recommended to allow "Enable all banks". The consumer can then select any supported bank.

CSS (styling of Token.io Web App (shown to your customer)

It's possible to upload your own merchant logo and customize CSS styling of Web App (shown to consumer):

Multiexcerpt
MultiExcerptNameTokenCss

After you've uploaded your merchant logo and customized your CSS styles the new WebApp-layout can be tested via Payload Builder:


After doing CSS modification a test payment can be initiated to check design:

  • API Key and MemberID are automatically set by Payload Builder
  • (4) Description must be unique for each payment
  • (5) Amount must be used with decimal point
  • (6) Currency must be EUR
  • (7) IBAN is merchant's IBAN, i.e.: any of your benificiary IBAN
  • (8) merchant's BIC is optional → leave empty
  • (9) for testing use any Url, e.g. https://www.google.com
  • (10) click on "Generate"

Then click on Test (1)


A new tab/window will open with new design:


Anchor
key
key
Settings → Authentication Keys

Please generate an API Key for your configuration and send it to

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
:

Multiexcerpt
MultiExcerptNameTokenKey

We also need your MemberID and other information which is shown in next section.

Anchor
member
member
Settings → Member Information

The information shown here is also needed for setup in

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNameHelpdesk-Name
PageWithExcerptWording
:

Multiexcerpt
MultiExcerptNameTokenKey

Anchor
beneficiary
beneficiary
Settings → Beneficiary

Your merchant account may have multiple bank accounts configured. Each bank account can have an account name (assigned by you) and is defined

  • either with IBAN/BIC (SEPA based)
  • or with Account Number / Sort Code (FasterPayments / UK)

A sample setup may look like this:

Multiexcerpt
MultiExcerptNameTokenBeneficiary

Testing in Sandbox-mode

As long as your OpenBanking Setup is not setup in Production Mode you can test it in Sandbox Mode.

Therefore please use test data shown here: Test Instant Payment