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)
Technical Description
You can use this API to create charts and graphs, supply totals without having to retrieve all the transaction details.
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!
Efficiency
Show transaction and revenue totals to your merchants without the need to first retrieve all the details.
Complete overview
The merchant gets insights on the use of different brands and the number of refunds on cluster, merchant, contract and site level.
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?
Acquirers
PSPs
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
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!
Control
Control the look and feel of the statement by formatting the received data using your own templates.
One location
Present the statement explaining the merchant and the payment itself in one location.
Own environment
Present the statements in your own app or portal based on your own client data.
Who can use this API?
Acquirers
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!
Complete
Complete your transaction information with interchange fee data and gain insight into rates and fees
Compliant
Become compliant by providing the interchange fee data to your merchants
Own environment
Present interchange fee data in your own app or portal
Who can use this API?
Acquirers
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
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.
Merchant payments
Technical Description
This API allows you to provide detailed payment data to your customers. The API retrieves comprehensive payment data using specific criteria and periods of time.
Version note:
Please be aware that these API interfaces may be changed and improved (e.g. addition of fields).
The "Try out" feature does not work at this time because the sandbox is being improved to support new functionality.
Merchant payments
Merchant payments
This API allows you to provide detailed payment data to your customers. The API retrieves comprehensive payment data using specific criteria and periods of time.
Benefits for you!
Complete
Provide your merchants with the details of every merchant payment.
One location
Present the merchant payment data on one location.
Own environment
Present payment data in your own app or portal based on your own client data.
Who can use the API?
Acquirers
PSPs
Merchants
Why use it?
Currently the merchant can only retrieve this payment data via a separate merchant portal. This API enables you to use certain criteria (e.g. paymentId, paymentReference, merchantHierarchyId, merchantId, contractId and iban) to call payments data.
USE CASE
Provide specific payment data on demand to your customer
A merchant would like to know what amount is funded on a particular date. The Payments API allows the merchant to search for a particular payment to its bank account using different criteria such as paymentId, data, amount, iban etc.
PaymentAmount is reconciliated at an aggregated level as TransactionTotalAmount minus the different fees categories. Using the TransactionLink in a particular payment the merchant can quickly move to the associated transactions.
Are you looking for more information?
Transactions
Technical Description
# version 2.1.2 (14-05-2025)
Changes in this update:
- Allow decimals in amount search fields. Currently applicable only for EUR currency, allowing up to 2 decimal places.
-This change is backward compatible since whole numbers are still permitted.
- New optional fields in transaction and authorization response:
paymentAccountReference, tokenAssuranceMethod and tokenRequestorId
#version 2.0.4 (10-04-2025)
- In this update, we've made several documentation corrections. There is no functional impact.
- Small text corrections in some endpoint/resource descriptions
#version 2.0.3 (04-04-2025)
- In this update, we've made several documentation corrections to enhance clarity. There is no functional impact.
- DateTime values in example responses corrected: 2024-03-21T15:52:01+01:00 (not zulu/utc).
- Corrected example data of paymentDate in response. Should be (yyyy-mm-ddT00:00:00+hh:00) and not (yyyy-mm-dd). (Although ideally, the time component should be omitted, it remains unchanged to align with current production version)
- Expanded the explanation of the standard HTTP paging mechanism. Included a link to relevant HTTP specifications and provided examples of the Link header for easier understanding and implementation.
- Add more explanation to the search-by-criteria endpoint resource. Clarified that at least one of the following query parameters is required: acquirerRefNo, merchantReference, actionId, pspReference.
#version 2.0.2 (30-08-2023)
-Add new v2.1 Id list call, returns a list of transactions instead of 0/1 transaction
/v2.1/acquirers/{acquirerId}/transactions/{transactionId}
Note: In CNP the actionType CAPTURE_SPLIT can result in multiple cleared transactions with the same transactionId. In this unique case, please differentiate between transactions using the cleared transaction acquirerReferenceNumber and Capture request fields captureSequenceNumber, actionId.
-The status of the following v2.0 Id call has changed to deprecated, please use v2.1 call.
/v2.0/acquirers/{acquirerId}/transactions/{transactionId}
Note: The above deprecated v2.0 call will remain available temporarily (up to 31-10-2024) allowing clients 6 months to migrate from current v2.0 Id call to v2.1.
-Changes to search call (/v2.0/acquirers/{acquirerId}/transactions)
- Add query parameter actionId and pspReference
- Rename query parameter merchantTransactionRefNo to merchantReference (old one still available but deprecated)
-Add 5 new fields in a transaction response: captureSequenceNumber, captureSequenceCount, schemeMerchantId, schemeTransactionId, paymentInitiationChannel
-Changes in TransactionIdentification (part of Transaction, Authorization and Lifecycle):
- Rename field merchantTransactionReference to merchantReference (old field is deprecated, but still available up to 31-10-2024)
- Add field actionId, pspReference, retrievalReferenceNumber
-Changes in ContractIdentification (part of Transaction, Authorization and Lifecycle)
- Add field pspId
#version 2.0.1 (17-10-2022)
- Add 7 new fields to a transaction: result3ds, version3ds, cavv, xid, ucaf, mitCause, initiatorType
Version note:
Please be aware that these API interfaces may be changed and improved (e.g. addition of fields).
The "Try out" feature does not work at this time because the sandbox is being improved to support new functionality.