SSIS RASCHET (ERIP) - Purchase

When performing a purchase, the customer scans the QR code or clicks the button on the checkout page or in your system (when performing the purchase by using Gate). After that, the customer is redirected to mobile app to complete the purchase.


Countries and regions	Belarus
Payment currencies	BYN
Payment amount limits	Contact your key account manager at EtoPlatezhi for details. Also you can check the payment amount limits in your project by using Dashboard.
Payment processing time	Contact your key account manager at EtoPlatezhi for details.
Currency conversion
Refund
Onboarding and access fee	Contact your key account manager at EtoPlatezhi for details.
Special considerations The currency of the payment can be only BYN. The list of supported banks can be found on the SSIS wewbsite or by contacting your key account manager EtoPlatezhi. When using requests through Gate, your system must add the bank's URL to the link received in the intermediate callback (deep_link).

Operations support


	Interfaces
	Payment Page	Gate	Dashboard
Purchase

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section, and then click the Payment methods tab.

The following sections provide more information about the payment processing flow and the analysis of completed payments.

Purchase by using Payment Page

General information

To perform a purchase by using Payment Page with the SSIS RASCHET (ERIP) payment method:

Send a request with all the required parameters and signature to the EtoPlatezhi URL.
Accept the callback with the purchase result from the payment platform.

The following figure shows the complete purchase processing flow in the SSIS RASCHET (ERIP) payment method.

Figure 1. Purchase processing steps for a purchase by using Payment Page

The customer initiates a purchase in your system.
Your system sends the request for the purchase through Payment Page to the EtoPlatezhi URL.
The checkout page is displayed to the customer.
The customer chooses to make a purchase with the SSIS RASCHET (ERIP) payment method.
The checkout page displays the buttons for customer redirection along with the QR code to the customer.
The customer scans the QR code or clicks the button. After that, the customer is redirected to mobile app to complete the purchase.
The provider service sends the purchase result information to the payment platform.
The payment platform sends a callback with the payment result to your system.
The payment platform displays the payment result to the customer on the checkout page.

Request

The following table lists the parameters that you have to include in the request for purchase through the checkout page with the SSIS RASCHET (ERIP) payment method.

strictly required—the parameter must be in the initial request.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.

Parameter Description

project_id
integer
strictly required

Project ID you obtained from EtoPlatezhi when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

customer_id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

customer_first_name
string
strictly required

Customer's first name.

Example: John

customer_last_name
string
strictly required

Customer's last name.

Example: Doe

customer_email
string
strictly required

Customer's email.

Example: johndoe@example.com

payment_currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

The currency of the payment can be only BYN.

Example: BYN

payment_amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency units and Currency codes.

Example: 10.00 BYN must be sent as 1000

force_payment_method
string
optional

Parameter that allows you to enforce the SSIS RASCHET (ERIP) payment method for your customer and skip the page with payment method selections.

To enforce the SSIS RASCHET (ERIP) payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to erip. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'erip'

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

You can also add any other optional parameters to the request, if necessary. For the list of all the parameters possible in requests to Payment Page, see Parameters for opening the payment form.

Here is an example of the data from a request to open the checkout page by using EPayWidget:

EPayWidget.run(
	{
		project_id: 1234,
		payment_id: 'payment_47',
		customer_id: 'customer_123',
		customer_first_name: 'John',
		customer_last_name: 'Doe',
		customer_email: 'johndoe@example.com',
		payment_currency: 'BYN',
		payment_amount: 1000,
		force_payment_method: 'erip',
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=='
	}
)

Callback

In the SSIS RASCHET (ERIP) payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks.

The following is an example of a callback body with information about a successfully completed purchase.

