Scenario 2. Purchase with payment instructions
When performing a purchase, the customer follows the payment instructions displayed on the checkout page or in your system (when performing the purchase by using Gate).
Countries and regions | Azerbaijan, Kazakhstan, Russian Federation, Uzbekistan |
Payment currencies | AZN, KZT, RUB, UZS |
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
|
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 Payments by card-to-card money transfer via partner 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 Payments by card-to-card money transfer via partner payment method.
- 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 Payments by card-to-card money transfer via partner payment method.
- The payment platform forwards the request to the provider service.
- The provider service generates the payment instructions to show to the customer and sends them to the payment platform.
- The checkout page displays the payment instructions to the customer.
- The customer completes 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 need to include in the request for purchase through the checkout page with the Payments by card-to-card money transfer via partner payment method.
|
||
---|---|---|
Parameter | Description | |
project_id | Project ID you obtained from Monetix when integrating. Example: | |
payment_id | Payment ID unique within your project. Example: | |
customer_id | Unique ID of the customer within your project. Example: | |
customer_first_name | Customer's first name. Example: | |
customer_last_name | Customer's last name. Example: | |
customer_email | Customer's email. Example: | |
payment_currency | Code of the payment currency in the ISO-4217 alpha-3 format.
Example: | |
payment_amount | 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 codes. Example: 100.00 RUB must be sent as | |
force_payment_method | Parameter that allows you to enforce the Payments by card-to-card money transfer via partner payment method for your customer and skip the page with payment method selections. To enforce the Payments by card-to-card money transfer via partner payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to Example: | |
signature | 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: 10000, force_payment_method: 'card-p2p', signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg==' } )
You can enforce a bank for your customer on the checkout page. To do so, add the following parameters to the request for the checkout page opening:
Object/parameter | Parameter | Description |
---|---|---|
force_payment_method | Parameter that allows you to enforce the Payments by card-to-card money transfer via partner payment method for your customer and skip the page with payment method selections. Set the value of this parameter to Example: | |
payment_methods_options | banks_id | Customer's bank ID. Possible values:
Example: |
Here is an example of the data from the request to open the checkout page with a bank enforced for the customer:
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: 10000, force_payment_method: 'card-p2p', payment_methods_options: '{"banks_id": 69492}', signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg==' } )
Callback
In the Payments by card-to-card money transfer via partner payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Payment Page.
The following is an example of a callback body with information about a successfully completed purchase.
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "purchase",
"status": "success",
"date": "2024-12-07T19:08:45+0000",
"method": "card-p2p",
"sum": {
"amount": 10000,
"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": 10000,
"currency": "RUB"
},
"sum_converted": {
"amount": 10000,
"currency": "RUB"
},
"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.
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "purchase",
"status": "decline",
"date": "2024-12-07T19:08:45+0000",
"method": "card-p2p",
"sum": {
"amount": 10000,
"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": 10000,
"currency": "RUB"
},
"sum_converted": {
"amount": 10000,
"currency": "RUB"
},
"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 Payments by card-to-card money transfer via partner payment method:
- Send a request with all the required parameters and signature to the Monetix URL.
- Show the screen with payment instructions 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 Payments by card-to-card money transfer via partner payment method.
- 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.)
- The payment platform processes the request and forwards it to the provider service.
- The provider service generates the payment instructions to show to the customer and sends them to the payment platform.
- The payment platform forwards the instructions to your system in the display_data array.
- Your system displays the payment instructions to the customer.
- The customer completes 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 Payments by card-to-card money transfer via partner payment method.
HTTP request method | POST |
Request body format | JSON |
API endpoint | /v2/payment/card-p2p/sale |
|
|||
---|---|---|---|
Object | Parameter | Description | |
general | project_id | Project ID you obtained from Monetix when integrating. Example: | |
payment_id | Payment ID unique within your project. Example: | ||
signature | Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification. | ||
customer | id | Unique ID of the customer within your project. Example: | |
ip_address | IP address of the customer's device. Example: | ||
first_name | Customer's first name. Example: | ||
last_name | Customer's last name. Example: | ||
email | Customer's email. Example: | ||
account | bank_id | Customer's bank ID. For information on how to get the list of the supported banks IDs, see Banks available for purchase. Example: | |
payment | currency | Code of the payment currency in the ISO-4217 alpha-3 format. Example: | |
amount | 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 codes. Example: 100.00 RUB must be sent as | ||
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 Payments by card-to-card money transfer via partner payment method:
{ "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": { "bank_id": 69492 }, "payment": { "currency": "RUB", "amount": 10000 } }
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.
Each element of this array contains the following parameters:
- type—element type. its value is always
add_info
. - title—name of the payment instruction data, can take one the following values:
- receiver_name—payment recipient's full name
- receiver_account—payment recipient's card number
- bank_name—payment recipient's bank name
- amount—purchase amount in minor currency units without any decimal point or comma
- currency—code of the purchase currency in the ISO-4217 alpha-3 format
- lifetime—lifetime of the payment instructions (in seconds)
- data—payment instruction data
Here is an example of the callback snippet with the data for displaying the payment instructions to the customer.
"display_data": [ { "type": "add_info", "title": "receiver_name", "data": "Mark Doe" }, { "type": "add_info", "title": "receiver_account", "data": "1234567890123456" }, { "type": "add_info", "title": "bank_name", "data": "Sberbank" }, { "type": "add_info", "title": "amount", "data": 10000 }, { "type": "add_info", "title": "currency", "data": "RUB" }, { "type": "add_info", "title": "lifetime", "data": 1200 } ]
Here are examples of payment instructions that you can display to the customer in your system:
Instruction text in Azerbaijani | Instruction text in Kazakh |
---|---|
Depozitinizi kreditləşdirmək üçün bir ödənişlə karta köçürmə edin. Əks təqdirdə, ödənişinizi müəyyənləşdirə bilməyəcəyik. Təfərrüatlar hər ödənişlə dəyişir. |
Депозитіңізді есепке алу үшін картаға бір төлеммен аударым жасаңыз. Әйтпесе, біз сіздің төлеміңізді анықтай алмаймыз. Деректемелер әр төлем сайын өзгереді. |
Instruction text in Russian | Instruction text in Uzbek |
---|---|
Для зачисления вашего депозита совершите перевод на карту одним платежом. В противном случае мы не сможем идентифицировать ваш платеж. Реквизиты меняются с каждым платежом. |
Depozitingizni kreditlash uchun kartaga bitta to'lov bilan pul o'tkazmasini amalga oshiring. Aks holda, biz sizning to'lovingizni aniqlay olmaymiz. Tafsilotlar har bir to'lov bilan o'zgaradi. |
Callback
In the Payments by card-to-card money transfer via partner 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.
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "purchase",
"status": "success",
"date": "2024-12-07T19:08:45+0000",
"method": "card-p2p",
"sum": {
"amount": 10000,
"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": 10000,
"currency": "RUB"
},
"sum_converted": {
"amount": 10000,
"currency": "RUB"
},
"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.
{
"project_id": 1234,
"payment": {
"id": "payment_47",
"type": "purchase",
"status": "decline",
"date": "2024-12-07T19:08:45+0000",
"method": "card-p2p",
"sum": {
"amount": 10000,
"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": 10000,
"currency": "RUB"
},
"sum_converted": {
"amount": 10000,
"currency": "RUB"
},
"code": "20000",
"message": "General decline",
"provider": {
"id": 12345,
"payment_id": "123abc123-123",
"auth_code": ""
}
},
"signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}
Banks available for purchase
Supported banks
In the Payments by card-to-card money transfer via partner payment method, payments are performed through the banks the payment method supports. For the purchase to be performed, your request must contain the ID of the customer's bank in the account.bank_id parameter.
The table below lists the banks available for purchase in the Payments by card-to-card money transfer via partner payment method.
Bank | ID |
---|---|
SberBank | 69492 |
T-Bank | 69502 |
Kapital Bank (payments in AZN) | 69532 |
Kapitalbank (payments in UZS) | 69552 |
Kaspi Bank | 69542 |
The table with the list of banks is provided for informational purposes only. It may change without notice. To get the current list of banks the Payments by card-to-card money transfer via partner payment method supports, send a request to the payment platform.
Request for the list of available banks
This section provides the instructions on how to build the request for the list of banks supported in the Payments by card-to-card money transfer via partner payment method.
HTTP request method | POST |
Request body format | JSON |
API endpoint |
/v2/info/banks/card-p2p/sale/list
|
Full API endpoint specification | /v2/info/banks/{payment_method}/{operationType}/list |
|
|||
---|---|---|---|
Object | Parameter | Description | |
general |
project_id |
Project ID you obtained when integrating with Monetix.
Example: |
|
payment_id |
Payment ID unique within the project.
If the payment is not yet created, set this parameter to a unique value. Example: |
||
signature |
Signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification. | ||
payment |
amount |
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 codes. Example: 100.00 RUB must be sent as |
|
currency |
Code of the purchase currency in the ISO-4217 alpha-3 format.
Example: |
||
You can also add any other optional parameters to the request, if necessary. For the list of all the parameters available in Gate, see API Reference. |
Here is an example of the data from the request for the list of banks available in the Payments by card-to-card money transfer via partner payment method.
{ "general": { "project_id": 200, "payment_id": "ORDER_155860015", "signature": "K6jll2ym+PtOb3ocZtr345st...==" }, "payment": { "amount": 10000, "currency": "RUB" } }
[ { "minAmount": 100, // Minimum payment amount allowed for the payment (in minor currency units) "maxAmount": 1000, // Maximum payment amount allowed for the payment (in minor currency units) "limitCurrency": "RUB", // Code of the currency used for the payment limits (minAmount and maxAmount) in the ISO-4217 alpha-3 format "id": 123, // Bank ID "abbr": "EXB", // Bank shortcut name (for internal use) "name": "Example Bank", // General bank name "nativeName": "Example Bank", // Native bank name "currencies": [ // Array with currencies supported by the bank { "id": 123, // Currency ID in the payment platform "alpha_3_4217": "RUB", // Alphabetic code of the payment currency in the ISO-4217 alpha-3 format "number_3_4217": "123", // Numeric code of the payment currency in the ISO-4217 alpha-3 format "currency_type": "fiat", // Type of the currency "exponent": 2 // Number of decimal places after decimal point } ] } ]