Overview

Introduction

The Orchid payment platform allows you to process different types of payments almost everywhere in the world with support for a wide range of currencies and payment scenarios. It relies on exceptionally thought out and organised processes and high-performance computing resources, which, from the technical standpoint, makes the platform an advanced information system—state of art, high-integrity, and efficient. Thanks to this, all required actions in the platform are executed in milliseconds while merchants and their customers can expand ranges of services they offer and enjoy high quality performance of the platform.

The Orchid payment platform allows you to process different types of payments with support for a wide range of currencies and payment scenarios. It relies on exceptionally thought out and organised processes and high-performance computing resources, which, from the technical standpoint, makes the platform an advanced information system.

At the same time, the scalability of the Orchid payment platform, with its plethora of capabilities and use options, leads to a wide range of ways of how merchants can work with it. This makes the interaction with the platform convenient and efficient, but it can also be challenging, for example, when the merchant needs to find the most optimal solution that fits the merchant's business needs. To make sure that your questions about working with the platform are answered, you can use this documentation portal. You can also contact your account manager and the technical support.

To make sure that your questions about working with the platform are answered, you can use this documentation portal. You can also contact your account manager and the technical support.

Key concepts: projects and payments

While the integration workflows and scenarios can vary, working with the platform starts with registering in it a specific merchant and a project of interaction between the merchant's web service and the platform. Along with that, the project is assigned a permanent identifier, and a wide range of customisable properties is set up for it. These properties include support for and currencies, as well as various parameters that determine payment processing workflows and procedures. Once this has been done (and only then), it is possible to process payments in the project of the merchant, with payments defined as compound actions performed to carry out transfers of funds between merchants and their customers.

The number of projects set up for one merchant can vary. Most often, one project is enough, but in certain cases, the number of projects can increase. As a rule, the optimal number of projects is determined by the Orchid specialists on the basis of the merchant's business specifics and goals. More importantly, this number can be changed in the course of collaboration with Orchid.

Working with the platform starts with registering in it a specific merchant and a project of interaction between the merchant's web service and the platform. Along with that, the project is assigned a permanent identifier, and a wide range of customisable properties is set up for it. These properties include support for currencies and various parameters that determine payment processing workflows and procedures. Once this has been done (and only then), it is possible to process payments in the project of the merchant. The number of projects set up for one merchant can vary. As a rule, the optimal number of projects is determined by the Orchid specialists on the basis of the merchant's business specifics and goals.

As for payments, they can include a different number of operations that have to do with the transfer of funds. For example, within one payment, first a purchase takes place, and then—a full or partial refund. As another example, a series of regularly recurring debit operations for a fixed amount is processed within one subscription payment. And so on. Available payment types, operations, and their statuses are strictly defined in the platform and are described in this section. Meanwhile, as you read, it is important to keep in mind that payments are processed within projects and can include a varying number of operations.

Overall, this logic—that to work with the platform, the merchant's project needs to be registered and that within these registered projects payments are processed and include a certain number of operations—can be considered the basis for understanding the interaction with the platform. It applies to all actions in the Orchid platform starting from test integrations and processing test payments and ending with distributing permissions for accessing information about individual payments and operations by individual projects.

Tools: interfaces and components

To work with the Orchid payment platform, you and your web service can use specialised interfaces each of which allows you to achieve specific business goals. These interfaces include:

Payment Page—the payment form developed by Orchid that is invoked via an API and allows you to process purchases and perform other actions.
Gate—the payment API that provides you with the largest range of capabilities for working with payments of all supported types and implies that your web service utilises in-house UI solutions.
Dashboard—the web interface for your employees that allows them to configure projects, including the interface of Payment Page, and to monitor the state of all payments (processed and in-progress), to manage their execution, and to initiate various payments and operations.
Data API—an API that allows you to retrieve information about operations and balances for the projects in use. It also helps you establish the workflow of monitoring and analysing payment processing outside of Dashboard (for example, in the external BI system).

en_sdk_overview.html#en_sdk_overview__section_vcj_5zv_tvb—language-specific specialised software development kits (SDKs) that facilitate signing data sent in requests and verifying data integrity in responses and callbacks in the API interaction with the platform.
Card data encryption script—an encryption script that allows merchants to integrate with the platform using of their in-house payment form and without the integration via Gate.

Capabilities and procedures

