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 Contact your key account manager at Monetix for the information
Payment currencies EUR, RUB, USD
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
Cryptocurrencies supported for purchase:
  • Bitcoin
  • Tronix
  • Ether
  • Litecoin
  • Binance Coin
  • Dai on ERC20 and BEP20 blockchains
  • Tether on ERC20 and TRC20 blockchains

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 Gate

General information

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

  1. Send a request with all the required parameters and signature to the Monetix URL.
  2. Show the screen with payment instructions to the customer.
  3. Accept the callback with the purchase result from the payment platform.

The following figure provides the details of the purchase processing flow in the Crypto payment method.

Figure 1. Purchase processing flow when performing a purchase by using Gate
  1. The customer initiates a purchase in your system.
  2. Your system sends the purchase request to the Monetix payment platform.
  3. 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.)
  4. The payment platform processes the request and forwards it to the provider service.
  5. The provider service generates the payment instructions to show to the customer and sends them to the payment platform.
  6. The payment platform forwards the instructions to your system in the display_data array.
  7. Your system displays the payment instructions to the customer.
  8. The customer completes the purchase.
  9. The provider service informs the payment platform about the purchase result.
  10. The payment platform sends the callback with the payment result to your system.
  11. 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 Crypto payment method.

HTTP request method POST
Request body format JSON
API endpoint /v2/payment/crypto/sale
Table 1. Basic parameters of a purchase request

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.
ObjectParameterDescription

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

payment
object
strictly required

currency
string
strictly required

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

Example: EUR

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 codes.

Example: 100.00 EUR must be sent as 10000

crypto_currency
string
optional

Cryptocurrency code (ticker). May be passed in the request along with the crypto_payway parameter to preselect the cryptocurrency for the customer. If not passed, the customer will have to choose the cryptocurrency themselves while making the payment. Reach out to your key account manager at Monetix to find out whether cryptocurrency preselection is available in your case.

Possible values:

  • BTC—for the Bitcoin cryptocurrency
  • TRX—for the Tronix cryptocurrency
  • ETH—for the Ether cryptocurrency
  • LTC—for the Litecoin cryptocurrency
  • BNB—for the Binance Coin cryptocurrency
  • DAI—for the Dai cryptocurrency
  • USDT—for the Tether cryptocurrency

Example: USDT

crypto_payway
string
optional

Cryptocurrency blockchain. May be passed in the request along with the crypto_currency parameter to preselect the cryptocurrency for the customer. If not passed, the customer will have to choose the cryptocurrency themselves while making the payment. Reach out to your key account manager at Monetix to find out whether cryptocurrency preselection is available in your case.

Possible values:

  • BITCOIN—when submitting the Bitcoin cryptocurrency
  • TRON—when submitting the Tronix and Tether cryptocurrency
  • ETHEREUM—when submitting the Ether and Tether cryptocurrency
  • LITECOIN—when submitting the Litecoin cryptocurrency
  • BSC—when submitting the Binance Coin and Dai cryptocurrency
  • ERC20—when submitting the Tether cryptocurrency
  • TRC20—when submitting the Tether cryptocurrency

Example: TRC20

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

Figure 2. 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": "EUR",
        "amount": 10000,
        "crypto_currency": "USDT",
        "crypto_payway": "TRC20"
    }
}

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 2. Description of the display_data array
Element Description 
{ 
	"type": "add_info", 
	"title": "init_amount", 
	"data": "10000"
 }
 Purchase amount specified in your request.

Example: 10000

 
{ 
	"type": "add_info", 
	"title": "init_currency", 
	"data": "EUR"
 }
 Purchase currency specified in your request.

Example: EUR

 
{ 
	"type": "add_info", 
	"title": "crypto_amount", 
	"data": "0.003972"
 }
 Purchase amount converted to cryptocurrency.

Example: 0.003972

 
{ 
	"type": "add_info", 
	"title": "crypto_currency", 
	"data": "BTC (bitcoin)"
 }
 Cryptocurrency of the purchase.

Example: BTC (bitcoin)

 
{ 
	"type": "add_info", 
	"title": "crypto_account", 
	"data": "bfqyjjcttjh7fhg5sl63652"
 }
 Account to be credited.

Example: bfqyjjcttjh7fhg5sl63652

 
{ 
	"type": "add_info", 
	"title": "payment_id", 
	"data": "312866350116803"
 }
 Operation ID.

Example: 312866350116803

 
{ 
	"type": "qr_data", 
	"title": "qr_data", 
	"data": "yt4352345675674677452345dfg"
 }
 Data to display the QR code to the customer.

Example: yt4352345675674677452345dfg

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": "init_amount", 
		"data": "10000" 
	}, 
	{ 
		"type": "add_info", 
		"title": "init_currency", 
		"data": "EUR" 
	}, 
	{ 
		"type": "add_info", 
		"title": "crypto_amount", 
		"data": "0.003972" 
	}, 
	{ 
		"type": "add_info", 
		"title": "crypto_currency", 
		"data": "BTC (bitcoin)" 
	}, 
	{ 
		"type": "add_info", 
		"title": "crypto_account", 
		"data": "bfqyjjcttjh7fhg5sl63652" 
	}, 
	{ 
		"type": "add_info", 
		"title": "payment_id", 
		"data": "312866350116803" 
	}, 
	{ 
		"type": "qr_data", 
		"title": "qr_data", 
		"data": "yt4352345675674677452345dfg" 
	} 
]

Callback

In the Crypto 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 3. 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": "crypto",
        "sum": {
            "amount": 10000,
            "currency": "EUR"
        },
        "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": "EUR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "EUR"
        },
        "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 4. 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": "crypto",
        "sum": {
            "amount": 10000,
            "currency": "EUR"
        },
        "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": "EUR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "EUR"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics