Ukrkart offers several environments
Production For real use |
Sandbox For testing and integration |
Mock server To study the operation of the methods |
Contact us
Contact us to register your interest in the Ukrcard platform.
|
We will contact you shortly to find out about:
We define the type of your integration
The type of integration with the Ukrcard API is determined by the chosen payment system, the way of interaction with merchants, their customers and card systems. We use this information to choose the optimal type of integration.
If you plan to collect customer card data in your environment and send it to our API, you should ensure that your components are PCI DSS compliant.
If this is not the case, we recommend that you use the Checkout pages of PSPs already integrated with us (list), which are ready-made payment processing solutions without the need to process or store payment information, or use our own Checkout product.
INFO
Please note that PCI DSS compliance is required for using direct payments
Also at this stage, we help you decide on the scenario and choose the services you will need to use.
Access the test platform
You are assigned an external system ID, as well as a login and password, which you will use for each method API call.
Your service must work according to the HTTPS protocol, so you need to generate a TLS certificate. Procedure for generating Certificates:
INFO
A responsible person on your side must conduct the CSR generation.
Generation parameters:
Send CSR to email security@ukrcard.ua
Receive an archive containing the signed Certificate in response
Remove the Certificate from the archive and apply it when calling the methods
Develop your implementation
Checklist for creating integration with Ukrcard
On this resource you will find a detailed description of all the methods you need, with examples, and the ability to call methods through the MOCK server.
We also provide a ready-made Postman collection that simplifies testing of all our methods.
The download button below will download:
Submit a request for your real account
Configure your real account
Use interactive documentation
The interactive documentation allows you to view the API specification, view examples, test them in real time in a sandbox environment, and generate code snippets.
Ukrcard wsGate
API Method name | Description | Comment |
---|---|---|
Payment | E-commerce purchases | |
Preauthorization | Order registration with pre-authorization | |
Completion | Completion of payment before the pre-authorized order | |
CancelPreauthorization | Canceling a previously pre-authorized order | |
Confirm | Request status of operation | |
ConfirmExt | Request to receive the advanced status of the operation | |
Reverse | Reverse of paid order | |
Refund | Refund of paid order | |
Verify | Authentication confirmation (for Prostir) |
API Method name | Description | Comment |
---|---|---|
р2рTransfer | Execution of the transfer | It is used to perform: - standard p2p translation; - transfer to an account - Card-2-Account (C2A); - credit part of the transfer - Account-2-Card (A2C). |
Confirm | Request status of operation | |
ConfirmExt | Request to receive the advanced status of the operation | |
Reverse | Reverse of paid order | |
Refund | Refund of paid order | |
Verify | Authentication confirmation (for Prostir) |
API Method name | Description | Comment |
---|---|---|
API Method name | Description | Comment |
---|---|---|
The following mechanisms are used for access control and authorization:
Access parameters should be passed in the following headers:
Header name | Comment |
ExtSystemId | Identifier of the external system (ES) |
login | ES login in the wsGate system, received from UKRKARD when connecting to the API |
password | ES password in the wsGate system, received from UKRKARD when connecting to the API |
An example of an HTTP request with access parameters:
curl -v \
--request POST \
--url https://pre-wsgate.ukrcard.com.ua/ConfirmExt \
--cert ECOM_cert.pem \
--key ECOM_key.pem \
--header 'Host: pre-wsgate.ukrcard.com.ua' \
--header 'Content-Type: application/json' \
--header 'ExtSystemid: ECOM' \
--header 'login: ECOM' \
--header 'password: ECOM*' \
--header 'orderNumber: 3' \
--header 'RegDate: 2024-03-12 12:16:00' \
--header 'x-uws-clientdn: TestPay_ECOM' \
--header 'Accept: application/json' \
-d @- \
<< EOF
{"pageData":{"language":"uk"}}