### UnavailableDevice Response Example Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Represents a failure response when the requested device is not available. ```json { "SaleToPOIServiceResponse": { "Header": { "MessageFunction": "SaleFinancialServiceResponse", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "CreationDateTime": "2020-05-04T18:13:51.0+01:00", "InitiatingParty": { "Identification": "WL000D5T0000004", "Type": "Merchant" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "Status": { "VersionNumber": "1.4.2" } } ] } }, "ServiceResponse": { "Environment": { "Merchant": { "Identification": { "Identification": "WL000D5T0000004" } }, "POI": { "Identification": { "Identification": 26197214 } } }, "Context": { "SaleContext": { "SaleIdentification": "SaleTermA" } }, "ServiceContent": "FinancialPaymentResponse", "Response": { "Response": "Failure", "ResponseReason": "UnavailableDevice", "AdditionalResponseInformation": "The requested device is not available." } } } } ``` -------------------------------- ### UnreachableHost Response Example Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Represents a failure response when the acquirer or host cannot be reached. ```json { "SaleToPOIServiceResponse": { "Header": { "MessageFunction": "SaleFinancialServiceResponse", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "CreationDateTime": "2020-05-04T18:13:51.0+01:00", "InitiatingParty": { "Identification": "WL000D5T0000004", "Type": "Merchant" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "Status": { "VersionNumber": "1.4.2" } } ] } }, "ServiceResponse": { "Environment": { "Merchant": { "Identification": { "Identification": "WL000D5T0000004" } }, "POI": { "Identification": { "Identification": 26197214 } } }, "Context": { "SaleContext": { "SaleIdentification": "SaleTermA" } }, "ServiceContent": "FinancialPaymentResponse", "Response": { "Response": "Failure", "ResponseReason": "UnreachableHost", "AdditionalResponseInformation": "The acquirer or host could not be reached." } } } } ``` -------------------------------- ### UnavailableService Response Example Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Represents a failure response when the requested service is currently unavailable. ```json { "SaleToPOIServiceResponse": { "Header": { "MessageFunction": "SaleFinancialServiceResponse", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "CreationDateTime": "2020-05-04T18:13:51.0+01:00", "InitiatingParty": { "Identification": "WL000D5T0000004", "Type": "Merchant" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "Status": { "VersionNumber": "1.4.2" } } ] } }, "ServiceResponse": { "Environment": { "Merchant": { "Identification": { "Identification": "WL000D5T0000004" } }, "POI": { "Identification": { "Identification": 26197214 } } }, "Context": { "SaleContext": { "SaleIdentification": "SaleTermA" } }, "ServiceContent": "FinancialPaymentResponse", "Response": { "Response": "Failure", "ResponseReason": "UnavailableService", "AdditionalResponseInformation": "The requested service is not available." } } } } ``` -------------------------------- ### Not Found Response Example Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Represents a transaction failure when the requested resource or transaction cannot be located. ```json { "SaleToPOIServiceResponse": { "Header": { "MessageFunction": "SaleFinancialServiceResponse", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "CreationDateTime": "2020-05-04T18:13:51.0+01:00", "InitiatingParty": { "Identification": "WL000D5T0000004", "Type": "Merchant" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "Status": { "VersionNumber": "1.4.2" } } ] } }, "ServiceResponse": { "Environment": { "Merchant": { "Identification": { "Identification": "WL000D5T0000004" } }, "POI": { "Identification": { "Identification": 26197214 } } }, "Context": { "SaleContext": { "SaleIdentification": "SaleTermA" } }, "ServiceContent": "FinancialPaymentResponse", "Response": { "Response": "Failure", "ResponseReason": "NotFound", "AdditionalResponseInformation": "The requested resource or transaction was not found." } } } } ``` -------------------------------- ### Complete Payment Request Source: https://docs.terminal.worldline-solutions.com/build-your-integration/sending-your-first-request A full cURL example demonstrating the required headers and the SaleToPOIServiceRequest JSON body structure. ```bash curl --location 'https://api.terminal.iacc.global.worldline-solutions.com/api/v1/merchants/YOUR_MERCHANT_ID/terminals/YOUR_TERMINAL_ID/payments/sync' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_TOKEN' \ --data '{ "SaleToPOIServiceRequest": { "Header": { "MessageFunction": "SaleFinancialServiceRequest", "ProtocolVersion": "5.1-WL1.0.0", "ExchangeIdentification": "642", "CreationDateTime": "2024-11-15T10:30:00.0+01:00", "InitiatingParty": { "Identification": "YOUR_MERCHANT_ID", "Type": "Merchant" } }, "ServiceRequest": { "ServiceContent": "FinancialPaymentRequest", "PaymentRequest": { "PaymentTransaction": { "TransactionType": "CardPayment", "TransactionIdentification": { "TransactionDateTime": "2024-11-15T10:30:00.0+01:00", "TransactionReference": "R26197055" }, "TransactionDetails": { "Currency": "EUR", "TotalAmount": 100 } } } } }' ``` -------------------------------- ### PaymentRequestWithTip Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible An example of a financial payment request sent to the POI, including gratuity details. ```APIDOC ## PaymentRequestWithTipRequest ### Description Initiates a financial payment request to the POI terminal, including an optional gratuity amount. ### Request Example { "SaleToPOIServiceRequest": { "Header": { "MessageFunction": "SaleFinancialServiceRequest", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "CreationDateTime": "2020-05-04T18:13:51.0+01:00", "InitiatingParty": { "Identification": "SaleTermA", "Type": "Merchant" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "SubTypeInformation": "Checkout", "Identification": { "ProviderIdentification": "YourSoftware", "Identification": "YourPOS", "SerialNumber": "SN-0001" }, "Status": { "VersionNumber": "1.4.2" } } ] }, "WebhookUrl": "https://example.com/webhook?transactionId=a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "NumberOfRetries": 3 }, "ServiceRequest": { "Environment": { "POI": { "Identification": { "Identification": "POITerm1" } } }, "ServiceContent": "FinancialPaymentRequest", "PaymentRequest": { "PaymentTransaction": { "TransactionType": "CardPayment", "AdditionalService": [ "Gratuity" ], "TransactionIdentification": { "TransactionDateTime": "2020-05-04T18:13:51.0+01:00", "TransactionReference": "R26197055" }, "TransactionDetails": { "Currency": "EUR", "TotalAmount": 104.11, "DetailedAmount": { "Gratuity": 3 } } } } } } } ``` -------------------------------- ### Merchant Connections Response Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Example response structure for merchant connection details. ```json { "data": { "umid": "SCS-280505", "merchantToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bWlkIjoiU0NTLTI4MDUwNSJ9.signature", "connectedTerminals": [ "26197214", "26197215" ] }, "requestId": "550e8400-e29b-41d4-a716-446655440000" } ``` -------------------------------- ### IntegratorId Example Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Example of a valid IntegratorId string used within the SalesSystemInfo block. ```json 9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b ``` -------------------------------- ### Service Response Handling Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Examples of service responses returned by the terminal, indicating failure states such as 'Aborted' or 'Busy'. ```APIDOC ## Service Response (Failure - Aborted) ### Description Indicates that the service request was aborted by the initiator. ### Response Example { "SaleToPOIServiceResponse": { "Header": { "MessageFunction": "SaleFinancialServiceResponse", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "CreationDateTime": "2020-05-04T18:13:51.0+01:00", "InitiatingParty": { "Identification": "WL000D5T0000004", "Type": "Merchant" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "Status": { "VersionNumber": "1.4.2" } } ] } }, "ServiceResponse": { "Response": { "Response": "Failure", "ResponseReason": "Aborted", "AdditionalResponseInformation": "The request was aborted by the initiator." } } } } ## Service Response (Failure - Busy) ### Description Indicates that the system is currently busy and the request should be retried later. ### Response Example { "SaleToPOIServiceResponse": { "ServiceResponse": { "Response": { "Response": "Failure", "ResponseReason": "Busy", "AdditionalResponseInformation": "The system is busy; retry later." } } } } ``` -------------------------------- ### Refusal Response Example Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Represents a transaction failure due to a refusal by the acquirer or issuer. ```json { "SaleToPOIServiceResponse": { "Header": { "MessageFunction": "SaleFinancialServiceResponse", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "CreationDateTime": "2020-05-04T18:13:51.0+01:00", "InitiatingParty": { "Identification": "WL000D5T0000004", "Type": "Merchant" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "Status": { "VersionNumber": "1.4.2" } } ] } }, "ServiceResponse": { "Environment": { "Merchant": { "Identification": { "Identification": "WL000D5T0000004" } }, "POI": { "Identification": { "Identification": 26197214 } } }, "Context": { "SaleContext": { "SaleIdentification": "SaleTermA" } }, "ServiceContent": "FinancialPaymentResponse", "Response": { "Response": "Failure", "ResponseReason": "Refusal", "AdditionalResponseInformation": "The transaction was refused by the acquirer or issuer." } } } } ``` -------------------------------- ### UIInfoRequest Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Demonstrates a basic information screen with title, subtitle, descriptive text, and action buttons. This pattern is ideal for confirmation dialogs, promotional messages, or any scenario where you need to present information to users and capture their decision. ```APIDOC ## UIInfoRequest ### Description Demonstrates a basic information screen with title, subtitle, descriptive text, and action buttons. This pattern is ideal for confirmation dialogs, promotional messages, or any scenario where you need to present information to users and capture their decision. Features customizable primary and secondary buttons with unique IDs for handling different user responses. ### Request Example { "SaleToPOIDeviceRequest": { "Header": { "MessageFunction": "DeviceRequest", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "CreationDateTime": "2020-05-04T18:13:51.0+01:00", "InitiatingParty": { "Identification": "SaleTermA", "Type": "Merchant" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "SubTypeInformation": "Checkout", "Identification": { "ProviderIdentification": "YourSoftware", "Identification": "YourPOS", "SerialNumber": "SN-0001" }, "Status": { "VersionNumber": "1.4.2" } } ] } }, "DeviceRequest": { "InputRequest": { "DisplayOutput": { "MessageContent": { "InfoScreen": { "Title": "Do you want to redeem your loyalty card?", "Subtitle": "You currently have enough point for a 2.50 EUR discount", "Text": "This will apply the discount to your current transaction", "PrimaryButton": { "ButtonId": "first_button", "ButtonContent": "Yes" }, "SecondaryButton": { "ButtonId": "second_button", "ButtonContent": "No" } } } }, "InputData": { "MaximumInputTime": 30000 } } } } } ``` -------------------------------- ### Pre-Authorisation Request Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Initiates a financial reservation request for a transaction. ```json { "SaleToPOIServiceRequest": { "Header": { "MessageFunction": "SaleFinancialServiceRequest", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "CreationDateTime": "2020-05-04T18:13:51.0+01:00", "InitiatingParty": { "Identification": "SaleTermA", "Type": "Merchant" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "SubTypeInformation": "Checkout", "Identification": { "ProviderIdentification": "YourSoftware", "Identification": "YourPOS", "SerialNumber": "SN-0001" }, "Status": { "VersionNumber": "1.4.2" } } ] }, "WebhookUrl": "https://example.com/webhook?transactionId=a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "NumberOfRetries": 3 }, "ServiceRequest": { "Environment": { "POI": { "Identification": { "Identification": "POITerm1" } } }, "ServiceContent": "FinancialPaymentRequest", "PaymentRequest": { "PaymentTransaction": { "TransactionType": "Reservation", "ServiceAttribute": "InitialReservation", "TransactionIdentification": { "TransactionDateTime": "2020-05-04T18:13:51.0+01:00", "TransactionReference": "R26197055" }, "TransactionDetails": { "Currency": "EUR", "TotalAmount": 15 } } } } } } ``` -------------------------------- ### Administrative Configuration Request Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Use this request to initiate a terminal configuration update. ```json { "SaleToPOIAdministrativeRequest": { "Header": { "MessageFunction": "AdminRequest", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "CreationDateTime": "2020-05-04T18:13:51.0+01:00", "InitiatingParty": { "Identification": "SaleTermA", "Type": "Merchant" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "SubTypeInformation": "Checkout", "Identification": { "ProviderIdentification": "YourSoftware", "Identification": "YourPOS", "SerialNumber": "SN-0001" }, "Status": { "VersionNumber": "1.4.2" } } ] }, "WebhookUrl": "https://example.com/webhook?transactionId=a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "NumberOfRetries": 3 }, "AdministrativeRequest": { "Environment": {}, "AdministrativeServiceIdentification": "TerminalConfiguration" } } } ``` -------------------------------- ### MultiOptionsSingleSelectionScreen Extension Source: https://docs.terminal.worldline-solutions.com/api-reference The MultiOptionsSingleSelectionScreen extension allows presenting a list of selectable options to the user. The identifier of the selected option is returned in the response. ```APIDOC ## MultiOptionsSingleSelectionScreen Extension ### Description Displays a list of options for the user to select from, returning the selected OptionId. ### Request Body - **BackgroundColor** (string) - Optional - Hex color code for background - **ButtonColor** (string) - Optional - Hex color code for buttons - **Title** (string) - Required - Title or question to display - **OptionElements** (array) - Required - List of selectable options containing OptionId, OptionTitle, OptionContent, and optional icon specifications. ``` -------------------------------- ### Payment Restriction Response Example Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Represents a transaction failure caused by a specific payment restriction. ```json { "SaleToPOIServiceResponse": { "Header": { "MessageFunction": "SaleFinancialServiceResponse", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "CreationDateTime": "2020-05-04T18:13:51.0+01:00", "InitiatingParty": { "Identification": "WL000D5T0000004", "Type": "Merchant" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "Status": { "VersionNumber": "1.4.2" } } ] } }, "ServiceResponse": { "Environment": { "Merchant": { "Identification": { "Identification": "WL000D5T0000004" } }, "POI": { "Identification": { "Identification": 26197214 } } }, "Context": { "SaleContext": { "SaleIdentification": "SaleTermA" } }, "ServiceContent": "FinancialPaymentResponse", "Response": { "Response": "Failure", "ResponseReason": "PaymentRestriction", "AdditionalResponseInformation": "The payment cannot be performed because of a restriction." } } } } ``` -------------------------------- ### Administrative Request Source: https://docs.terminal.worldline-solutions.com/api-reference Initiates an administrative operation on the terminal, such as Acquirer Initialization. ```APIDOC ## POST /administrative-request ### Description Sends an administrative request to the terminal. This is an asynchronous operation where the final result is delivered to the provided WebhookUrl. ### Request Body - **SaleToPOIAdministrativeRequest** (object) - Required - The administrative request payload containing header information, sales system details, and the specific administrative service identification. ### Request Example { "SaleToPOIAdministrativeRequest": { "Header": { "MessageFunction": "AdminRequest", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "CreationDateTime": "2020-05-04T18:13:51.0+01:00", "InitiatingParty": { "Identification": "SaleTermA", "Type": "Merchant" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "SubTypeInformation": "Checkout", "Identification": { "ProviderIdentification": "YourSoftware", "Identification": "YourPOS", "SerialNumber": "SN-0001" }, "Status": { "VersionNumber": "1.4.2" } } ] }, "WebhookUrl": "https://example.com/webhook?transactionId=a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "NumberOfRetries": 3 }, "AdministrativeRequest": { "Environment": {}, "AdministrativeServiceIdentification": "AcquirerInitialization" } } } ### Response #### Success Response (202) - **requestId** (string) - The unique identifier for the asynchronous request. #### Response Example { "requestId": "550e8400-e29b-41d4-a716-446655440000" } ``` -------------------------------- ### Callback Payload Receipt Structure Source: https://docs.terminal.worldline-solutions.com/api-reference Example of a JSON payload containing customer and cashier receipt data. ```json { "PaymentReceipt": [ { "DocumentQualifier": "CustomerReceipt", "OutputContent": { "MessageDestination": "CustomerReceipt", "Format": "SimpleText", "MessageContent": "--------------------------------\n SaleTermA EUR\n Haechtsesteenweg 1441\n 1130 Brussel\n--------------------------------\n\n ***Cardholder Receipt***\n\nPurchase\nMaestro contactless\nXXXXXXXXXXXXX5006\nAccount Type: Credit\n\n12.12.2025 16:44:40\nTrm-Id: 26197088\nAID: A0000000043060\nTrx. Seq-Cnt: 16249\nTrx. Ref-No: 92986866332\nAuth. Code: 168953\nAcq-Id: 999100022\n\nPayment Solution Reference:\n2;00999100022;92986866332;16249;\n010099910002292986866332;\nTotal-EFT EUR: 0.20\n\n--------------------------------\n" } }, { "DocumentQualifier": "CashierReceipt", "OutputContent": { "MessageDestination": "MerchantReceipt", "Format": "SimpleText", "MessageContent": "--------------------------------\n SaleTermA EUR\n Haechtsesteenweg 1441\n 1130 Brussel\n--------------------------------\n\nPurchase\nMaestro contactless\nXXXXXXXXXXXXX5006\nAccount Type: Credit\n\n12.12.2025 16:44:40\nTrm-Id: 26197088\nAct-Id: 151\nAID: A0000000043060\nTrx. Seq-Cnt: 16249\nTrx. Ref-No: 92986866332\nAuth. Code: 168953\nAcq-Id: 999100022\n4DFB78D8CB08370CEDA0D526006DD29A\n 02/10\n\n\nTotal-EFT EUR: 0.20\n\n--------------------------------\n" } } ] } ``` -------------------------------- ### CardAcquisitionRequest Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Reads card data from the terminal without starting a payment, allowing for subsequent payment completion. ```APIDOC ## CardAcquisitionRequest ### Description Reads the card data from the terminal without starting a payment. The customer taps or inserts their card once. After receiving the response, send a PaymentRequest with the same amount and currency to complete the payment without requiring the customer to present their card again. ### Request Example { "SaleToPOIServiceRequest": { "Header": { "MessageFunction": "SaleFinancialServiceRequest", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "8b9c0d1e-2f3a-4b4c-5d6e-7f8a9b0c1d2e", "CreationDateTime": "2026-03-31T10:00:00.0+01:00", "InitiatingParty": { "Identification": "SaleTermA", "Type": "Merchant" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "SubTypeInformation": "Checkout", "Identification": { "ProviderIdentification": "YourSoftware", "Identification": "YourPOS", "SerialNumber": "SN-0001" }, "Status": { "VersionNumber": "1.4.2" } } ] } }, "ServiceRequest": { "Environment": { "POI": { "Identification": { "Identification": "POITerm1" } } }, "ServiceContent": "FinancialCardAcquisitionRequest", "CardAcquisitionRequest": { "CardAcquisitionTransaction": { "TransactionIdentification": { "TransactionDateTime": "2026-03-31T10:00:00.0+01:00", "TransactionReference": "CA-001" }, "TransactionDetails": { "Currency": "EUR", "TotalAmount": 25 } } } } } } ``` -------------------------------- ### Administrative Initialization Request JSON Structure Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Used to trigger an administrative initialization service on the terminal. Requires header information and the specific administrative service identification. ```json { "SaleToPOIAdministrativeRequest": { "Header": { "MessageFunction": "AdminRequest", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "CreationDateTime": "2020-05-04T18:13:51.0+01:00", "InitiatingParty": { "Identification": "SaleTermA", "Type": "Merchant" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "SubTypeInformation": "Checkout", "Identification": { "ProviderIdentification": "YourSoftware", "Identification": "YourPOS", "SerialNumber": "SN-0001" }, "Status": { "VersionNumber": "1.4.2" } } ] }, "WebhookUrl": "https://example.com/webhook?transactionId=a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "NumberOfRetries": 3 }, "AdministrativeRequest": { "Environment": {}, "AdministrativeServiceIdentification": "AcquirerInitialization" } } } ``` -------------------------------- ### Implement UISingleSelectionRequest Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Use this structure to display a menu or category selection screen on the terminal. Each option requires a unique ID for processing the user's selection. ```json { "SaleToPOIDeviceRequest": { "Header": { "MessageFunction": "DeviceRequest", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "CreationDateTime": "2020-05-04T18:13:51.0+01:00", "InitiatingParty": { "Identification": "SaleTermA", "Type": "Merchant" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "SubTypeInformation": "Checkout", "Identification": { "ProviderIdentification": "YourSoftware", "Identification": "YourPOS", "SerialNumber": "SN-0001" }, "Status": { "VersionNumber": "1.4.2" } } ] } }, "DeviceRequest": { "InputRequest": { "DisplayOutput": { "MessageContent": { "MultiOptionsSingleSelectionScreen": { "Title": "Icon System Demonstration", "OptionElements": [ { "OptionId": "option1", "OptionTitle": "Custom WL Icon", "OptionContent": "icon.ic_yes", "OptionIcon": "icon.ic_yes" }, { "OptionId": "option2", "OptionTitle": "Direct Emoji", "OptionContent": "emoji.🎉", "OptionIcon": "emoji.🎉" }, { "OptionId": "option3", "OptionTitle": "Unicode Emoji", "OptionContent": "emoji.U+1F680", "OptionIcon": "emoji.U+1F680" }, { "OptionId": "option4", "OptionTitle": "Material Symbol", "OptionContent": "material.celebration", "OptionIcon": "material.celebration" }, { "OptionId": "option5", "OptionTitle": "No Icon", "OptionContent": "(no icon specified)" } ] } } }, "InputData": { "MaximumInputTime": 30000 } } } } } ``` -------------------------------- ### Simple Payment Error Response JSON Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Example of a failed payment response indicating a missing mandatory parameter. ```json { "SaleToPOIServiceResponse": { "Header": { "MessageFunction": "SaleFinancialServiceResponse", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "CreationDateTime": "2020-05-04T18:13:51.0+01:00", "InitiatingParty": { "Identification": "WL000D5T0000004", "Type": "Merchant" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "SubTypeInformation": "Checkout", "Identification": { "ProviderIdentification": "YourSoftware", "Identification": "YourPOS", "SerialNumber": "SN-0001" }, "Status": { "VersionNumber": "1.4.2" } } ] }, "WebhookUrl": "https://example.com/webhook?transactionId=a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "NumberOfRetries": 3 }, "ServiceResponse": { "Environment": { "Merchant": { "Identification": { "Identification": "WL000D5T0000004" } }, "POI": { "Identification": { "Identification": 26197214 } } }, "Context": { "SaleContext": { "SaleIdentification": "SaleTermA" } }, "ServiceContent": "FinancialPaymentResponse", "Response": { "Response": "Failure", "ResponseReason": "NotAllowed", "AdditionalResponseInformation": "WPI_ERR_COND_MISSING_MANDATORY_PARAMETER:EFT_E_PARAMETER_AMOUNT_MISSING" } } } } ``` -------------------------------- ### MultiOptionsSingleSelectionScreen Extension Source: https://docs.terminal.worldline-solutions.com/api-reference The MultiOptionsSingleSelectionScreen extension presents a list of options to the user, allowing them to select one. The selected OptionId is returned in the response. ```APIDOC ## MultiOptionsSingleSelectionScreen Object ### Description Displays a list of selectable options to the user on the terminal. ### Request Body - **ShowLogo** (boolean) - Optional - Flag to indicate whether to show the logo at the top of the screen - **BackgroundColor** (string) - Optional - Hex color code for background - **ButtonColor** (string) - Optional - Hex color code for buttons - **Title** (string) - Required - Title or question to display - **OptionElements** (Array) - Required - List of selectable options #### Option Element Fields - **OptionId** (string) - Required - Unique identifier for the option - **OptionTitle** (string) - Required - Description of the option - **OptionContent** (string) - Optional - Additional text displayed below the title - **OptionIconColor** (string) - Optional - Hex color code for the icon - **OptionIcon** (string) - Optional - Icon specification (e.g., "icon.payment", "emoji.U+1F600") ``` -------------------------------- ### Payment Request JSON Structure Source: https://docs.terminal.worldline-solutions.com/build-your-integration/understanding-our-protocol Example of the hierarchical JSON structure for a PaymentRequest, including the Header and ServiceRequest blocks. ```json { "SaleToPOIServiceRequest": { "Header": { "MessageFunction": "SaleFinancialServiceRequest", "ProtocolVersion": "5.1-WL1.0.0", "ExchangeIdentification": "unique-id-001", "WebhookUrl": "https://example.com/webhook", "NumberOfRetries": 3, ... }, "ServiceRequest": { "PaymentRequest": { "PaymentTransaction": { "TransactionType": "CardPayment", "TransactionDetails": { "TotalAmount": 10.50, "Currency": "EUR" } } } } } } ``` ```json { "SaleToPOIServiceRequest": { "Header": { "MessageFunction": "SaleFinancialServiceRequest", "ProtocolVersion": "5.1-WL1.0.0", "ExchangeIdentification": "unique-id-001", "WebhookUrl": "https://example.com/webhook", "NumberOfRetries": 3, ... }, "ServiceRequest": { "PaymentRequest": { "PaymentTransaction": { "TransactionType": "CardPayment", "TransactionDetails": { "TotalAmount": 10.50, "Currency": "EUR" } } } } } } ``` -------------------------------- ### GET /merchants/{umid} Source: https://docs.terminal.worldline-solutions.com/api-reference Retrieves merchant details including the unique merchant identifier, connected terminals, and the merchant token. ```APIDOC ## GET /merchants/{umid} ### Description Retrieves information for a specific merchant, including the merchant token, umid, and a list of connected terminals. ### Method GET ### Endpoint /merchants/{umid} ### Parameters #### Path Parameters - **umid** (string) - Required - The unique merchant identifier. ### Response #### Success Response (200) - **umid** (string) - The unique merchant identifier. - **connectedTerminals** (array) - List of terminals associated with the merchant. - **merchantToken** (string) - The merchant authentication token. ``` -------------------------------- ### PrintQRCodeRequest Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Sends a QR code to be printed on the terminal. ```APIDOC ## PrintQRCodeRequest ### Description Sends a barcode formatted as a QR code to the terminal printer. ### Request Body - **SaleToPOIDeviceRequest** (object) - The root request object containing the Header and DeviceRequest. ### Request Example { "SaleToPOIDeviceRequest": { "Header": { "MessageFunction": "DeviceRequest", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "4d5e6f7a-8b9c-4d0e-1f2a-3b4c5d6e7f8a", "CreationDateTime": "2026-02-24T12:00:00Z", "InitiatingParty": { "Identification": "SaleTermA" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "Status": { "VersionNumber": "1.4.2" } } ] } }, "DeviceRequest": { "PrintRequest": { "OutputContent": { "Format": "Barcode", "OutputBarcode": { "BarcodeType": "QRCode", "BarcodeValue": "https://example.com/receipt/12345" } } } } } } ``` -------------------------------- ### Print QR Code Request Source: https://docs.terminal.worldline-solutions.com/api-reference-accessible Sends a URL to be rendered as a QR code on the terminal receipt. ```json { "SaleToPOIDeviceRequest": { "Header": { "MessageFunction": "DeviceRequest", "ProtocolVersion": "5.1-WL2.0.1", "ExchangeIdentification": "4d5e6f7a-8b9c-4d0e-1f2a-3b4c5d6e7f8a", "CreationDateTime": "2026-02-24T12:00:00Z", "InitiatingParty": { "Identification": "SaleTermA" }, "SalesSystemInfo": { "IntegratorId": "9b2e6f1a1c3d4e5f8a7b0c1d2e3f4a5b", "SaleSoftware": [ { "Type": "ECR", "Status": { "VersionNumber": "1.4.2" } } ] } }, "DeviceRequest": { "PrintRequest": { "OutputContent": { "Format": "Barcode", "OutputBarcode": { "BarcodeType": "QRCode", "BarcodeValue": "https://example.com/receipt/12345" } } } } } } ```