WPI version 2.0

Revision #7

Table of contents

1. Overview

2. Interface Structure

3. Payment Solution Implementation

4. Data Dictionary

Overview

The Worldline Payment Interface (WPI) is an Android intent-based interface that enables easy and fast integration with payment apps. It is designed to allow additional business applications to execute payments on any Worldline offered SmartPOS device. A SmartPOS device is a payment device that runs Android.

All Worldline Payment Solutions support WPI, which means that business applications that use this interface can run everywhere without any change of code. This makes it easy for developers to build payment apps that are compatible with a wide range of payment devices and payment protocols.

The WPI interface is built on top of the Android Intent mechanism, which allows different parts of an app to communicate with each other in a structured way. By using intents to trigger payment-related actions, the WPI interface simplifies the payment integration process and makes it easier for developers to build business applications on top of Payment Solutions.

What's new

• Interface structure extension

  • Gather information from Payment Solution

  • Session support

    • WPI_ERR_COND_SESSION_ID_ALREADY_IN_USE

    • Print Receipt Session ID

    • Last Transaction Requests uses Session ID

  • WPI_VERSION changed from Integer to String

  • Clarified the use of messenger service for background actions

• Management functional extensions:

  • Payment Parameterization

  • Acquirer Parameterization

  • Print Receipt

  • Abort Ongoing Payment

• Financial extensions

  • Request fields added

    • productRecords

    • receiptFormat

    • recognitionTimeout

    • recognitionOptions

    • receiptTarget

  • Response fields added

    • dccUsed

    • softwareVersion

    • terminalIdentifier

    • supportedLanguages

    • cardholderDefaultLanguage

    • merchantLanguage

    • countryCode

    • defaultCurrency

    • supportedCurrencies

    • shopInfo

    • acquirerProtocol

    • supportedTicketFormats

    • paymentInformation

    • paymentSolutionSupportedServiceTypes

    • entryMode

    • isoTrack1

    • isoTrack2

    • isoTrack3

    • token

    • pan

    • mediaType

    • mediaUniqueIdentifier

    • waitForNextAction

    • nextActionWaitTime

    • tipAmount

Revision History

• Revision#7

  • 3. Payment Solution Implementation

    • Clarification added for QR Code printed on the receipt

  • 4.1.2.5 Receipt

    • JSON format example updated

• Revision#6

  • Reservation / Reservation Adjustment / Purchase Reservation

    • Chapters renamed to "Pre-authorization, "Update Pre-authorization" and "Payment Completion" respectively

    • Clarification on paymentSolutionReference usage provided

  • Payment Instrumentation Recognition

    • isoTrack1 and isoTrack2 data types changed to String in Response

Interface Structure

The WPI provides a set of intents that developers can use to build apps that work with the interface. The following table lists each intent, along with its purpose:

We have two type of categories for the Interface:

• Display Actions : These actions start the payment solution that are processing financial transactions or require user interaction.

  • Android intents are used

• Background Actions : These actions perform background processing that doesn't require user interaction.

  • Messenger service is used

  • The Message.what attribute of the Messenger Service should be set to the code 895349 for any WPI message.

  • The Message.obj should be  a bundle formatted just like the WPI Extras.

  • Those extras are being transported through a different mean but the same structure and rules applies . 

Extras

An extra in Android intents is a way to pass additional data or parameters to another component in order to provide more context or information for the requested action. In WPI we have extras for request and response. The request extras needs to be provided by the Business Application that is using the interface and the response extra is provided by the Payment Solution.

Request

Response

Service Types

Each intent has several service types that specify the request.

FINANCIAL

MANAGEMENT

INFORMATION

Payment Solution Implementation

• Mandatory Attributes and Result Structure

  • The technical design is based on defining only the mandatory attributes in the request needed to meet every requested business use case aiming to be payment protocol agnostic.

  • The payment solution shall support every combination of attributes defined in the request.

  • The result structure contains every possible attribute to be returned to meet every use case.

