Transactions
This API enables you to retrieves comprehensive transaction data based on merchant payments, contract entity and on specific periods of time.
- Show transaction data in your application of preference
- Retrieve the transactions associated with merchant payment (paymentId) for reconciliation purposes
- Retrieve transaction fees generated by the Worldline FS Merchant Pricing Engine such as: Merchant Service Charge (Interchange++, Interchange+, Fixed fees), Interchange fees, Service fees, etc.
- Acquirers can allow third parties access to retrieve own transaction data
The illustration below shows examples of a happy flow (resulting in a paid transaction) from the POST Transaction in Accept Transactions API through the various transactionStates in the GET Transactions API.
Flow actions and transactionStates in APIs
GET Transactions calls
Request parameters in bold on the Transactions API reference page are mandatory to complete a call.
To ensure best search call response time please use as many parameters as available.
There are 3 GET Transactions API call field result sets:
1. Transaction calls - transactionResults (CNP update ongoing)
Retrieve the latest transactionState in the transactionResults for CNP & POS transactions.
The Back Office transactionStates are:
- Captured - host accept CAPTURE request
- Processed - sent to SCHEME for clearing
- Paid - merchant settlement payment instructions created
2. Authorization calls - actionResults (CNP API roadmap)
Retrieve latest acceptance actionResults using the following calls:
- GET transactionId (lifecycle)
- GET actionId
- GET authorizations using the merchant contract entity (e.g. merchant, site, terminal)
Both approved and declined Accept Transaction actionResults can be viewed using available identifiers.
All the following Accept Transaction API actionTypes are available in the actionResults.
- AUTH
- PREAUTH
- AUTH_INCREMENTAL
- AUTH_REVERSAL
- AUTH_REVERSAL_PARTIAL
- AUTH_AND_CAPTURE
- CAPTURE
- CAPTURE_SPLIT (multiple partial captures)
3. Transaction Lifecycle calls (API roadmap)
Retrieve the associated first/second presentment(s) data and the associated transaction data of the different stages in the dispute life cycle (presentment, re-presentment, chargeback, pre-arbitration, settlement, manual adjustment etc.)