Payment with Redirect Authorisation

Payment with Redirect Authorisation

In the Redirect Authorisation Approach, the browser session of the customer (PSU) is redirected from the Initiating Party to the ASPSP Mock. In that case the ASPSP Mock provides all the pages required for authentication (usually username, password). After that the customer (PSU) is redirected to the TPP solution and from there back to the Initiating Party (user).

Take the following steps to complete this scenario.

 

Step – 1 : Get the reach details :

Reach details provides list of APIs needs to be used for this scenario and mandatory fields needs to be passed for successful API call towards ASPSP mock.

Call the reach API – GET /aspsp. Get the ASPSP details with Name = Payment Redirect and the ASPSP ID = “20100”, which has to be used to initiate the payment with redirect mode of authorisation and other further payment related requests.

Remark : Details of reach information provided in developer portal are limited and informational purpose to give initiating party (user) an idea about how reach information looks like. Initiating party (user) can skip this step and use specified ASPSP ID for the scenario to try out. User can get the ASPSP ID for appropriate scenario from "Scenario Guideline" page or from the list of "Payment Initiation Scenarios" page.

 

Step – 2 : Initiate the payment :

Call the POST /payments API with mandatory fields in request header and body. In response of POST /payments, initiating party (user) will receive payment ID, ASPSP redirect link to authorise the initiated payment and link to call GET /payments/status API to get the status of the initiated payment.

If GET /payments/status endpoint has been called before user provides his / her approval, initiating party (user) will receive payment status = “Open” from the ASPSP Mock in response.

 

Step – 3 : Authorise or Cancel the payment at ASPSP Mock :

With ASPSP redirect link received in response of POST /payments, customer (PSU) will get redirect to ASPSP Mock GUI login page. On this login page, customer (user) can provide dummy credential details as this is example purpose only. Once customer (PSU) provides his / her dummy credentials, he / she will be redirected to ASPSP Mock GUI page with “Approve” & “Deny” buttons to authorise or cancel the payment.

If customer (PSU) “Approve” the payment, payment will get initiated with the ASPSP Mock and customer (PSU) will redirect back to initiating party (user).

If customer (PSU) “Deny” the payment, ASPSP Mock will reject the initiated payment and customer (PSU) will redirect back to initiating party (user).

Remark : GUI page of ASPSP Mock to approve or deny the payment is just a demo purpose. Actual ASPSP GUI page to approve or deny the payment may vary based on ASPSP.

 

Step – 4 : Get the payment status :

Call the GET /payments/status API to get the latest payment status from ASPSP Mock.

If payment is authorised by customer (PSU), initiating party (user) will receive payment status = “Settlement Completed” as final payment status.

If payment is deny by customer (PSU), initiating party (user) will receive payment status = “Cancelled” as final payment status.

Remark : Payment status provided for this scenario is just to guide initiating party (user) for payment initiation process. Actual payment status may vary based on scenario from actual ASPSP.

 

Sequence Diagram :

 

Payment with Redirect Authorisation
Enable "on this page" menu on doc section
On

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