Sandbox description PIS

Payment Initiation Scenarios

Below are list of Payment Initiation Services (PIS) scenarios and documentation of guideline steps user can perform to try out each scenario.

 Sr. No.

 Scenario Name

 ASPSP ID

 Scenario Guideline

 01.

 Payment with Redirect Authorisation

 20100

 Read More

 02.

 Payment Confirmation with Redirect Authorisation

 20110

 Read More

 03.

 PreAuth Payment with Redirect Authorisation

 20115

 Read More

 04.

 Periodic Payment with Redirect Authorisation

 20220

 Read More

 05.

 Scheduled Payment with Redirect Authorisation

 20111

 Read More

 06.

 Bulk Payment with Redirect Authorisation

 20210

 Read More

 07.

 Payment with Decoupled Authorisation

 20200

 Read More

 08.

 Payment with Embedded Authorisation

 20105

 Read More

 09.

 Explicit PreAuth (in Embedded) Payment with Embedded Authorisation

 20120

 Read More

 10.

 Payment with Redirect and Embedded - Hybrid Authorisation

 20121

 Read More

 11.

 Cancel Payment

 20114

 Read More

 

Enable "on this page" menu on doc section
On

Payment Initiation overview

Payment Initiation overview

What is Payment Initiation and how do i get started?

What is Payment initiation?

Payment Initiation Service (PIS) is one of the services established by the Payment Services Directive 2 (PSD2) and aimed to simplify the initiation of account payments in both the online and physical stores. The PSD2 allows Third Party Providers (TPPs) access to the bank accounts to initiate a payment (PIS) or retrieve account information (AIS) after the account holder (PSU) has given his consent to the TPP.

A payer (PSU) has to consent to a TPP for payment initiation to initiate a PIS request. Such consent must be acquired for every payment and granted to a TPP after successful authentication of the payer by their bank (ASPSP).

PIS can be initiated with different payment products, depending on the bank (ASPSP) and its country:

  • SEPA credit transfers (SCT) and Instant payments (SCT Inst) in the SEPA zone within the available reach.
  • UK domestic and international payments
  • Domestic (non-SEPA) credit transfers in Bulgaria, Czech Republic, Hungary and Romania, Denmark, Sweden, Norway and Finland
  • Target2
  • Cross-currency

Next to the single PIS, our APIs can be used to initiate extended payment types:

  • Future dated payments (payments to be executed on a specific date in the future)
  • Standing orders (recurring payments)
  • Bulk payments (a series of payments from a single debtor account into multiple credit accounts, for example, salary or invoice payments)

Discover our API's

  • Sequence diagrams explaining the possible flows can be found on the 'Read more' pages.
  • The Yaml files can be found under the 'view API' buttons
  • We provide a sandbox environment where you can complete (mock) flows. See details here:

Choose your connection type

1) Connect to our initiation pages (or webview?) which integrates the equensWorldline XS2A PSD2 core service with banks' API services (ASPSPs) using a series of dedicated equensWorldline landing pages. This service aims to ease the work on individual deviations of bank interfaces by automatically requesting the correct data fields from the user. This service is designed to facilitate working with individual deviations from bank interfaces by automatically requesting the correct data fields from the user. This eases the user experience and integrates these deviations into a flexible and adaptive UI, ready to be invoked by the web application.

2) connect directly to our routing service API's, integrating the equensWorldline XS2A PSD2 core service with banks' API services (ASPSPs) through a set of API calls that are transparent to end customers (PSU)

Ready to connect?

  • Get in touch with our sales team: Send email
  • Using PSD2 requires a Third Party Provider certificate provide by the national authority. This certificate will be stored in our solution. So that we can connect to ASPSP's with the correct authentication. We will help with the ordering process.
  • We set you up on our backoffice, you will receive a username password to complete the registration process. Which includes providing a public key from the certificate you will be using to connect to us.
  • Call the post token api, to retrieve the token which you will use to connect to our other api's
  • Call the get aspsps api, to retrieve the list of banks you will be able to reach with our solution

Our versioning policy

short description of our versioning policy - We are currently at version 2. 

 

Enable "on this page" menu on doc section
On

Sandbox description AIS

Account Information Services Scenarios