• Payment Solution Reference

  • The payment solution reference must be designed in a unique way so that all follow on transactions can be handled with this. For example if you do a reservation, it needs to contain all payment-specific fields to do all follow-on transactions like cancel reservation, purchase reservation, and so on. WPI supports the so-called reference, for more details check Data Dictionary 4.1.1 Request Data, this field is also known as a merchant reference and used for reconciliation.

  • The payment solution will print the paymentSolutionReference on the receipt as QR Code:

    • compliant with ISO/IEC 18004:2015 (or higher) standard.

    • highest (H) error correction level must be ensured.

    • QR Code version should be selected according to the length of data that given Payment Solution will return.

    • QR Code content should be limited to paymentSolutionReference value with no additional data (i.e. raw data).

  • The payment solution reference shall be as short as possible and easy to type manually within another Android application.

• Remark and Error Handling

  • The payment solution shall provide a remark that is understandable by a third-party integrator and only in case of an error condition not equal to WPI_ERR_COND_NONE.

  • The payment solution shall send back the errorCondition WPI_ERR_COND_BUSY in case of a transaction currently in progress.

• Payment Instrumentation Recognition Request

  • In case of a Payment Instrumentation Recognition Request, the terminal shall:

    • perform the card withdrawal in case of no amount & currency is present.

    • not wait for another action in case of no amount & currency is present.

    • return a token for the card PAN or the NFC UID (in case of NFC non-payment related cards) that was read. The token should be a hash which is generated by the Payment Solution and can be reproduced at least on the same device.

• Other Requirements

  • The payment solution must store the SESSION_ID for the last transaction as well as the last transaction object of each business application. Due to this, a recovery procedure can be implemented with the last transaction request.

  • The payment solution should support several WPI major versions.

  • Password-protected transaction types such as refund, credit, and follow-on credit must be password protected. In case of a standalone configuration of the payment solution, password entry and validation must be done by the payment solution.

  • The payment solution shall always take care off the receipt handling - depending on the TMS configuration. Business applications can override (deactivate) the default behavior by setting the receiptDelegation to false.

Versioning

The WPI uses versioning with the format Y.X (e.g., 1.0, 2.1) to track and manage different releases of our software. Additionally, each revision within a minor version is assigned a unique number, such as "3.2 Revision #9."

• Y (Major Version): Signifies a significant milestone with potential breaking changes. A payment solution for version 1.1 must remain compatible with the version 1.0.

• X (Minor Version): Represents a release with new features or improvements that are backward compatible within the same major version. However, a version 2.2 request cannot be used with version 1.1.

• Revision Number: Each revision is assigned a unique number, indicating the specific iteration of a minor version (e.g., "3.2 Revision #9"). Revisions mainly include small fixes, updates, and improvements. They address minor bugs or add slight enhancements/clarifications.

Data Dictionary

Data

All the data here below are the possible fields including the description and type for all services. As this is just a dictionary, the detailed responses per service check are listed in subsequent chapters.

Request Data

All data has to be provided as JSON and needs to be provided as WPI_REQUEST extra.

Product Record Item

Product Records are items that will be exchanged between the integrator and the issuer. Those two parties also needs to agree on the content. The Payment Solution is just the sending the information. Example: Item ID = 55 means Carwash program "full". Each record has the following fields.

Receipt Format

The receipt format defines how to retrieve the receipt. Default is formatted. If an empty array is sent no receipt will be returned. The following values are possible.

Recognition Option

Receipt Target

Response Data

All data has to be provided as JSON and will be provided as WPI_RESPONSE extra.

ShopInfo

RESULT

ERROR CONDITIONS

ACTION CODES

RECEIPTS

