Bank Cards¶

Initial request¶

The request contains certain fields:¶

Field	Description
`merchant`	unique merchant ID;
`order`	transaction number in the merchant system;
`amount`	transaction amount in the currency, separator character is a point “.”;
`currency`	transaction currency, may take UAH, USD, EUR, KZT, BRL, MXN, INR and AZN;
`item_name`	goods name;
`first_name`	customer’s name. Maximum length is 30 characters (Only latin chars are available);
`last_name`	customer’s surname (Only latin chars are available);
`user_id`	client identifier in the merchant's system (the field is not required);
`payment_url`	url address of the site in whose favor the payment is made;
`country`	customer’s country in the ISO 3166-1 alpha-2 format;
`ip`	customer's IP address;
`custom`	for additional information about the customer;
`email`	customer's e-mail;
`phone`	customer's phone number;
`address`	customer's address;
`city`	customer's city;
`post_code`	customer's post code;
`region`	customer's region;
`lang`	language (added on 19.03.2025) in which the payment form will be displayed: en – English ua – Ukrainian kk – Kazakh

The fields process_url, success_url, fail_url (where the client will be redirected after the payment will be redirected to after the payment is made) do not have to be passed. These data are automatically taken from merchant settings in your personal cabinet.

Important

The query strings must contain only Latin letters and numbers.

GET /payment/form

https://<provided url>/payment/form

Example:

application/json

{
  "merchant": "M1VJDHSI6DYXS",
  "order": "0001",
  "amount": "16",
  "currency": "UAH",
  "item_name": "Samsung TV",
  "first_name": "IVAN",
  "last_name": "IVANOV",
  "user_id": "492235",
  "payment_url": "https://test.com",
  "country": "UA",
  "ip": "212.10.20.75",
  "custom": "",
  "email": "test@gmail.com",
  "phone": "+35988222763",
  "address": "Avenue Marius Renard 21",
  "city": "Anderlecht",
  "post_code": "1070",
  "region": "stuttgart",
  "lang": "en"
}

Customer redirection after making a payment¶

Warning

Direction of the buyer to success_url or fail_url is only informational and CAN NOT confirm the success or rejection of payment!

After making a payment, the customer is redirected to success_url or fail_url.

The response contains the fields:¶

Field	Description
`order_no`	transaction number in the merchant system (the same as in the `order` request);
`amount`	transaction amount in the currency, separator character is a point “.”;
`currency_code`	transaction currency (in which the invoice was formed);
`item_name`	goods name (if it was transferred);
`co_inv_id`	unique transaction number;
`co_inv_st`	transaction status in the payment system (Success or Canceled).

Example of the response in case of successful payment acceptance for processing:

application/json

{
  "order_no": "0001",
  "amount": "16",
  "currency_code": "UAH",
  "item_name": "Samsung TV",
  "co_inv_id": "1111111",
  "co_inv_st": "success"
}

Example of the response in case of payment cancellation:

application/json

{
  "order_no": "0001",
  "amount": "16",
  "currency_code": "UAH",
  "item_name": "Samsung TV",
  "co_inv_id": "1111111",
  "co_inv_st": "Canceled"
}

Final Status (Callback)¶

The callback mechanism is used to notify the merchant that the transaction has received a final status (for example, from “Pending” to “Success”).

It is described in detail in the Callbacks section.