Below are list of Account Information Services (AIS) scenarios and documentation of guideline steps, user can perform to try out each scenario.

 Sr. No.  Scenario Name  ASPSP ID  Scenario Guideline

 01.

 AIS with Redirect Authorisation and Accounts, Balances & Transactions (Date filter only)

 20101

 02.

 AIS with Redirect Authorisation and Accounts, Balances & Transactions (DateTime filter)

 20116

 03.

 AIS Download Transactions

 20102

 04.

 AIS Delete Consents

 20101

Enable "on this page" menu on doc section
On

Statements (beta test)

Technical Description

 

This API allows you to provide specifications explaining the merchant payment to your merchant customers. Combined with the transactions API, all details can be provided to your merchant customer.

Version note:

This API is currently in beta test.

Please be aware that these API interfaces are for evaluation. The API interfaces may be changed and improved.

Merchant analysis (test)

Merchant analysis (test)

Make trends, revenue and transaction totals insightful for your merchants. You can use our API to create charts and graphs, supply totals without having to retrieve all the transaction details. Totals can be divided by brand and type on a daily, or monthly basis. The API can be used to retrieve the totals on all levels of the merchant hierarchy.

Benefits for you!

rak

Efficiency

 

Show transaction and revenue totals to your merchants without the need to first retrieve all the details.

puzz

Complete overview

 

The merchant gets insights on the use of different brands and the number of refunds on cluster, merchant, contract and site level.

hand

Improve user experience

 

Enhance your merchant’s experience by integrating his transaction data in your own environment. A separate portal is not necessary anymore

Who can use this API?

acq

Acquirers

 

 

psp

PSPs

merch

Merchants

Why use it?

The merchant wants to see the total number of transactions, total revenue for a specific period without having to wait long, browse through big amounts of data, or retrieve his information in different portals. The Merchant Analysis API delivers the totals fast and on the level the merchant requires it, divided by brand and type.

USE CASE

Transaction data gives new consumers insights

lamp

A large clothes store with multiple locations, is now able to analyze the amount of refunds and chargebacks versus the transactions, to compare how his different locations perform on client satisfaction.

How it works

Step 1

The merchant logs in to your app or portal and clicks on “Store Transaction Analysis” (or any other name you branded the Worldline FS API with)

Step 2

Your app or portal transfers the request to the Worldline FS API by using one of the available API Operation

Step 3

The Worldline FS API retrieves the requested data

Step 4

The API delivers the requested data in JSON format to your app/portal

Step 5

Your app/portal reformats this information in plain text, a table, or a graph and presents it to the merchant

Step 6

The merchant uses this information for his analysis

Statements (beta test)

Statements (beta test)

With the Statements API you will be able to search for and retrieve Statements that specify the merchant payment (payout) to your (sub-)merchant customers. Combined with the transactions API, all detail can be provided to your (sub-)merchant customer.

This API enables you to search for Reconciliation Statements based on payments reference and on specific periods of time.

Benefits for you!

hand

Control

 

Control the look and feel of the statement by formatting the received data using your own templates.

loc

One location

 

Present the statement explaining the merchant and the payment itself in one location.

owb

Own environment

 

Present the statements in your own app or portal based on your own client data.

Who can use this API?

acq

Acquirers

psp

PSPs

 

Interchange fees (beta test)

Technical Description

 

This API enables you as a Acquirer or PSP to provide your client with interchange fee data. The API retrieves the interchange data based on transactions, payments, contract entity and specific periods of time.

Version note:

This API is currently in beta test.

Please be aware that these API interfaces are for evaluation. The API interfaces may be changed and improved.

Interchange fees (beta test)

Interchange fees (beta test)

This API enables you as an Acquirer or PSP to provide your client with interchange fee data and key fields associated with the rate. The API retrieves the interchange data based on transactions, payments, contract entity and specific periods of time.

Benefits for you!

puzzle

Complete

 

Complete your transaction information with interchange fee data and gain insight into rates and fees

schild

Compliant

 

Become compliant by providing the interchange fee data to your merchants

grafiek

Own environment

 

Present interchange fee data in your own app or portal

Who can use this API?

Acq

Acquirers

PSP

PSPs

Why use It?

This API enables you to use certain criteria from other APIs (e.g. transactionId of presentments) to retrieve interchange data and show it in your application.

USE CASE

Be compliant and provide Interchange data to your customers

Use case

A webshop would like to compare the interchange fee for domestic vs cross-border transactions. With this API the merchant has better insight into the transaction cost of different types of consumers.