The receipt language is the same as it is for the payment app. As it is written in the JSON specification ( https://www.ietf.org/rfc/rfc4627.txt ) every control character has to be escaped like shown below but on the same line.

FORMATTED format:

formatted: {
    "merchant":"    This is to confirm your transaction\\n
        registered at:\\n
        ----------------------------------------\\n
                 SPS-Softpos Pilot 02\\n
                  Grzybowska 4/246\\n
                   00-131 Warszawa\\n
        ----------------------------------------\\n
        15.02.2023 22:36\\n
        0,03 PLN\\n
        Visa **** **** **** 7984\\n
                Transaction details: \\n
        Status:                       AUTHORIZED\\n
        Authorization code:           (0) 741451\\n
        ARQC:                   61BC5EDC34F63979\\n
        AID:                      A0000000031010\\n
        Contactless\\n
        Type:                               Sale\\n
        POS ID:                         APP00002\\n
        MID:                           103810047\\n
        VISA CARD",
    "client":"    This is to confirm your transaction\\n
        registered at:\\n
        ----------------------------------------\\n
                 SPS-Softpos Pilot 02\\n
                  Grzybowska 4/246\\n
                   00-131 Warszawa\\n
        ----------------------------------------\\n
        15.02.2023 22:36\\n
        0,03 PLN\\n
        Visa **** **** **** 7984\\n
                Transaction details: \\n
        Status:                       AUTHORIZED\\n
        Authorization code:           (0) 741451\\n
        ARQC:                   61BC5EDC34F63979\\n
        AID:                      A0000000031010\\n
        Contactless\\n
        Type:                               Sale\\n
        POS ID:                         APP00002\\n
        MID:                           103810047\\n
        VISA CARD"
    }
}

JSON Format:

