WebMoney - Purchase 1: via an invoice

When performing a purchase, the customer completes the purchase via an invoice displayed on the checkout page or in your system (when performing the purchase by using Gate).


Countries and regions	All countries
Payment currencies	WMZ (USD), WME (EUR)
Payment amount limits	Contact your key account manager at Monetix 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 Monetix for details.
Currency conversion	On the Monetix side
Refund
Onboarding and access fee	Contact your key account manager at Monetix for details.
Special considerations In this purchase scenario customer uses the WebMoney service independently in order to pay an invoice. In the WebMoney service, payment currencies are title units that are national currency equivalents. Title units are kept track of in their WM wallets. In this purchase scenario, on the Payment Page purchase amounts are displayed in both title units and national currencies. However only national currencies are used for requests and response parameters. When performing a purchase using this scenario, you can set the invoice validity period and perform refunds. Each of the WebMoney service member has a WM passport, which is a digital certificate issued based on the personal data provided by the member. Maximum amount limits may vary depending on the type of WM passport.

Operations support


	Interfaces
	Payment Page	Gate	Dashboard
Purchase
Refund

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 WebMoney payment method:

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

The following figure shows the complete purchase processing flow in the WebMoney 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 Monetix URL.
The checkout page is displayed to the customer.
The customer chooses to make a purchase with the WebMoney payment method.
Your system displays a notification saying that the customer is required to visit the WebMoney service and pay the invoice.
The payment platform performs the internal purchase request processing and sends it to the provider service.
The provider service performs purchase request processing and issues the invoice, and sends a response containing invoice issuing confirmation.
The customer uses the WebMoney service to pay the invoice.
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 WebMoney 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 Monetix 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.

Example: RUB

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: 1.00 RUB must be sent as 100

force_payment_method
string
optional

Parameter that allows you to enforce the WebMoney payment method for your customer and skip the page with payment method selections.

To enforce the WebMoney payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to webmoney. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'webmoney'

payment_description
string
strictly required

Payment description should be specified in the request as follows: Top-up of personal account №<customer's bank account number> on the website <URL of the your system>.

Example: Top-up of personal account №<01234567890> on the website <https://merchant.example.com>.

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 Payment Page invocation parameters.

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: 'RUB',
		payment_amount: 100,
		force_payment_method: 'webmoney',
		payment_description: 'Top-up of personal account №<01234567890> on the website <https://merchant.example.com>.',
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=='
	}
)

Callback

In the WebMoney payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Payment Page.

In the WebMoney method, the callbacks include the payment ID that is generated by the WebMoney service and is passed in the payment_id parameter of the provider object. The successful payout callbacks always contain the payment_id parameter value, but the declined payout callbacks may not contain the parameter value.

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": "webmoney",
        "sum": {
            "amount": 100,
            "currency": "RUB"
        },
        "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": 100,
            "currency": "RUB"
        },
        "sum_converted": {
            "amount": 100,
            "currency": "RUB"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "123456789012"
    },
    "provider": {
        "payment_id": "WM-purchase-121"
    },
    "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": "webmoney",
        "sum": {
            "amount": 100,
            "currency": "RUB"
        },
        "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": 100,
            "currency": "RUB"
        },
        "sum_converted": {
            "amount": 100,
            "currency": "RUB"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "123456789012"
    },
    "provider": {
        "payment_id": "WM-purchase-121"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Testing

You can test payments with the WebMoney payment method by using Payment Page.

To start performing test payments, reach out to the Monetix (support@monetix.pro) support team to get the test project ID and a secret key to it and to set up the test environment for the payments to be performed with the WebMoney payment method.

When performing test payments, keep in mind that:

for the project ID you have to submit the ID of the test project
for the payment ID and customer's data you can submit any random values
the interface of the test checkout page may be different from the one Monetix provides you with.

Statuses of test payments

To receive a certain final status when performing test payments with the WebMoney payment method, your request has to contain a respective payment amount in it. The table below lists the payment amounts you can send in requests in order to get a certain status of a test payment.


Payment amount	Final status
40000 or 40400	decline—the payment is declined
Any other amount	success—the payment is successful. The payment amount passed to you in a callback matches the amount you submitted in the purchase request

Testing purchase by using Payment Page

To perform a test purchase by using Payment Page:

Send a request for opening the checkout page to the payment platform.
Choose the WebMoney payment method on the test checkout page. If your request contains the force_payment_method parameter with the webmoney value in it, there's no need to choose the payment method.
If necessary, specify any random values for the parameters you're requested to provide.
Wait for the payment instructions to be displayed to you.
Accept a callback containing the data about the result of performing a test payment.
Wait for a few seconds until the test checkout page displays the result of performing a test payment.

To learn more about performing purchases with the WebMoney payment method by using Payment Page, see the Purchase by using Payment Page section.

Purchase by using Gate

General information

To perform a purchase by using Gate with the WebMoney payment method:

Send a request with all the required parameters and signature to the Monetix URL.
Show the screen with a notification saying that the customer is required to visit the WebMoney service and pay the invoice.
Accept the callback with the purchase result from the payment platform.

The following figure provides the details of the purchase processing flow in the WebMoney 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 Monetix 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 structure.)
Your system displays a notification saying that the customer is required to visit the WebMoney service and pay the invoice.
The payment platform performs the internal purchase request processing and sends it to the provider service.
The provider service performs purchase request processing and issues the invoice, and sends a response containing invoice issuing confirmation.
The customer uses the WebMoney service to pay the invoice.
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 WebMoney payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	/v2/payment/webmoney/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 Monetix 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

