Open Banking Documentation
ITA Documentation
Acquiring Documentation
Issuing Documentation
WL 1-Click REST API Resources Diagram
WL 1-Click REST API Resources Diagram
Accept Transactions API (test)
This API enables you to Accept transactions for your Merchant customers.
Transactions are accepted via a host-to-host connection between the API user and Worldline FS API GateWay. The Worldline FS API GateWay is connected to the Worldline FS acceptance host, which in turn is connected to the Issuer network.
Version note:
This is a test version. Please be aware that these API interfaces are for evaluation. The API interfaces may be changed and improved.
Initial production release is planned for Q2 2023 to accept Card Not Present transactions. The API roadmap for 2024 includes POS transaction acceptance via this API.
The sandbox for this new API is not yet available causing the "Try out" feature to not work properly for this API.
Latest open API spec below includes drop-down examples of requests (e.g. Purchase VISA Authorisation) and drop-down examples of successful "200" responses.
Accept Transactions (test)
Accept Transactions (test)
This API enables you to accept Card Not Present (CNP) and POS transactions for your Merchant customers.
Transactions are accepted via a host-to-host connection between the API user and Worldline FS API GateWay. The Worldline FS API GateWay is connected to the Worldline FS acceptance host, which in turn is connected to the Issuer network.
Version note:
This is a test version. Please be aware that these API interfaces are for evaluation. The API interfaces may be changed and improved.
Initial production release is planned for Q2 2023 to accept Card Not Present transactions. The API roadmap for 2024 includes POS transaction acceptance via this API.
Acceptance actions
AUTH
CAPTURE
AUTH_REVERSAL
AUTH_REVERSAL_PARTIAL
AUTH_INCREMENTAL
AUTH_AND_CAPTURE
PREAUTH
Use Cases
Purchase
Refund
Account Verification
Recurring
3D Secure v2
Card-On-File
Are you looking for more information?
Credit Insight
Credit Insight
Introduction
Credit Insight, is an Open Banking Product which relies on an AIS collection of transaction data for the selected client.
The prerequisites to provide a Credit Insight analysis are :
- At least one CHECKING account provided
- At least 20 transactions within the last 90 days
- Transactions must be in EURO
- A callback URL must be provided beforehand.
The workflow goes as follows :
-
The Initiating Party posts and initiates a registration for the client, and chooses the relevant product option.
-
Worldline responds with the appropriate URL for the consent and AIS session, and the client is then redirected to the AIS Bank selection pages.
-
Once the client has selected its bank(s) and accounts, Worldline collects the transactions and balances for the last three months from the bank(s).
-
The Credit Insight analysis is performed, and once the results are available, they are sent to the Initiating Party's callback URL.
Details
For the Credit Insight usecase the relevant and usable endpoints are within the Account Information extended service:
-
POST /register : initiates the process
-
POST /register/{registrationId}/initialisation/{psuId} : used to retrieve the URL to the AIS consent page for the PSU (client)
-
GET /register/{registrationId}/status : allows the Initiating Party to know the status of the process (optional)
After the process is initiated and the client has consented to give access to his account(s), the processing begins on the Credit Insight engine.
Once it has completed, the Initiating Party receives the response on the callback URL they provided during the onboarding.
The initial POST /register call should be as follows:
POST /register
{
"RegistrationId": "<registration_id>",
"Psus": [
{
"PsuId": "<psu_id>"
},
],
"Parameter":[
{
"Key":"option",
"Value":"NONE||CS||PS||CSPS"
}
]
}
The Product options need to be specified, in the "Parameter" field. Depending on the items the Initiating party needs returned. In any case, the base response will comprise the Credit Insights, which are further detailed below. The Product options are :
- CS : Credit Score
- PS : Payment Score
- CSPS : Both
- NONE : No scores, only the insights
Credit Insights: The Credit Insights service takes the raw balance and transaction data from the bank and transforms this into an insightful financial report.
All of the transactions are categorized with a specific focus credit, important data is flagged (such as existing loans, payment rejections, etc…) and useful metrics are calculated.
All of this is delivered by API to provide you an instant analysis based on data retrieved directly from the consumer’s bank.
Credit Score: The Credit Score is a number score out of 1000 (a consumer with a score of 0 is the most risky and 1000 the least risky). This number provides a highly accurate predictive assessment of the risk of default within 12 months of the scoring.
Payment score: The payment score is designed for use with short-term credit (repayment period of around 3 months). This is provided as a score out of 10 (a consumer with a score of 0 is the most risky and 10 the least risky).
The second call (POST /register/<registration_id>/initialisation/<psu_id>) is meant to provide a base country for the initiation screens that will be shown to the client.
POST /register/<registration_id>/initialisation/<psu_id> { "PsuData":{ "Country": "FR||DE||XY.." } }
After the client has consented to the AIS process, the transactions are fetched and processed in the WL Credit Insight engine.
Once the analysis is performed, the following insights are sent within the response to the Initiating Party :
Object name |
In Object |
Description of the items |
Balances |
balance balanceDate |
Balances of the client's accounts. |
Incomes |
totalAmount incomesDetails (object) |
Summary of the client's sources of incomes. Details show a breakdown in types and temporality of incomes. |
Expenses |
totalAmount
expensesDetails (object) fixedCharges otherExpenses |
Summary of the client's expenses. Details show a breakdown of the expenses, notably the fixed charges. |
Loans |
loanRepaymentsCount loanRepayments (object) monthlyAmount loanProviders drawdownsCount totalDrawdownAmount monthlyDrawdownAmount |
Summary of the loan repayment transactions on the client's account. |
Risks |
gamblingTotalAmount gamblingTransactionsCount gamblingTransactions paymentRejectionsCount paymentRejections paymentRejectionsTotalAmount checkRejectionsCount checkRejections checkRejectionsTotalAmount interventionFeesCount interventionFees interventionFeesTotalAmount overdraftReachedAmount overdraftDuration overdraftFeesCount overdraftFees wageAdvancesCount wageAdvances wageAdvancesTotalAmount directRecoveriesOfDebtCount directRecoveriesOfDebt directRecoveriesOfDebtTotalAmount bankAccountSeizuresCount bankAccountSeizures bankAccountSeizuresTotalAmount |
Detailed list of all identified transactions that fit a risky behavior. |
Account Information Overview
Account Information overview
What is Account Information Service and how do i get started?
What is Account information?
Account Information Service (AIS) is one of the services established by the Payment Services Directive 2 (PSD2) and aimed to simplify the retrieval of account information. The PSD2 allows Third Party Providers (TPPs) access to the bank's 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 account information to initiate a AIS request.
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