"json":{
    "receiptTargets":{
        "merchant":{
            "description": "List of field names of the receipt to be included for the merchant receipt"
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "client":{
            "description": "List of field names of the receipt to be included for the client receipt"
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "duplicate":{
        "type":"boolean"
    },
    "shopInfo":{
        "name":{
            "type":"string"
        },
        "address":{
            "type":"string"
        },
        "zipCode":{
            "type":"string"
        },
        "city":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "logo":{
            "type":"string" // Content provider uri to the logo file
        }
    },
    "terminalIdentifier":{
        "type":"string"
    },
    "period":{
        "type":"string"
    },
    "transactionIdentifier":{
        "type":"string"
    },
    "currency":{
        "type":"string"
    },
    "amount":{
        "type":"integer"
    },
    "cashbackAmount":{
        "type":"integer"
    }
    "tipAmount":{
        "type":"integer"
    },
    "token":{
        "type":"string"
    },
    "par":{
        "type":"string"
    },
    "brandName":{
        "type":"string"
    },
    "applicationIdentifier":{
        "type":"string"
    },
    "issuerName":{
        "type":"string"
    },
    "pan":{
        "type":"string"
    },
    "maskedPan":{
        "type":"string"
    },
    "cardSequence":{
        "type":"string"
    },
    "cardExpiration":{
        "type":"string"
    },
    "serviceName":{
        "type":"string"
    },
    "timestamp":{
        "type":"string"
    },
    "authorizationCode":{
        "type":"string"
    },
    "reference":{
        "type":"string"
    },
    "acquirerIdentifier":{
        "type":"string"
    },
    "entryMode":{
        "type":"string"
    },
    "cardDataInput":{
        "type":"string"
    },
    "cardholderVerificationMethod":{
        "type":"string"
    },
  "legalIdentificationRequired":{
        "type":"boolean"
    },
    "cardBalance":{
        "old":{
            "type":"string"
        },
        "new":{
            "type":"string"
        },
        "cardholderText":{
            "type":"string"
        }
    },
    "paymentSolutionReference":{
        "type":"string"
    },
    "productRecords":{
        "type":"array",
        "items":{
            "itemId":{
                "type":"integer"
            },
            "label":{
                "type":"string"
            },
            "unitAmount":{
                "type":"integer"
            },
            "quantity":{
                "type":"integer"
            },
            "totalAmount":{
                "type":"integer"
            },
            "currency":{
                "type":"string"
            }
        }
    },
    "operatorIdentifier":{
        "type":"string"
    },
    "cardholderReceiptText":{
        "type":"string"
    },
    "acquirerReceiptText":{
        "type":"string"
    },
    "footerLines":{
        "type":"array",
        "items":{
            "line":{
                "type":"string"
            }
        }
    },
    "additionalData":{
        "type":"array",
        "items":{
            "key":{
                "type":"string"
            },
            "value":{
                "type":"dynamic"
            }
        }
    }
}

PAYMENT INFORMATION ITEM

SUPPORTED TECHNOLOGIES

SUPPORTED TICKET FORMAT

The supported ticket formats are defined in  Receipt Format

ACQUIRER PROTOCOL

Financial

Each financial transaction has a minimum set of fields that needs to be there per service type. In the subsequent chapters this is described in detail.

The response contains the following fields:

Response :

Payment

Service Type : WPI_SVC_PAYMENT

Request :

Cancellation

The cancellation is also known as reversal. The cancellation can be executed for several service types, the cancellation service type depends on the initial service type and needs to be set and used correctly by the business application.

Service Type : WPI_SVC_CANCEL_PAYMENT, WPI_SVC_CANCEL_PRE_AUTHORIZATION, WPI_SVC_CANCEL_UPDATE_PRE_AUTHORIZATION, WPI_SVC_CANCEL_PAYMENT_COMPLETION

Request :

Refund

Service Type : WPI_SVC_REFUND

Request :

Pre-authorization

Service Type : WPI_SVC_PRE_AUTHORIZATION

Request :

Update Pre-authorization

This service is used to increase the pre-authorization amount, which involves specifying the requested amount for the increment. The reference of pre-authorization is provided through the paymentSolutionReference , which will be use to make the update pre-authorization. The requestedAmount is just the amount that shall be incremented, not the total one . 

Service Type : WPI_SVC_UPDATE_PRE_AUTHORIZATION

Request :

Payment Completion

To complete a previous pre-authorization the paymentSolutionReference has to be used. The final amount should be equal to or less than the total pre-authorization amount (this includes all previous Update pre-authorization calls). If you use a higher amount for the completion, the transaction may not be successful because the higher amount was not reserved - we do not recommend to use higher amounts.

Service Type : WPI_SVC_PAYMENT_COMPLETION

Request :

Deferred Payment

Deferred payment for petrol transaction processing refers to a payment arrangement where the actual payment for fuel is delayed or postponed until a later time. The transaction is split into two parts: authorization and completion.

1. Authorization: The first part of the deferred payment process is authorization. When a customer swipes their payment card or provides their payment details at the petrol station, the system checks if the card is valid and has sufficient funds or credit available. This initial authorization ensures that the customer's payment method is valid and can cover the cost of the fuel. However, the actual payment is not processed at this stage.

2. Completion: The second part of the deferred payment process is completion. After the authorization is successful, the petrol station temporarily reserves the funds or credit limit on the customer's card to cover the estimated cost of the fuel. This reserved amount is typically a pre-authorization hold or pending transaction. The petrol station then dispenses the fuel to the customer.

Later, the petrol station completes the transaction by submitting the final payment request to the customer's bank or credit card company. At this stage, the reserved funds are transferred from the customer's account to the petrol station's account, completing the payment process. The exact timing for completing the authorization may vary depending on the specific payment system and agreements between the petrol station and the customer's financial institution.

The delay between the “Authorization Exchange” and the “Completion Exchange” can be quite long (e.g., in case of tank filling). Therefore, to increase the availability of the terminals using the “Deferred Payment” service, the “Multi-Session” concept is usually configured for performing “Parallel Transactions”. The authorization exchange provides the terminal with an authorized amount as upper limit, and the completion exchange notifies the acquirer of the final amount as actually applicable. The “Deferred Payment” is indifferently meant for attended or unattended terminals. 

PSD2 imposes the amount to be present in the request.

AUTHORIZATION

Service Type : WPI_SVC_DEFERRED_PAYMENT_AUTHORIZATION

Request :

Service Type : WPI_SVC_DEFERRED_PAYMENT_COMPLETION

Request :

Payment Instrumentation Recognition

The intention is to avoid double tap under the condition the payment instrument is a contactless entry mode. The payment solution needs information about the transaction service type, requested amount, currency and reference that should be used for the subsequent transaction. There are two possibilities to do a payment instrumentation recognition token retrieval only and card recognition with further payment processing afterwards. The response differs from the standard response as described below. 

Service Type : WPI_SVC_PAYMENT_INSTRUMENT_RECOGNITION

Request :

Response :

Follow on Credit

Follow on Credit is a card not present transaction which is used to perform the credit transaction with the card data of a previous transaction. The reference of the card is given by the paymentSolutionReference of the previous transaction.

Service Type : WPI_SVC_FOLLOW_ON_CREDIT

Request :

Management

Management actions has an empty request JSON content, except for services that contain a receipt, like Day-End and the parameterizations. The receipt format can be set in the request with the receiptFormat field (defined in Receipt Format ). If a receipt format is also defined for a management services that does not have a receipt the receiptFormat will be ignored by the payment solution.

The response for every management action contains the following fields

Response :

Payment Menu

This is used to open the payment solution menu to trigger payment solution specific actions.

Service Type : WPI_SVC_PAYMENT_MENU

Day-End

The day-end is used to upload the offline transactions to the host and sends back a receipt with the transaction summary per brand with no of transactions as well as the full amount since the last day-end.

Service Type : WPI_SVC_DAY_END

Payment Parameterization

The payment configuration is used to synchronize the payment solution specific parameters with the corresponding management system.

Service Type : WPI_SVC_PAYMENT_PARAMETERIZATION

Acquirer Parameterization

The Acquirer parameterization is used to synchronize with the acquirer system corresponding to the payment solution. This includes brands, limits and any other parameter that is mandatory to process a financial transaction. Multi-Acquirer solutions will do the parameterization synchronization for all acquirers.

Service Type : WPI_SVC_ACQUIRER_PARAMETERIZATION

Print Receipt

This function is intended to provide a compliant receipt by the payment solution. A receipt can be provided in case of

• A previous transaction was done and due to this the payment solution has a last transaction with a corresponding session ID for this business application

• The SESSION_ID of the print receipt request in the Android Extras has to be the previous request SESSION_ID and not a new one

• The payment solution supports receipt delivery, for example printing or digital receipt based delivery

• Referenced request (by SESSION_ID) has a receipt available

The Android Extras in the response are close to a standard transaction response except for the conditional presence of WPI_RESPONSE. An initial check on this extra property provides information about the existence of the session. If not available the session ID is not existing.

Be aware any payment solution will just store the last SESSION_ID and response per application (package name). This implies that no other WPI requests shall be done before printing the receipt.

Hint: The receipt cannot be provided under the following circumstances:

Service Type : WPI_SVC_PRINT_RECEIPT

Request :

Response : 

Abort Ongoing Payment

Abort the current ongoing financial transaction. If the transaction was successfully aborted or there was no running transaction WPI_RESULT_SUCCESS will be returned in all other cases WPI_RESULT_FAILURE.

Service Type : WPI_SVC_ABORT

Information

Retrieval of Payment Solution specific information that does not require user interaction. There request does not contain any parameter. The response is specific per service type.

Last Transaction

In case of the last transaction response is not known any more it can be requested by this service. It will return the last financial transaction response independent of the result, failed or success. This is a recovery feature as the payment solution will remember the last SESSION_ID as well as corresponding transaction response. The Android Extras are close to a standard transaction response except for the conditional presence of WPI_SERVICE_TYPE & WPI_RESPONSE . An initial check on one of these extra properties can provide information about the existence of the session.

Be aware any payment solution will just store the last response. That implies that no other WPI request shall be done before the recovery. 

Service Type : WPI_SVC_LAST_TRANSACTION

Request :

Response :

Payment Solution Information 

The payment should provide all the required information, in case of a lack or issue of configuration / initialization the response should provide the WPI_ERR_COND_NOT_INITIALIZED as an errorCondition.

Service Type : WPI_SVC_PAYMENT_INFORMATION

Response :