account
object
strictly required

number
string
strictly required

Customer WMID that is the customer's ID in the WebMoney service.

Example: 123456789012

payment
object
strictly required

currency
string
strictly required

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

Example: RUB

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: 1.00 RUB must be sent as 100

description
string
strictly required

Payment description should be specified in the request as follows: Top-up of personal account №<customer's bank account number> on the website <URL of the your system>.

Example: Top-up of personal account №<01234567890> on the website <https://merchant.example.com>.

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 WebMoney 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"
    },
    "account": {
        "number": "123456789012"
    },
    "payment": {
        "currency": "RUB",
        "amount": 100,
        "description": "Top-up of personal account №<01234567890> on the website <https://merchant.example.com>."
    }
}

Callback

In the WebMoney payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Gate.

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": "webmoney",
        "sum": {
            "amount": 100,
            "currency": "RUB"
        },
        "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": 100,
            "currency": "RUB"
        },
        "sum_converted": {
            "amount": 100,
            "currency": "RUB"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "123456789012"
    },
    "provider": {
        "payment_id": "WM-purchase-121"
    },
    "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": "webmoney",
        "sum": {
            "amount": 100,
            "currency": "RUB"
        },
        "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": 100,
            "currency": "RUB"
        },
        "sum_converted": {
            "amount": 100,
            "currency": "RUB"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "123456789012"
    },
    "provider": {
        "payment_id": "WM-purchase-121"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Testing

You can test payments with the WebMoney payment method by using Gate.

When performing test payments, keep in mind that:

for the project ID you have to submit the ID of the test project
for the payment ID and customer's data you can submit any random values

Statuses of test payments


Payment amount	Final status
40000 or 40400	decline—the payment is declined
Any other amount	success—the payment is successful. The payment amount passed to you in a callback matches the amount you submitted in the purchase request

Testing purchase by using Gate

To perform a test purchase by using Gate:

Send a correct test request for purchase to the payment platform.
Accept a callback with the data for displaying payment instructions. Your system will display the payment instructions to you after.
Accept a callback containing the data about the result of performing a test payment.

To learn more about performing purchases with the WebMoney payment method by using Gate, see the Purchase by using Gate section.

Refund by using Gate

General information

To perform a refund by using Gate for a purchase made with the WebMoney payment method:

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

The following picture provides all the details of the refund processing flow in the WebMoney payment method.

Figure 8. Refund processing flow when performing a refund by using Gate

The customer initiates a refund in your system.
Your system sends the refund request to the Monetix 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 structure.)
The payment platform processes the request and forwards it to the provider service.
The provider service informs the payment platform about the refund result.
The payment platform sends you the callback with the refund result.
Your system sends the refund result to the customer.

Request

This section provides the instructions on how to build the request for refund with the WebMoney payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	/v2/payment/webmoney/refund

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.

Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

ID of the payment the refund is performed for

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.

payment
object
strictly required

currency
string
optional

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

This parameter is required when performing a partial refund.

Example: RUB

amount
integer
optional

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.

This parameter is required when performing a partial refund.

Example: 1.00 RUB must be sent as 100

description
string
strictly required

Refund description.

Example: Refund description.

You can also add any other optional parameters to the refund 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 refund with the WebMoney payment method:

Figure 9. Example of the refund request body

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "payment": {
        "currency": "RUB",
        "amount": 100,
        "description": "Refund."
    }
}

Callback

In the WebMoney payment method, the payment platform returns the refund result in a callback. For the information about the callback structure, see Callbacks in Gate.

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

Figure 10. Example of the body of a successful refund callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "refunded",
        "date": "2024-12-07T19:08:45+0000",
        "method": "webmoney",
        "sum": {
            "amount": 0,
            "currency": "RUB"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "refund",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 100,
            "currency": "RUB"
        },
        "sum_converted": {
            "amount": 100,
            "currency": "RUB"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "123456789012"
    },
    "provider": {
        "payment_id": "WM-purchase-121"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure 11. Example of the data from a declined refund callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "webmoney",
        "sum": {
            "amount": 100,
            "currency": "RUB"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "refund",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 100,
            "currency": "RUB"
        },
        "sum_converted": {
            "amount": 100,
            "currency": "RUB"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "123456789012"
    },
    "provider": {
        "payment_id": "WM-purchase-121"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Testing

You can test refunds with the WebMoney payment method by using Gate.

To start performing test refunds, reach out to the Monetix (support@monetix.pro) support team to get the test project ID and a secret key to it and to set up the test environment for the refunds to be performed with the WebMoney payment method.

When performing test refunds, keep in mind that:

for the project ID you have to submit the ID of the test project
for the payment ID and customer's data you can submit any random values

Statuses of test refunds

To receive a certain final status when performing test refunds with the WebMoney payment method, your request has to contain a respective payment amount in it. The table below lists the refund amounts you can send in requests in order to get a certain status of a test refund.


Refund amount	Final status
50000 or 50500	decline—the refund is declined
Any other amount	success—the refund is successful

Testing refund by using Gate

To perform a test refund by using Gate:

Send a correct test request for refund to the payment platform.
Accept a callback containing the data about the result of performing a test refund.

To learn more about performing refunds with the WebMoney payment method by using Gate, see the Refund by using Gate section.

WebMoney - Purchase 1: via an invoice

Operations support

Purchase by using Payment Page

General information

Request

Callback

Testing

Related topics

Purchase by using Gate

General information

Request

Callback

Testing

Related topics

Refund by using Gate

General information

Request

Callback

Testing

Related topics