Capabilities of the Orchid platform are diverse and, more importantly, are supported to a varying degree with different tools. Thus, Payment Page allows you to initiate authorisation holds as part of performing two-step purchases, but to withdraw or release the held funds you need to use Gate or Dashboard (or set up automatic capture operations after a specific time lag). This is true about each tool and, therefore, it is important to keep in mind that:

each tool of the platform is intended for achieving its own specific set of goals.
Achieving any applicable goal can be accomplished with the use one or several tools.
To ensure efficient use of platform, it is often beneficial to combine its capabilities and tools according to the specifics of goals you are working to accomplish.

It can also be added that from the technical standpoint supporting any capability implies performing certain procedures, and for different tools these procedures, this way or another, will have to do with the configuration of the web service, the customers, or employees of the merchant. For example, the 3‑D Secure authentication of the customer used in purchase processing does not require active participation of the web service when processing involves payment interfaces of Orchid (only customer actions are required). However, when processing occurs via Gate, the web service is required to perform a whole number of actions (accepting and processing data and redirecting the customer). These aspects of using different tools and capabilities are worth keeping in mind.

Capabilities of the Orchid platform are diverse and, more importantly, are supported to a varying degree with different tools. Each tool of the platform is intended for achieving its own specific set of goals. To ensure efficient use of platform, it is often beneficial to combine its capabilities and tools according to the specifics of goals you are working to accomplish.

The capabilities of the platform can be divided into several groups functionality-wise:

Processing payments of different types (or performing essential payment procedures)—a group of capabilities that ensure basic functions of the platform.
These capabilities allow processing purchases of different types (in one or two steps, one time or with different kinds of repetition), payouts, and 'nominal' payments for verifying payment instruments.
Performing auxiliary payment procedures—a group of capabilities that ensure compliance with the requirements imposed on payment processing in specific cases.
These capabilities allow executing procedures that are not always required but mandatory in certain cases and situations due to the requirements imposed by payment systems, regional specifics, or other conditions. As a rule, these procedures include additional customer verification, 3‑D Secure and AVS checks being the prime example.
As a rule, these procedures include additional customer verification, 3‑D Secure and AVS checks being the prime example.
Expanding the scope of payment scenarios (or using additional capabilities)—a group of capabilities that ensure flexible configuring of the integration for specific situations and business needs to improve payment services.
These capabilities allow performing procedures that can be considered complementary enhancements: they are not required to process payments, but they facilitate the variability of payment scenarios, boost payment interfaces conversion and payment acceptance rates, strengthen fraud prevention and increase customer loyalty.
Managing payment solutions—a group of capabilities that allow merchants to manage payment solutions but do not affect payment processing per se.
These capabilities are intended for simplifying the use of procedures for monitoring and analysing payment information, managing balances and other processes important for maintaining merchants' business operations.

Together, these groups of capabilities ensure full functionality and scalability of the platform for merchants.

Integration steps

Depending on the tools that will be used for working with the platform, the actual steps and the order in which they should be taken are going to vary significantly. In general case, you need:

Address the following organisational issues of interaction with Orchid:
1. If your company is not yet a client of Orchid and has not obtained the project identifier and a secret key for interacting with the platform, submit an application. Once the application receives its initial approval, you will have the contact information of the Orchid specialists in charge of your onboarding.
2. For processing payments made with Visa and Mastercard, provide your Orchid account manager with the documents of compliance with the PCI DSS requirements. The following documents are required.:
  - From all merchants—the ASV scan report.
    ASV scanning must be performed by the authorised scanning service providers (PCI SSC Approved Scanning Vendor, ASV) quarterly and after every significant change in the network infrastructure.
  - From the merchants processing over 6 million operations annually (Level 1)—the Attestation of Compliance, AOC.
  - From the merchants processing up to 6 million operations annually (Levels 2, 3, and 4)—the Self-Assessment Questionnaire, SAQ.
    With questions on completing the questionnaire, contact your Orchid account manager.
3. Coordinate the procedures of integrating with the payment platform, testing, and launching the functionality with the Orchid technical support specialists.
Complete preliminary technical tasks. Make sure to implement signature generation and callback response processing on the server side of the web service.
Test the required actions and launch the integration solution in coordination with the Orchid technical support.

Upon testing and monitoring, when the required actions are performed correctly, the Orchid technical support specialists will switch to interacting with the web service in the full-time support mode.