Introduction
Welcome to the Ukrcard APIs documentation.
This documentation provides technical information for integration with UKRCARD API services, including payment processing services as well as card, account, and related services.
Getting started
If you are integrating with UKRCARD services for the first time, we recommend starting with the "Getting Started" section.
It describes the general integration process:
▪️ initial alignment of business and technical parameters;
▪️ work with a sandbox or mock environment;
▪️ integration testing in a test environment;
▪️ preparation for production launch;
▪️ transition to the production environment;
▪️ security requirements and PCI DSS.
Integration domains
UKRCARD documentation covers few primary integration domains:
WSGATE (Payments API) is a REST API for integration with UKRCARD payment services.
The API is designed for initiating and managing payment operations, retrieving their statuses, performing reversals and refunds, and supporting related payment scenarios.
The "WSGATE (Payments API)" section contains the description of API methods, request and response formats, integration parameters, response codes, and operation-processing recommendations.
UAPI (Cards & Accounts API) is a REST API for integration with UKRCARD processing centre card and account services.
The API is designed for working with cards, accounts, statuses, limits, transaction history, and other card-related services.
The "UAPI (Cards & Accounts API)" section contains the description of available methods, request and response formats, and integration-specific requirements.
Integration environments
Depending on the API and the agreed integration scenario, the following environments may be available:
| Environment | Purpose |
|---|---|
| Mock / Emulation | Initial familiarisation with the API structure and validation of the basic integration logic |
| Sandbox / Test environment | Full integration testing in conditions close to the production environment |
| Live / Production environment | Processing of real operations after testing is completed and readiness is approved |
The availability of specific environments and the procedure for obtaining access are defined separately for each API.
Connectivity and security
All UKRCARD APIs use secure HTTPS communication and client certificate authentication.
Connection parameters, service URLs, certificate usage requirements, and available network access channels may differ depending on the API.
Detailed connection information is provided in the relevant API documentation section:
WSGATE (Payments API) → Connectivity and mTLS certificates;
UAPI (Cards & Accounts API) → Connectivity and mTLS certificates.
Additional materials
The documentation for each API may also include:
▪️ method descriptions;
▪️ request and response examples;
▪️ integration recipes;
▪️ response code references;
▪️ recommendations for processing webhook / callback notifications.
Products
 |
E-Commerce AcquiringActive These APIs allow for processing payments in a flexible and customizable manner, ideal for users who want full control over their checkout flow. Postman collection > API Reference > Download PDF documentation > |
 |
TransfersActive These APIs helps you to provide users with the ability to send money to each other, also it allows you to accept transfers or debiting of funds for their cards. Postman collection > API Reference > Download PDF documentation > |
| Anti-money laundering serviceIn іmprovement This service provides аn adaptive, comprehensive approach that goes beyond traditional transaction monitoring to reduce the risk of money laundering, keep operational costs in check and ensure regulatory compliance. Postman collection > API Reference > Download PDF documentation > |
|
 |
Tokenized paymentsActive These API methods allow your customers to make online payments without using bank cards, utilizing digital wallets as a payment method. Postman collection > API Reference > Download PDF documentation > |
 |
Cards and accounts (UAPI)Active These APIs to build card products in accordance with their requirements, issues cards, manage them through an end-to-end card lifecycle, control card limits and authorize transactions. Postman collection > API Reference > Download PDF documentation > |