Getting Started
This section describes the general process for integrating with UKRCARD APIs, from the initial contact to the production launch.
Depending on your business requirements, you may use one or more integration domains:
WSGATE (Payments API) - for payment operations;
UAPI (Cards & Accounts API) - for card, account, and related services.
Detailed information about available methods, environments, and connection parameters is provided in the relevant documentation section for each API.
1. General integration process
Integration with UKRCARD APIs is performed in stages, from the initial contact to the production launch.
A typical integration process includes:
- initial contact with UKRCARD;
- alignment of business and technical integration parameters;
- selecting the relevant API domain and reviewing the documentation;
- preparing the integration in the Mock environment;
- performing integration testing in the Test environment;
- preparing production connectivity;
- transitioning to the Live / Production environment.
Depending on the selected API, business scenario, and connection model, certain stages may differ or be performed in parallel.
2. Contact us
After you contact us, our team will get in touch to clarify the business and technical parameters of the integration.
3. Initial alignment
At the first stage, the following should be agreed:
▪️ the client’s business model;
▪️ APIs or services to be used;
▪️ operation types;
▪️ expected usage scenarios;
▪️ payment or service geography;
▪️ technical contacts on the client side;
▪️ expected integration timeline;
▪️ testing and production launch requirements.
After that, UKRCARD provides the information required to continue working with the relevant API.
4. Integration stages
| Stage | Environment | Purpose |
|---|---|---|
| 1 | Mock / Emulation | Initial familiarisation with the API structure, request and response formats, and validation of the basic integration logic |
| 2 | Sandbox / Test environment | Full integration testing of the agreed business scenarios |
| 3 | Live / Production environment | Processing of real operations after successful testing and readiness approval |
The availability of a specific environment, test data, and the procedure for obtaining access are defined separately for each API and integration scenario.
4.1. Mock Emulation
The Mock/Emulation is used for initial familiarisation with the API and for preparing the client-side integration.
At this stage, you can:
▪️ review API request and response structures;
▪️ validate the basic call logic;
▪️ implement the initial API interaction;
▪️ test standard scenarios without affecting real operations.
The Mock environment does not replace full integration testing.
4.2. Test environment
The Test environment is used to validate the integration under conditions close to production use.
This stage typically includes:
▪️ configuring access to the relevant API;
▪️ configuring a secure connection;
▪️ validating API methods and request parameters;
▪️ testing agreed business scenarios;
▪️ validating response and error handling;
▪️ testing callback / webhook notifications, where applicable;
▪️ agreeing test results with the UKRCARD team.
Detailed test conditions and connection parameters are provided in the documentation for the relevant API.
4.3. Live / Production environment
After successful testing, the parties agree on the transition to the Production environment.
Before launch, please ensure that:
▪️ all agreed scenarios have been implemented and validated;
▪️ the client system correctly creates API requests and processes API responses;
▪️ production access to the relevant API has been configured;
▪️ responsible technical contacts have been identified;
▪️ the launch date, procedure, and communication approach have been agreed.
The Production environment is intended for processing real operations.
Production access parameters, including URLs, certificates, and network requirements, are provided according to the selected API and the agreed connection method.
5. Next steps
To continue:
- Select the required integration domain: WSGATE or UAPI.
- Review the API description and available methods.
- Open the Connectivity and mTLS Certificates section within the relevant API branch.
- Agree access to the Test environment.
- Perform integration testing.
- Agree the transition to production use.