### Multiple Processing Platforms Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Information on how Worldline Connect provides access to multiple Worldline processing platforms and notes on platform-specific differences. ```APIDOC ## Multiple Processing Platforms ### Description Worldline Connect unifies access to several Worldline processing platforms through a single integration. While most functionalities are consistent, some platform-specific differences exist and are being addressed. ### Supported Platforms * Worldline’s Ogone Payment Platform (closed beta) * Worldline’s Global Collect Payment Platform * Worldline’s TechProcess Payment Platform * Worldline’s Online Payment Acceptance Payment Platform ### `statusCode` Field * The `status` field reflects a platform-agnostic status. * The raw `statusCode` from the underlying platform is included in the `statusOutput` object. This is primarily for migration ease and should not be used for new business logic as it may be deprecated. * This `statusCode` value is visible in the Global Collect Payment Console, report files, and the Ogone BackOffice. ``` -------------------------------- ### Server API vs. Client API Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Explanation of the differences and use cases for the Worldline Connect Server API and Client API. ```APIDOC ## Server API vs. Client API ### Description Worldline Connect offers two distinct RESTful APIs: the Server API for server-to-server integrations and the Client API for client-side integrations (desktops, mobiles, etc.). ### Server API - **Purpose**: Enables merchants to access GlobalCollect platform functionalities like processing payments, initiating hosted checkouts, and creating tokens. - **Authentication**: Requires a secret API key, obtainable from the merchant's Configuration Center account. ### Client API - **Purpose**: Allows clients to access hosted data on the GlobalCollect platform, such as payment product details and public encryption keys. - **Authentication**: Requires a session ID created via the Server API's 'create session' call. - **Session Validity**: Access is granted for 2 hours upon session creation. All payment requests within this context must be submitted within this timeframe due to session-linked encryption keys. ``` -------------------------------- ### Concepts Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL Overview of the Worldline Connect API, its design principles, and usage guidelines. ```APIDOC ## API Design Principles ### Description The Worldline Connect API is designed as a REST API, utilizing the HTTP protocol. Resources are accessible via clearly named URLs, and HTTP response codes indicate status. HTTP Verbs like GET and POST are used for interaction. The API supports cross-origin resource sharing and uses JSON for all payloads, including error messages. ### Method N/A (General Concepts) ### Endpoint N/A (General Concepts) ### Parameters N/A (General Concepts) ### Request Example N/A (General Concepts) ### Response N/A (General Concepts) ## Server and Client API Overview ### Description Worldline offers two RESTful APIs: a Server API for server-to-server integrations and a Client API for client-side applications (desktops, mobiles, etc.). The Client API offers a subset of functionality and is designed to assist in collecting and encrypting sensitive information on the client device. ### Method N/A (API Type Overview) ### Endpoint N/A (API Type Overview) ### Parameters N/A (API Type Overview) ### Request Example N/A (API Type Overview) ### Response N/A (API Type Overview) ## Server API ### Description The Server API allows merchants to access GlobalCollect platform functionalities like processing payments, initiating hosted checkouts, and creating tokens. All Server API calls require a secret API key obtainable from the merchant's Configuration Center account. ### Method N/A (Server API Description) ### Endpoint N/A (Server API Description) ### Parameters N/A (Server API Description) ### Request Example N/A (Server API Description) ### Response N/A (Server API Description) ## Client API ### Description The Client API enables client applications (mobile phones, browsers, apps) to access hosted data on the GlobalCollect platform, such as payment product details and public encryption keys. Client API access must be granted via the Server API's 'create session' call and is valid for 2 hours. Payments initiated within this session must also be submitted within the 2-hour window. ### Method N/A (Client API Description) ### Endpoint N/A (Client API Description) ### Parameters N/A (Client API Description) ### Request Example N/A (API Type Overview) ### Response N/A (API Type Overview) ## Multiple Processing Platforms ### Description Worldline Connect allows integration with multiple Worldline processing platforms (e.g., Ogone, Global Collect, TechProcess, Online Payment Acceptance) through a single integration. While most functionalities are platform-independent, some differences exist and may be resolved as new features are rolled out. ### Method N/A (Platform Overview) ### Endpoint N/A (Platform Overview) ### Parameters N/A (Platform Overview) ### Request Example N/A (Platform Overview) ### Response N/A (Platform Overview) ## Status Code Field ### Description The `status` field in responses reflects the object's status universally across platforms. The raw `statusCode` from the underlying platform is also included in the `statusOutput` object to aid migration. New business logic should not rely on `statusCode` as it is planned for deprecation. This value is also visible in Worldline consoles and report files. ### Method N/A (Status Code Field Description) ### Endpoint N/A (Status Code Field Description) ### Parameters N/A (Status Code Field Description) ### Request Example N/A (Status Code Field Description) ### Response #### Success Response (200) - **status** (string) - The universal status of the object. - **statusOutput** (object) - Contains platform-specific status details. - **statusCode** (string) - The raw status code from the underlying processing platform. #### Response Example ```json { "status": "COMPLETED", "statusOutput": { "statusCode": "12345" } } ``` ``` -------------------------------- ### Multiple Processing Platforms Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Overview of the multiple processing platforms accessible through Worldline Connect, including differences and the handling of status codes. ```APIDOC ## Multiple Processing Platforms ### Description Worldline Connect provides a unified interface to multiple Worldline processing platforms: Ogone Payment Platform, Global Collect Payment Platform, TechProcess Payment Platform, and Online Payment Acceptance Payment Platform. ### Platform Differences While most functionalities are consistent across platforms, some differences may exist, particularly during the beta phase for the Ogone Payment Platform integration. ### Status Code Handling The `status` field reflects a standardized object status. The raw `statusCode` from the underlying platform is also returned within the `statusOutput` object for migration purposes. New business logic should not rely on the raw `statusCode` as it may be deprecated. ``` -------------------------------- ### Services API Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Provides services like amount conversion and bank account conversion, available on Worldline's Global Collect Payment Platform and Worldline's Online Payment Acceptance Payment Platform. ```APIDOC ## POST /api/convert_amount ### Description Converts an amount from one currency to another. Available on Worldline's Global Collect and Online Payment Acceptance platforms. ### Method POST ### Endpoint /api/convert_amount ### Parameters #### Request Body - **sourceAmount** (object) - Required - The amount to convert. - **value** (number) - Required - The amount value. - **currency** (string) - Required - The source currency code (e.g., 'EUR'). - **targetCurrency** (string) - Required - The target currency code (e.g., 'USD'). ### Request Example ```json { "sourceAmount": { "value": 100.00, "currency": "EUR" }, "targetCurrency": "USD" } ``` ### Response #### Success Response (200) - **convertedAmount** (object) - The converted amount. - **value** (number) - The converted amount value. - **currency** (string) - The target currency code. #### Response Example ```json { "convertedAmount": { "value": 110.50, "currency": "USD" } } ``` ## POST /api/convert_bank_account ### Description Converts bank account details to a standardized format. Available on Worldline's Global Collect and Online Payment Acceptance platforms. ### Method POST ### Endpoint /api/convert_bank_account ### Parameters #### Request Body - **accountDetails** (object) - Required - The bank account details to convert. - **accountNumber** (string) - Optional - The account number. - **iban** (string) - Optional - The IBAN. - **bic** (string) - Optional - The BIC. - **sortCode** (string) - Optional - The sort code. ### Request Example ```json { "accountDetails": { "iban": "GB29NWBK60161331926819", "bic": "NWBKGB2L" } } ``` ### Response #### Success Response (200) - **standardizedAccountDetails** (object) - The standardized bank account details. - **accountNumber** (string) - The standardized account number. - **iban** (string) - The standardized IBAN. - **bic** (string) - The standardized BIC. - **sortCode** (string) - The standardized sort code. #### Response Example ```json { "standardizedAccountDetails": { "accountNumber": "31926819", "iban": "GB29NWBK60161331926819", "bic": "NWBKGB2L", "sortCode": "60-16-13" } } ``` ``` -------------------------------- ### Server API vs. Client API Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Details the distinctions between the Server API, used for server-to-server integrations, and the Client API, used by client devices. ```APIDOC ## Server and Client API ### Description Worldline Connect offers two distinct RESTful APIs: the Server API for secure server-to-server integrations and the Client API for direct use by client devices (desktops, mobiles, etc.). ### Server API * **Purpose**: Enables merchants to access GlobalCollect platform functionalities like payments, hosted checkouts, and token creation. * **Authentication**: Requires a secret API key obtained from the Configuration Center. ### Client API * **Purpose**: Allows clients to access hosted data such as payment product details, profile management, and encryption public keys. * **Authentication**: Requires a session ID created via the Server API's `create session` call. * **Session Validity**: Access granted for 2 hours, during which payments must be submitted using the session-linked encryption keys. ``` -------------------------------- ### Multiple Processing Platforms Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Information on how Worldline Connect integrates with various processing platforms and potential differences. ```APIDOC ## Multiple Processing Platforms ### Description Worldline Connect provides a unified interface to multiple Worldline processing platforms, including Ogone, Global Collect, TechProcess, and Online Payment Acceptance. ### Supported Platforms - Worldline’s Ogone Payment Platform (closed beta) - Worldline’s Global Collect Payment Platform - Worldline’s TechProcess Payment Platform - Worldline’s Online Payment Acceptance Payment Platform ### Platform Differences While most functionalities are consistent across platforms, some differences may exist, particularly during the beta phase for the Ogone platform integration. The `statusCode` field in the `statusOutput` object reflects the raw status code of the underlying processing platform and is provided for migration ease. New business logic should not rely on this field as it will be deprecated in the future. ``` -------------------------------- ### Supported Processing Platforms Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL Details on the multiple Worldline processing platforms accessible through Worldline Connect, including Ogone, Global Collect, TechProcess, and Online Payment Acceptance. ```APIDOC ## Multiple Processing Platforms ### Description Worldline Connect provides a unified integration point for multiple Worldline processing platforms. This allows merchants to leverage different platforms through a single API. Currently, four platforms are supported: * Worldline’s Ogone Payment Platform (currently in closed beta) * Worldline’s Global Collect Payment Platform * Worldline’s TechProcess Payment Platform * Worldline’s Online Payment Acceptance Payment Platform ### Platform Differences While most functionalities are consistent across platforms, some differences exist. These differences are expected to diminish as the Ogone Payment Platform integration evolves. Notably, the `statusCode` field within the `statusOutput` object returns the raw status code of the underlying processing platform to aid migration, but new business logic should not be based on it as it will be deprecated. ``` -------------------------------- ### Worldline Connect API Concepts Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL General concepts and design principles of the Worldline Connect API. ```APIDOC ## Worldline Connect API Concepts ### Description The Worldline Connect API is a RESTful API designed to interact with Worldline's payment processing platforms. It utilizes the HTTP protocol, with clearly defined URLs for resources and standard HTTP response codes for status indication. HTTP verbs like GET and POST are employed for resource manipulation. The API supports Cross-Origin Resource Sharing (CORS) for direct client access and uses JSON for all request and response payloads, including error messages. ### Key Features - **RESTful Design**: Adheres to REST principles for resource accessibility and statelessness. - **HTTP Protocol**: Uses standard HTTP methods (GET, POST, PUT, DELETE) and response codes. - **JSON Payloads**: All data is exchanged in JSON format. - **CORS Support**: Enables direct interaction from web clients. - **SDKs Available**: Worldline provides SDKs to simplify integration with both the Server API and Client API. ### Server and Client API #### Server API - **Purpose**: Used for server-to-server integrations. - **Functionality**: Enables merchants to perform actions like making payments, initiating hosted checkouts, and creating tokens. - **Authentication**: Requires a secret API key obtained from the merchant's Configuration Center account. #### Client API - **Purpose**: Used by client devices (desktops, laptops, mobile phones, apps). - **Functionality**: Provides access to hosted data such as payment product details and public encryption keys. It also supports UI-driven data collection and client-side encryption. - **Authentication**: Requires a session ID created via the Server API's create session call. - **Session Validity**: Access is granted for 2 hours, during which payments must be submitted. Encryption keys are tied to the session context. ### Multiple Processing Platforms The Worldline Connect API provides a unified interface to multiple Worldline processing platforms, including: - Worldline’s Ogone Payment Platform - Worldline’s Global Collect Payment Platform - Worldline’s TechProcess Payment Platform - Worldline’s Online Payment Acceptance Payment Platform While most functionalities are platform-agnostic, some differences may exist and are being addressed during the rollout of new features. ``` -------------------------------- ### Tokens API Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Manages tokenization of payment information across various Worldline platforms, with differences in implicit vs. explicit token creation and updating. ```APIDOC ## POST /api/payments (Implicit Token Update - Ogone Platform) ### Description Submits a payment request with a token and new data to implicitly update an existing token on Worldline's Ogone Payment Platform. ### Method POST ### Endpoint /api/payments ### Parameters #### Request Body - **token** (string) - Required - The existing token to update. - **newData** (object) - Required - The new payment data to associate with the token. - **cardNumber** (string) - Optional - The new card number. - **expiryDate** (string) - Optional - The new expiry date (MMYY). - **cardHolderName** (string) - Optional - The new cardholder name. ### Request Example ```json { "token": "tok_abc123", "newData": { "cardNumber": "4111111111111111", "expiryDate": "1225", "cardHolderName": "Jane Doe" } } ``` ### Response #### Success Response (200) - **paymentStatus** (string) - The status of the payment processed with the updated token. - **token** (string) - The updated token. #### Response Example ```json { "paymentStatus": "SUCCESS", "token": "tok_abc123" } ``` ## POST /api/update_token (Explicit Token Update - Global Collect Platform) ### Description Explicitly updates a token with new data on Worldline's Global Collect Payment Platform. ### Method POST ### Endpoint /api/update_token ### Parameters #### Request Body - **token** (string) - Required - The token to update. - **newlData** (object) - Required - The new payment data. - **cardNumber** (string) - Optional - The new card number. - **expiryDate** (string) - Optional - The new expiry date (MMYY). - **cardHolderName** (string) - Optional - The new cardholder name. ### Request Example ```json { "token": "tok_xyz789", "newData": { "expiryDate": "0126" } } ``` ### Response #### Success Response (200) - **status** (string) - The status of the token update operation. #### Response Example ```json { "status": "UPDATED" } ``` ## POST /api/create_token_from_payment (Global Collect Platform) ### Description Creates a new token from a payment transaction on Worldline's Global Collect Payment Platform. ### Method POST ### Endpoint /api/create_token_from_payment ### Parameters #### Query Parameters - **transactionId** (string) - Required - The ID of the transaction to create a token from. ### Response #### Success Response (200) - **token** (string) - The newly created token. #### Response Example ```json { "token": "tok_new456" } ``` ``` -------------------------------- ### Server API vs. Client API Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL Explanation of the two distinct APIs offered by Worldline Connect: the Server API for backend integrations and the Client API for frontend device interactions. ```APIDOC ## Server and Client API ### Description Worldline Connect offers two RESTful APIs: the Server API for server-to-server integrations and the Client API for client-side devices (desktops, laptops, mobile phones). The Client API offers reduced functionality due to device control limitations and is designed for UI interaction and client-side encryption. ### Server API * **Purpose**: Enables merchants to access GlobalCollect platform functionalities like payments, hosted checkouts, and token creation. * **Authentication**: Requires a secret API key obtained from the merchant's Configuration Center account. ### Client API * **Purpose**: Allows clients to access hosted data such as payment product details, profile management, and public keys for encrypting sensitive data. * **Authentication**: Requires a session ID created using the Server API's create session call. * **Session Validity**: Access is granted for 2 hours, during which payments can be created. Encryption keys are linked to the session context. ``` -------------------------------- ### Create Payment API (Ogone Platform) Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Endpoint for creating payments on the Ogone platform, where the 'returnUrl' field is required for all card transactions. ```APIDOC ## POST /api/payments (Ogone Platform - returnUrl Requirement) ### Description Creates a payment transaction on Worldline's Ogone Payment Platform. The `returnUrl` field is mandatory for all card transactions. ### Method POST ### Endpoint /api/payments ### Parameters #### Request Body - **cardTransaction** (object) - Required - Details for a card transaction. - **returnUrl** (string) - Required - The absolute URL to redirect the user after the transaction. Must use https://, not IP addresses or localhost. Custom protocols for mobile are supported if registered. - **amount** (object) - Required - The transaction amount. - **value** (number) - Required - The amount value. - **currency** (string) - Required - The currency code. - **cardDetails** (object) - Required - Cardholder payment details. - **cardNumber** (string) - Required - The card number. - **expiryDate** (string) - Required - The expiry date (MMYY). - **cvv** (string) - Optional - The CVV code. ### Request Example ```json { "cardTransaction": { "returnUrl": "https://yourwebsite.com/payment/callback", "amount": { "value": 100.00, "currency": "EUR" }, "cardDetails": { "cardNumber": "4111111111111111", "expiryDate": "1225", "cvv": "123" } } } ``` ### Response #### Success Response (200) - **paymentId** (string) - The ID of the created payment. - **status** (string) - The status of the payment. - **redirectUrl** (string) - URL to redirect the user for further actions (if applicable). #### Response Example ```json { "paymentId": "pay_abc123", "status": "PENDING_AUTHORIZATION", "redirectUrl": "https://payment.worldline.com/...". } ``` ``` -------------------------------- ### Concepts and Architecture Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Overview of the Worldline Connect API, its RESTful design, use of HTTP protocols, JSON payloads, and the distinction between Server and Client APIs. ```APIDOC ## Concepts The Worldline Connect API is a RESTful API using the HTTP protocol. Resources are accessible via URLs, and HTTP response codes indicate status. HTTP verbs like GET and POST are used for interaction. Cross-origin resource sharing is supported. JSON is used for all payloads, including error messages. ## Server API vs. Client API ### Server API This API is for server-to-server integrations. It allows merchants to access GlobalCollect platform functionalities such as payments, hosted checkouts, and token creation. Requires a secret API key. ### Client API This API is for clients (desktops, mobile phones, apps) to access hosted data like payment products and public encryption keys. Requires a session ID created via the Server API. Access is granted for 2 hours. ## Processing Platforms Worldline Connect supports multiple processing platforms: * Worldline's Ogone Payment Platform * Worldline's Global Collect Payment Platform * Worldline's TechProcess Payment Platform * Worldline's Online Payment Acceptance Payment Platform ### statusCode Field The `status` field reflects a general status. The raw `statusCode` from the underlying platform is also returned in the `statusOutput` object for migration purposes. New business logic should not rely on `statusCode` as it will be deprecated. ``` -------------------------------- ### Server API Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Details about the Server API, which is designed for server-to-server integrations and provides access to core payment functionalities. ```APIDOC ## Server API ### Description The Server API enables merchants to integrate with the GlobalCollect platform for functionalities such as processing payments, initiating hosted checkouts, creating tokens, and more. All calls to this API require a secret API key. ### Purpose Server-to-server integrations, payment processing, hosted checkouts, token management. ### Authentication Requires a secret API key. ``` -------------------------------- ### Captures API Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Handles capture requests for transactions on specific Worldline platforms (Ogone, TechProcess, Online Payment Acceptance). Global Collect platform requires an approve payment API call. ```APIDOC ## POST /api/captures ### Description Initiates one or more captures for a transaction that has reached the PENDING_CAPTURE status on Worldline's Ogone, TechProcess, or Online Payment Acceptance platforms. Each capture request creates a new Captures object. ### Method POST ### Endpoint /api/captures ### Parameters #### Query Parameters - **transactionId** (string) - Required - The ID of the transaction to capture. ### Request Body * **numberOfCaptures** (integer) - Required - The number of captures to initiate. * **captureAmount** (number) - Optional - The amount to capture. If not provided, the full pending amount will be captured. ### Request Example ```json { "numberOfCaptures": 2, "captureAmount": 100.50 } ``` ### Response #### Success Response (200) - **captures** (array) - A list of newly created Captures objects. - **captureId** (string) - The ID of the capture. - **status** (string) - The status of the capture. #### Response Example ```json { "captures": [ { "captureId": "cap_12345", "status": "PENDING" }, { "captureId": "cap_67890", "status": "PENDING" } ] } ``` ## POST /api/approve_payment (Global Collect Platform) ### Description Approves a transaction on Worldline's Global Collect Payment Platform, initiating the capture process. This action does not create a new capture object but places the transaction in the capture queue. ### Method POST ### Endpoint /api/approve_payment ### Parameters #### Query Parameters - **transactionId** (string) - Required - The ID of the transaction to approve. ### Request Body * **amount** (number) - Optional - The amount to approve for capture. If not provided, the full pending amount will be approved. ### Request Example ```json { "amount": 50.00 } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating the transaction has been queued for capture. #### Response Example ```json { "message": "Transaction approved and added to capture queue." } ``` ``` -------------------------------- ### Multiple Processing Platforms Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Details on how Worldline Connect accesses multiple processing platforms and specific considerations like the 'statusCode' field. ```APIDOC ## Multiple Processing Platforms ### Description Worldline Connect provides a unified interface to multiple Worldline processing platforms, including Ogone, Global Collect, TechProcess, and Online Payment Acceptance. While most functionalities remain consistent, there might be platform-specific differences. ### Supported Platforms * Worldline’s Ogone Payment Platform (closed beta) * Worldline’s Global Collect Payment Platform * Worldline’s TechProcess Payment Platform * Worldline’s Online Payment Acceptance Payment Platform ### statusCode Field The `status` field in responses reflects a universal status across platforms. The raw `statusCode` from the underlying platform is also returned within the `statusOutput` object. This is primarily to aid migration from legacy APIs and should not be used for new business logic as it may be deprecated in the future. The `statusCode` value is also visible in respective platform consoles and reports. ``` -------------------------------- ### Worldline Connect API Concepts Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Overview of the Worldline Connect API's design principles, including its RESTful nature, use of HTTP, JSON payloads, and support for cross-origin resource sharing. ```APIDOC ## Worldline Connect API Concepts ### Description The Worldline Connect API is designed as a REST API using the HTTP protocol. Resources are accessible via clear URLs, and HTTP response codes indicate status. HTTP verbs like GET and POST are used for interaction. The API supports cross-origin resource sharing and uses JSON for all payloads, including error messages. ### Server and Client API Two distinct APIs are offered: - **Server API**: For server-to-server integrations, enabling functionalities like payments, hosted checkouts, and token creation. Requires a secret API key. - **Client API**: For client-side applications (desktops, mobiles, apps), providing access to hosted data like payment products and encryption keys. Requires a session ID created via the Server API and is valid for 2 hours. ### Multiple Processing Platforms Worldline Connect provides access to multiple processing platforms (Ogone, Global Collect, TechProcess, Online Payment Acceptance) through a single integration. While most functionalities are consistent, some differences may exist, particularly during the beta phase for the Ogone platform. ### Status Code Handling The `status` field in responses reflects a common status across platforms. The raw `statusCode` from the underlying platform is also included in the `statusOutput` object for migration purposes. Developers should avoid writing new business logic based on `statusCode` as it will be deprecated. ``` -------------------------------- ### Card Payouts Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Details on card payout capabilities across GlobalCollect, Ogone, and Worldline Online Payment Acceptance platforms, specifying Visa Direct OCT for GlobalCollect. ```APIDOC ## POST /api/payouts (GlobalCollect Platform) ### Description Initiates a card payout using the Visa Direct OCT product on the GlobalCollect platform. ### Method POST ### Endpoint /api/payouts ### Parameters #### Query Parameters - **paymentProductID** (integer) - Required - Must be 1702 for Visa Direct OCT. ### Request Body - **accountDetails** (object) - Required - Details of the payout recipient account. - **accountNumber** (string) - Required - The recipient's account number. - **sortCode** (string) - Required - The recipient's sort code. - **amount** (object) - Required - The payout amount. - **value** (number) - Required - The amount value. - **currency** (string) - Required - The currency code (e.g., 'USD'). ### Request Example ```json { "accountDetails": { "accountNumber": "1234567890", "sortCode": "112233" }, "amount": { "value": 50.00, "currency": "USD" } } ``` ### Response #### Success Response (200) - **payoutId** (string) - The ID of the initiated payout. - **status** (string) - The status of the payout. #### Response Example ```json { "payoutId": "payout_abc", "status": "PROCESSING" } ``` ``` -------------------------------- ### Worldline Connect API Concepts Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Overview of the Worldline Connect API's design principles, including its RESTful nature, use of HTTP, JSON payloads, and cross-origin resource sharing. ```APIDOC ## Worldline Connect API Concepts ### Description The Worldline Connect API is designed as a REST API, utilizing the HTTP protocol. Resources are accessible via clearly named URLs, and HTTP response codes indicate status. HTTP verbs like GET and POST are used for resource interaction. The API supports cross-origin resource sharing and uses JSON for all payloads, including error messages. ### Key Features * **RESTful Design**: Adheres to REST principles for resource management. * **HTTP Protocol**: Uses standard HTTP methods (GET, POST, etc.) and response codes. * **JSON Payloads**: All request and response bodies, including errors, are in JSON format. * **Cross-Origin Resource Sharing (CORS)**: Supported for direct client interaction. ``` -------------------------------- ### Accessing Multiple Processing Platforms Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts Worldline Connect provides a unified interface to access multiple Worldline processing platforms, including Ogone, Global Collect, TechProcess, and Online Payment Acceptance. ```APIDOC ## Multiple Processing Platforms ### Description Connect API abstracts multiple underlying payment processing platforms into a single interface. ### Method Not applicable (Overview) ### Endpoint Not applicable (Overview) ### Parameters Not applicable (Overview) ### Request Example Not applicable (Overview) ### Response Not applicable (Overview) ``` -------------------------------- ### Worldline Connect API Concepts Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Overview of the Worldline Connect API design principles, including its RESTful nature, HTTP verb usage, JSON payloads, and CORS support. ```APIDOC ## Worldline Connect API Concepts ### Description The Worldline Connect API is designed as a REST API using the HTTP protocol. Resources are accessed via clearly named URLs, and HTTP response codes indicate status. Standard HTTP Verbs (GET, POST) are used for resource interaction. The API supports Cross-Origin Resource Sharing (CORS) for direct client accessibility and uses JSON for all payloads, including error messages. ### Key Characteristics * **RESTful Design**: Adheres to REST architectural principles. * **HTTP Protocol**: Utilizes standard HTTP methods and response codes. * **JSON Payloads**: All data exchange, including errors, uses JSON format. * **CORS Support**: Enables direct interaction from client-side applications. * **SDKs Available**: Offers SDKs for both Server and Client APIs to simplify integration. ### Server API vs. Client API * **Server API**: For server-to-server integrations, enabling access to core platform functionalities like payments, hosted checkouts, and token creation. Requires a secret API key. * **Client API**: For client-side devices (desktops, mobiles, apps). Provides access to hosted data like payment products and encryption keys. Requires a session ID created via the Server API and is valid for 2 hours. ``` -------------------------------- ### Worldline Connect API Concepts Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL Overview of the Worldline Connect API, its RESTful design, use of HTTP methods, JSON payloads, and cross-origin resource sharing support. ```APIDOC ## Worldline Connect API Concepts ### Description The Worldline Connect API is designed as a REST API. It uses the HTTP protocol as its foundation, with each resource accessible under a clearly named URL. HTTP response codes are used to relay status, and HTTP verbs like GET and POST interact with resources. The API supports cross-origin resource sharing and uses JSON for all payloads, including error messages. ### Key Characteristics * **RESTful Design**: Follows REST principles for resource management. * **HTTP Protocol**: Utilizes standard HTTP methods (GET, POST, etc.) and response codes. * **JSON Payloads**: All request and response bodies are in JSON format. * **Cross-Origin Resource Sharing (CORS)**: Supported for client-side accessibility. * **SDKs Available**: SDKs are provided to simplify integration with both the Server API and Client API. ``` -------------------------------- ### Server API Overview Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts The Server API enables merchants to access GlobalCollect platform functionality such as making payments, initiating hosted checkouts, and creating tokens. All calls require a secret API key. ```APIDOC ## Server API ### Description This API is designed for server-to-server integrations, allowing merchants to perform core payment operations. ### Method Not applicable (Overview) ### Endpoint Not applicable (Overview) ### Parameters Not applicable (Overview) ### Request Example Not applicable (Overview) ### Response Not applicable (Overview) ``` -------------------------------- ### Worldline Connect API Concepts Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL General concepts and principles of the Worldline Connect API, including its RESTful nature, use of HTTP methods, JSON payloads, and cross-origin resource sharing. ```APIDOC ## Worldline Connect API Concepts ### Description The Worldline Connect API is a RESTful API that uses the HTTP protocol. Resources are accessible via URLs, and HTTP response codes indicate status. HTTP verbs like GET and POST are used for interactions. The API supports cross-origin resource sharing and uses JSON for all payloads, including error messages. ### Key Features - RESTful design - HTTP protocol foundation - JSON payloads - Cross-origin resource sharing (CORS) support - Standard HTTP response codes for status - Use of HTTP Verbs (GET, POST, etc.) ``` -------------------------------- ### Worldline Connect API Concepts Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Overview of the Worldline Connect API's design principles, including its RESTful nature, use of HTTP, JSON payloads, and cross-origin resource sharing support. ```APIDOC ## Worldline Connect API Concepts ### Description The Worldline Connect API is designed as a REST API using the HTTP protocol. Resources are accessible via clearly named URLs, and HTTP response codes indicate status. HTTP verbs like GET and POST are used for resource interaction. The API supports cross-origin resource sharing for direct client accessibility and uses JSON for all payloads, including error messages. ### Key Features - **RESTful Design**: Follows REST principles for resource management. - **HTTP Protocol**: Utilizes standard HTTP methods and response codes. - **JSON Payloads**: All request and response bodies are in JSON format. - **Cross-Origin Resource Sharing (CORS)**: Supported for direct client integration. - **SDKs Available**: SDKs are provided to simplify integration with both Server and Client APIs. ``` -------------------------------- ### Client API Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Information regarding the Client API, used by client devices like mobiles and browsers for accessing hosted data and encrypting sensitive information. ```APIDOC ## Client API ### Description The Client API allows client devices (desktops, laptops, mobile phones, apps) to access hosted data on the GlobalCollect platform, such as payment product details and public encryption keys. Access is granted via a session ID created through the Server API and is valid for 2 hours. ### Purpose Client-side interactions, accessing payment product information, profile management, encrypting sensitive data. ### Authentication Requires a session ID created via the Server API's 'create session' call. ### Session Validity Session is valid for 2 hours. Payment requests must be submitted within this timeframe. ``` -------------------------------- ### Risk Assessments API Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Provides dedicated risk assessment services via risk-assess card and risk-assess bankaccount APIs, currently available only on Worldline's Global Collect Payment Platform. ```APIDOC ## POST /api/risk_assess_card ### Description Performs a risk assessment on card details. Available only on Worldline's Global Collect Payment Platform. ### Method POST ### Endpoint /api/risk_assess_card ### Parameters #### Request Body - **cardDetails** (object) - Required - The card information for risk assessment. - **cardNumber** (string) - Required - The card number. - **expiryDate** (string) - Required - The expiry date (MMYY). ### Request Example ```json { "cardDetails": { "cardNumber": "4111111111111111", "expiryDate": "1225" } } ``` ### Response #### Success Response (200) - **riskScore** (integer) - The calculated risk score. - **recommendation** (string) - The risk assessment recommendation (e.g., 'ACCEPT', 'REVIEW', 'REJECT'). #### Response Example ```json { "riskScore": 75, "recommendation": "REVIEW" } ``` ## POST /api/risk_assess_bankaccount ### Description Performs a risk assessment on bank account details. Available only on Worldline's Global Collect Payment Platform. ### Method POST ### Endpoint /api/risk_assess_bankaccount ### Parameters #### Request Body - **accountDetails** (object) - Required - The bank account information. - **accountNumber** (string) - Required - The account number. - **sortCode** (string) - Required - The sort code. ### Request Example ```json { "accountDetails": { "accountNumber": "1234567890", "sortCode": "112233" } } ``` ### Response #### Success Response (200) - **riskScore** (integer) - The calculated risk score. - **recommendation** (string) - The risk assessment recommendation. #### Response Example ```json { "riskScore": 50, "recommendation": "ACCEPT" } ``` ``` -------------------------------- ### Create Payment API Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts Create a payment transaction. For Worldline's Ogone Payment Platform, the 'returnUrl' field is mandatory for all card transactions. ```APIDOC ## POST /payments ### Description Creates a payment transaction. For Worldline's Ogone Payment Platform, the `returnUrl` field is mandatory for all card transactions. ### Method POST ### Endpoint /payments ### Parameters #### Request Body - **amount** (integer) - Required - The transaction amount. - **currency** (string) - Required - The transaction currency (e.g., 'EUR'). - **paymentMethod** (object) - Required - Details of the payment method. - **type** (string) - Required - e.g., 'CARD'. - **card** (object) - Required if type is 'CARD'. - **cardNumber** (string) - Required - The card number. - **expiryDate** (string) - Required - The expiry date in 'MMYY' format. - **returnUrl** (string) - Required for Ogone card transactions - The absolute URL to redirect the user after payment. ### Request Example (Ogone Card Transaction) ```json { "amount": 1000, "currency": "EUR", "paymentMethod": { "type": "CARD", "card": { "cardNumber": "4111111111111111", "expiryDate": "1225" } }, "returnUrl": "https://yourwebsite.com/redirect" } ``` ### Response #### Success Response (201 Created) - **paymentId** (string) - The unique ID for the created payment. - **status** (string) - The initial status of the payment. #### Response Example ```json { "paymentId": "txn_abcdef12345", "status": "PENDING_PAYMENT" } ``` ``` -------------------------------- ### statusCode Field Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts_paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL&paymentplatform=ALL Explanation of the 'statusCode' field and its relation to processing platforms. ```APIDOC ## statusCode Field ### Description The `status` field in the API response reflects the overall status of an object, consistent across all processing platforms. The `statusCode` field within the `statusOutput` object contains the raw status code from the underlying processing platform. This is provided to facilitate migration from legacy APIs. ### Method N/A (This describes a response field, not an endpoint) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Status Output Object - **statusCode** (string) - The raw status code from the underlying processing platform. This field may be deprecated in the future; new business logic should not rely on it. Its value can also be found in the Global Collect Payment Console, report files, and the Ogone BackOffice. ``` -------------------------------- ### Captures API Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts Initiate one or more captures for transactions processed on Worldline's Ogone, TechProcess, and Online Payment Acceptance platforms. Each capture request creates a new Captures object. ```APIDOC ## POST /captures ### Description Initiates one or more captures for a transaction. Supported on Ogone, TechProcess, and Online Payment Acceptance platforms. Results in a new Captures object. ### Method POST ### Endpoint /captures ### Parameters #### Request Body - **paymentId** (string) - Required - The ID of the payment to capture. - **captureAmount** (integer) - Optional - The amount to capture. If not provided, the full amount is captured. - **numberOfCaptures** (integer) - Optional - The number of captures to perform. If not provided, a single capture is performed. ### Request Example ```json { "paymentId": "txn_12345abcde", "captureAmount": 1000, "numberOfCaptures": 2 } ``` ### Response #### Success Response (201 Created) - **captures** (array) - An array of capture objects. - **captureId** (string) - The ID of the capture. - **paymentId** (string) - The ID of the associated payment. - **captureAmount** (integer) - The captured amount. - **status** (string) - The status of the capture. #### Response Example ```json { "captures": [ { "captureId": "cap_1a2b3c4d5e", "paymentId": "txn_12345abcde", "captureAmount": 500, "status": "PENDING_CAPTURE" }, { "captureId": "cap_6f7g8h9i0j", "paymentId": "txn_12345abcde", "captureAmount": 500, "status": "PENDING_CAPTURE" } ] } ``` ``` -------------------------------- ### Client API Overview Source: https://apireference.connect.worldline-solutions.com/s2sapi/v1/en_US/php/concepts The Client API allows clients like mobile phones and browsers to access hosted data on the GlobalCollect platform, including payment product details and public encryption keys. Access is granted via a session ID created by the Server API and lasts for 2 hours. ```APIDOC ## Client API ### Description This API is intended for client-side integrations (e.g., mobile apps, web browsers) to interact with payment data and features. ### Method Not applicable (Overview) ### Endpoint Not applicable (Overview) ### Parameters Not applicable (Overview) ### Request Example Not applicable (Overview) ### Response Not applicable (Overview) ```