Open Banking

Initial request

The request contains certain fields:

Field	Description
merchant	unique merchant identifier;
order	transaction number in the merchant system;
amount	transaction amount in the currency, separator character is a point “.”;
currency	transaction currency, possible value: EUR;
item_name	product name;
first_name	customer’s first name (maximum length: 30 characters, Latin letters only);
last_name	customer’s surname (Only latin chars are available);
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;
email	customer's e-mail;
bank_id	used to transmit the bank identifier, which returns a link to the corresponding bank’s payment page. This parameter is optional. If provided, the payment link will be generated for the specified bank. Download the list of bank identifiers;

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": "EUR",
  "item_name": "Samsung TV",
  "first_name": "IVAN",
  "last_name": "IVANOV",
  "payment_url": "https://test.com",
  "country": "BG",
  "email": "test@gmail.com",
  "bank_id": "revolut_eu"
}

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": "EUR",
  "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": "EUR",
  "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.