Figure 2. Example of the data from a successful purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "erip",
        "sum": {
            "amount": 1000,
            "currency": "BYN"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 1000,
            "currency": "BYN"
        },
        "sum_converted": {
            "amount": 1000,
            "currency": "BYN"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 3. Example of the data from a declined purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "erip",
        "sum": {
            "amount": 1000,
            "currency": "BYN"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 1000,
            "currency": "BYN"
        },
        "sum_converted": {
            "amount": 1000,
            "currency": "BYN"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Purchase by using Gate

General information

To perform a purchase by using Gate with the SSIS RASCHET (ERIP) payment method:

Send a request with all the required parameters and signature to the EtoPlatezhi URL.
Show the screen with the mobile app buttons and the QR code to the customer.
Accept the callback with the purchase result from the payment platform.

The following figure provides the details of the purchase processing flow in the SSIS RASCHET (ERIP) payment method.

Figure 4. Purchase processing flow when performing a purchase by using Gate

The customer initiates a purchase in your system.
Your system sends the purchase request to the EtoPlatezhi payment platform.
The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response format.)
The payment platform forwards the app deep links and the QR code to your system in the display_data array.
Your system displays the buttons for customer redirection along with the QR code to the customer.
The customer scans the QR code or clicks the button. After that, the customer is redirected to mobile app to complete the purchase.
The provider service informs the payment platform about the purchase result.
The payment platform sends the callback with the payment result to your system.
Your system sends the payment result to the customer.

Request

This section provides the instructions on how to build the request for purchase with the SSIS RASCHET (ERIP) payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	/v2/payment/erip/sale

strictly required—the parameter must be in the initial request.

Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from EtoPlatezhi when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

IP address of the customer's device.

Example: 198.51.100.47

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

email
string
strictly required

Customer's email.

Example: johndoe@example.com

payment
object
strictly required

currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

The currency of the payment can be only BYN.

Example: BYN

amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

Example: 10.00 BYN must be sent as 1000

You can also add any other optional parameters to the purchase request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a purchase with the SSIS RASCHET (ERIP) payment method:

Figure 5. Example of the purchase request body

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "payment": {
        "currency": "BYN",
        "amount": 1000
    }
}

Displaying the payment instructions to the customer

After receiving and processing your purchase request, the payment platform sends you the callback with the data for displaying the payment instructions to the customer.

Use the data from the display_data array to display the payment instructions to the customer.

Table 3. Description of the display_data array
Element	Description
{ "type": "qr_img", "title": "qr_img", "data": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAALIAAACyAQA=" }	The data that should be displayes as the QR code. Example: `data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAALIAAACyAQA=`
{ "type": "deep_link", "title": "deep_link", "data": "MDAwMjAxMDEwMjEyMzI1N..." }	The end of the link (URL) for opening the provider mobile app for payment. The initial part of the link, which includes the URL of the required bank, must be preppended by your system. Example: `MDAwMjAxMDEwMjEyMzI1N...`

The following is the callback fragment containing display_data array.

"display_data": [
    {
        "type": "qr_img",
        "title": "qr_img",
        "data": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAALIAAACyAQA="
    },
    {
        "type": "deep_link",
        "title": "deep_link",
        "data": "MDAwMjAxMDEwMjEyMzI1N..."
    }
]

Callback

In the SSIS RASCHET (ERIP) payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks.

The following is an example of a callback body with the information about a successfully completed purchase.

Figure 6. Example of the data from a successful purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "erip",
        "sum": {
            "amount": 1000,
            "currency": "BYN"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 1000,
            "currency": "BYN"
        },
        "sum_converted": {
            "amount": 1000,
            "currency": "BYN"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 7. Example of the data from a declined purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "erip",
        "sum": {
            "amount": 1000,
            "currency": "BYN"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 1000,
            "currency": "BYN"
        },
        "sum_converted": {
            "amount": 1000,
            "currency": "BYN"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

SSIS RASCHET (ERIP) - Purchase

Operations support

Purchase by using Payment Page

General information

Request

Callback

Related topics

Purchase by using Gate

General information

Request

Displaying the payment instructions to the customer

Callback

Related topics