Binance Pay

Overview


Binance Pay is a payment method which allows you to accept payments from your customers and perform payouts to them. Customers make purchases by using QR codes. With the Binance Pay payment method, you can accept payments from your customers by using Payment Page and Gate and perform payouts and refunds to them by using Gate and Dashboard. Download the logo in the vector format here.


Payment method type	QR code payments
Countries and regions	Global, except: American Samoa, Australia, Guam, Indonesia, New Zealand, Northern Mariana Islands, Philippines, Puerto Rico, Singapore, Syrian Arab Republic, Thailand, Ukraine, United States Minor Outlying Islands, Viet Nam, Virgin Islands (U.S.), Malaysia, United Arab Emirates, United Kingdom of Great Britain and Northern Ireland, and the countries in the Binance List of Prohibited Countries.
Payment currencies	All currencies except ARS, EGP, GHS, KES, NGN, RWF, TZS, UGX, XAF, XOF, ZAR.
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
Purchase
Payout
Stored credentials payments
Refund
Special considerations	The QR code is valid only for 20 minutes. In EU countries payout is performed in USDC. In other countries it's performed in USDT.
Onboarding and access fee	Contact your key account manager at Monetix for details.

Operations support


	Interfaces
	Payment Page	Gate	Dashboard
Purchase
Refund
Payout

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 Binance Pay 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 Binance Pay 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 Binance Pay payment method.
The payment platform processes the request and forwards it to the provider service.
The provider service generates and sends the payment QR code data to the payment platform.
The checkout page displays the QR code 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 Binance Pay 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: EUR

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

Example: 100.00 EUR must be sent as 10000

force_payment_method
string
optional

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

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

Example: force_payment_method: 'unify_Binance_Pay'

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.

recurring
string
optional

Add this parameter if you need to register the COF purchase and set its value to the URL-encoded JSON object with the COF purchase parameters. Here is an example of such a JSON object (before URL-encoding):

{"register":true}

For more information on how to register COF purchase through Payment Page, see COF purchase registration.

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: 123, 
        payment_id: 'payment_47', 
        customer_id: 'customer_123',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        card_holder: 'Doe',    
        customer_email: 'johndoe@example.com',
        payment_currency: 'EUR', 
        payment_amount: 10000,
        force_payment_method: 'unify_Binance_Pay',
        recurring: '%7B%22register%22%3Atrue%7D',
        signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO\/RLUkDJrOcZzUCwX6R'
    }
)

Callback

In the Binance Pay 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.

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": "unify",
        "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 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": "unify",
        "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=="
}

Purchase by using Gate

General information

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

Send a request with all the required parameters and signature to the Monetix URL.
Show the screen with a payment 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 Binance Pay 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.)
The payment platform processes the request and forwards it to the provider service.
The provider service generates and sends the payment QR code data to the payment platform.
The payment platform sends the data to your system in the display_data array.
Your system displays the QR code 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 Binance Pay payment method.


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

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

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.

Example: 100.00 EUR must be sent as 10000

by_method
string
strictly required

The payment method's code. Pass BinancePay in this parameter.

Example: BinancePay

return_url
object
optional

success
string
optional

The URL to redirect the customer to after the payment is successfully completed.

Example: https://example.com/success/

decline
string
optional

The URL to redirect the customer to after the payment is declined.

Example: https://example.com/decline/

return
string
optional

The URL to redirect the customer to when they prematurely terminate the payment. This URL is also used if the success and decline parameters are not specified in the request. If you don't specify any parameters of the return_url object in the request, by default Gate will redirect the customer to the URL specified in your project in Monetix.

Example: https://example.com/return/

recurring
object
optional

COF purchase registration flag; use true value to have a COF purchase registered. For more information on how to register a COF purchase through Gate, see Registering COF purchase.

Example: true

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 Binance Pay 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": "EUR",
        "amount": 10000,
        "by_method": "BinancePay"
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    },
    "recurring": {
        "register": true
    }
}

Displaying the payment QR code to the customer

After receiving and processing your purchase request, the payment platform will send you a callback with the data for displaying the payment QR code to the customer. To display the QR code, use the data from the display_data array.

There are two ways the display_data array can be structured. All of them are described below. Ask your key account manager at Monetix which option is relevant to you.

Table 3. Description of the display_data array. Option 1
Element	Description
`{ "type": "qr_url", "title": "qr_url", "data": "https://example.com/qr.jpg" }`	The element containing the link to the QR code that should be displayed to the customer. Example: `https://example.com/qr.jpg`
`{ "type": "add_info", "title": "checkouturl", "data": "https://app.binance.com/payment/secpay" }`	The element containing the link for redirecting the customer to their personal account on the Binance website. Used if the customer does not succeed in scanning the QR code and the Binance app is not installed on their device. Example: `https://app.binance.com/payment/secpay`
`{ "type": "add_info", "title": "app_url", "data": "bnc://app.binance.com/payment/secpay" }`	The element containing the link for opening the Binance app. Used if the customer does not succeed in scanning the QR code and the Binance app is installed on their device. Example: `bnc://app.binance.com/payment/secpay`

Here is an example of the callback snippet with the data for displaying the payment QR code to the customer.

"display_data": [
	{
		"type": "qr_url", 
		"title": "qr_url", 
		"data": "https://example.com/qr.jpg" 
	}, 
	{ 
		"type": "add_info", 
		"title": "checkouturl", 
		"data": "https://app.binance.com/payment/secpay" 
	}, 
	{ 
		"type": "add_info", 
		"title": "app_url", 
		"data": "bnc://app.binance.com/payment/secpay" 
	} 
]

Table 4. Description of the display_data array. Option 2
Element	Description
`{ "type": "qr_url", "title": "qr_url", "data": "https://example.com/qr.jpg" }`	The element containing the link to the QR code that should be displayed to the customer. Example: `https://example.com/qr.jpg`
`{ "type": "add_info", "title": "checkouturl", "data": "https://app.binance.com/payment/secpay" }`	The element containing the link for redirecting the customer to their personal account on the Binance website. Used if the customer does not succeed in scanning the QR code and the Binance app is not installed on their device. Example: `https://app.binance.com/payment/secpay`
`{ "type": "add_info", "title": "app_url", "data": "bnc://app.binance.com/payment/secpay" }`	The element containing the link for opening the Binance app. Used if the customer does not succeed in scanning the QR code and the Binance app is installed on their device. Example: `bnc://app.binance.com/payment/secpay`
`{ "type": "add_info", "title": "universalurl", "data": "https://app.binance.com/payment/secpay" }`	The element containing the universal link for redirecting the customer to their personal account on the Binance website and to their app (if it is installed on their device). Used if the customer does not succeed in scanning the QR code. Example: `https://app.binance.com/payment/secpay`
`{ "type": "add_info", "title": "expired_timestamp", "data": "1707411997" }`	The element containing the data about the due date of the payment. The due date of the payment is specified in the Unix time format (in seconds). Example: `1707411997`

Here is an example of the callback snippet with the data for displaying the payment QR code to the customer.

"display_data": [
	{
		"type": "qr_url", 
		"title": "qr_url", 
		"data": "https://example.com/qr.jpg" 
	}, 
	{ 
		"type": "add_info", 
		"title": "checkouturl", 
		"data": "https://app.binance.com/payment/secpay" 
	}, 
	{ 
		"type": "add_info", 
		"title": "app_url", 
		"data": "bnc://app.binance.com/payment/secpay" 
	}, 
	{ 
		"type": "add_info", 
		"title": "universalurl", 
		"data": "https://app.binance.com/payment/secpay" 
	}, 
	{ 
		"type": "add_info", 
		"title": "expired_timestamp", 
		"data": "1707411997" 
	} 
]

Callback

In the Binance Pay 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": "unify",
        "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 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": "unify",
        "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=="
}

Refund by using Gate

General information

To perform a refund by using Gate for a purchase made with the Binance Pay 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 Binance Pay 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 Binance Pay payment method.


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

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: 100.00 EUR must be sent as 10000

description
string
strictly required

Refund description.

Example: Refund description.

by_method
string
strictly required

The payment method's code. Pass BinancePay in this parameter.

Example: BinancePay

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 Binance Pay 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": "EUR",
        "amount": 10000,
        "description": "Refund description.",
        "by_method": "BinancePay"
    }
}

Callback

In the Binance Pay 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": "unify",
        "sum": {
            "amount": 0,
            "currency": "EUR"
        },
        "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": 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 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": "unify",
        "sum": {
            "amount": 10000,
            "currency": "EUR"
        },
        "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": 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=="
}

COF purchase by using Gate

General information

The Binance Pay payment method provides the ability to perform COF purchases—regular on-demand payments. For more information about COF purchases, see On-demand COF purchase: workflow and statuses.

This section describes how to perform a new payment within registered a COF purchase. For information on how to register a COF purchase, see the Request sections of the topics about one-step and two-step purchases.

In the Binance Pay method, your system is required to do the following when processing a payment within the registered COF purchase by using Gate:

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

The following diagram provides the detailed picture of the processing flow of a payment within a registered COF purchase.

Figure 12. New COF payment by using Gate

The customer initiates a new payment within the registered COF purchase on your system's side. This step is optional.
Your system sends a request for processing the COF payment by using Gate to the Monetix URL.
The payment platform receives the request for processing the COF payment and sends the response with request receipt confirmation and validation result to the your system. For more information about the response format, see Response structure.
The payment platform performs the internal payment request processing and forwards the request to the provider service.
The provider service processes the request and sends the payment result notification to the payment platform.
The payment platform sends the callback with the payment result to your system.
Your system sends the payment result to the customer.

The sections that follow discuss in more details the format of requests and parameters of a Gate request when working with the Binance Pay payment method, as well as the format of callbacks with the payment results, when performing a new payment within the registered COF purchase. For the general information on how to use the Gate API, see API Description.

Request for a COF purchase

This section provides the instructions on how to build a request for a COF purchase with the Binance Pay payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	/v2/payment/unify/recurring

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: 123

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

email
string
strictly required

Customer's email.

Example: johndoe@example.com

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

payment
object
strictly required

amount
integer
strictly required

Purchase 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. The amount and currency must match the values in the auth request. 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

currency
string
strictly required

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

Example: EUR

recurring
object
strictly required

id
string
strictly required

ID of the COF purchase.

Example: 12345

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 data from a COF purchase request.

Figure 13. Example of a COF purchase request

{
    "general": {
        "project_id": 123,
        "payment_id": "payment_47",
        "signature": "DH0v2pZnkK9hwytQ6/ZtDSQh+wwx/OqrWdbltzO5GMSkzd0Iq6lM2"
    },
    "customer": {
        "ip_address": "198.51.100.47"
    },
    "payment": {
        "amount": 10000,
        "currency": "EUR"
    },
    "recurring": {
        "id": 12345
    }
}

Callback

The standard format for callbacks is used to deliver the results of actions with COF purchases. For more information, see Callbacks in Gate.

The following is an example of a callback with an information about COF purchase registration for a customer in the 123 project.

Figure 14. Example of a successful COF purchase

 {
    "project_id": 123,
    "payment": {
        "id": "payment_47",
        "type": "recurring",
        "status": "success",
        "date": "2018-11-20T08:44:46+0000",
        "method": "unify",
        "sum": {
            "amount": 10000,
            "currency": "EUR"
        },
        "description": "payment"
    },
    "account": {
        "number": "123456"
    },
    "recurring": {
        "id": 12345,
        "currency": "",
        "valid_thru": "-0001-11-30T00:00:00+0000"
    },
    "operation": {
        "id": 28,
        "type": "recurring",
        "status": "success",
        "date": "2018-11-20T08:44:46+0000",
        "created_date": "2018-11-20T08:44:41+0000",
        "request_id": "07fd7ade7cf010",
        "sum_initial": {
            "amount": 10000,
            "currency": "EUR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "EUR"
        },
        "provider": {
            "id": 1187,
            "payment_id": "1234567890",
            "date": "2020-11-20T08:44:45+0000",
            "auth_code": ""
        },
        "code": "0",
        "message": "Success"
    },
    "signature": "x2tsnvLCRXZMX8Kwyr9a8+I3RipuPWUod5c89cDSQ6cRq=="
}

The following is an example of a callback after a COF payment cancellation.

Figure 15. Example of a COF payment cancellation

{
    "project_id": 123,
    "payment": {
        "id": "payment_47",
        "type": "recurring",
        "status": "success",
        "date": "2018-11-20T08:44:46+0000",
        "method": "unify",
        "sum": {
            "amount": 10000,
            "currency": "EUR"
        },
        "description": "payment"
    },
    "account": {
        "number": "123456"
    },
    "recurring": {
        "id": 12345,
        "currency": "",
        "valid_thru": "-0001-11-30T00:00:00+0000"
    },
    "operation": {
        "id": 28,
        "type": "recurring_cancel",
        "status": "success",
        "date": "2018-11-20T08:44:46+0000",
        "created_date": "2018-11-20T08:44:41+0000",
        "request_id": "07fd7ade7cf010",
        "sum_initial": {
            "amount": 10000,
            "currency": "EUR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "EUR"
        },
        "provider": {
            "id": 1187,
            "payment_id": "1234567890",
            "date": "2020-11-20T08:44:45+0000",
            "auth_code": ""
        },
        "code": "0",
        "message": "Success"
    },
    "signature": "x2tsnvLCRXZMX8Kwyr9a8+I3RipuPWUod5c89cDSQ6cRq=="
}

The following is an example of a callback with an information about declined COF purchase.

Figure 16. Example of a declined COF purchase

{
    "project_id": 123,
    "payment": {
        "id": "payment_47",
        "type": "recurring",
        "status": "success",
        "date": "2018-11-20T08:44:46+0000",
        "method": "unify",
        "sum": {
            "amount": 10000,
            "currency": "EUR"
        },
        "description": "payment"
    },
    "errors": [
        {
            "code": "2701",
            "message": "Rules Failed Code",
            "description": "fatal: RULES_FAILED_CODE"
        }
    ],
    "recurring": {
        "id": 12345,
        "currency": "",
        "valid_thru": "-0001-11-30T00:00:00+0000"
    },
    "operation": {
        "id": 28,
        "type": "recurring",
        "status": "decline",
        "date": "2018-11-20T08:44:46+0000",
        "created_date": "2018-11-20T08:44:41+0000",
        "request_id": "07fd7ade7cf010",
        "sum_initial": {
            "amount": 10000,
            "currency": "EUR"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "EUR"
        },
        "provider": {
            "id": 1187,
            "payment_id": "1234567890",
            "date": "2020-11-20T08:44:45+0000",
            "auth_code": ""
        },
        "code": "2701",
        "message": "Rules Failed Code"
    },
    "signature": "x2tsnvLCRXZMX8Kwyr9a8+I3RipuPWUod5c89cDSQ6cRq=="
}

Payout by using Gate

General information

To perform a payout by using Gate with the Binance Pay payment method:

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

The following picture provides the details of the payout processing flow in the Binance Pay payment method.

Figure 17. Payout processing flow when performing a payout by using Gate

The customer initiates a payout in your system.
Your system sends the payout 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 payout result.
The payment platform sends a callback with the payout result to your system.
Your system sends the payout result to the customer.

Request

This section provides the instructions on how to build the request for payout with the Binance Pay payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	/v2/payment/unify/payout

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

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's ID in the Binance service. The value has to correspond to the value that you submit in the payment_data.receive_type parameter.

Example: 1234567890

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.

Example: 100.00 EUR must be sent as 10000

by_method
string
strictly required

The payment method's code. Pass BinancePay in this parameter.

Example: BinancePay

payment_data
object
optional

receive_type
string
optional

Type of the ID you pass in the account.number parameter. If you don't pass this parameter in the payout request, the payment platform will use BINANCE_ID as the default value. To change the default value, contact the Monetix technical support.

Possible values:

BINANCE_ID—when submitting the customer's ID (eight or more digits) in the Binance service
EMAIL—when submitting the customer's email used as their ID in the Binance service

Example: BINANCE_ID

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

Figure 18. Example of the payout 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": "1234567890"
    },
    "payment": {
        "currency": "EUR",
        "amount": 10000,
        "by_method": "BinancePay"
    },
    "payment_data": {
        "receive_type": "BINANCE_ID"
    }
}

Callback

In the Binance Pay payment method, the payment platform returns the payout 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 payout.

Figure 19. Example of the data from a successful payout callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "unify",
        "sum": {
            "amount": 10000,
            "currency": "EUR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "payout",
        "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 payout.

Figure 20. Example of the data from a declined payout callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "unify",
        "sum": {
            "amount": 10000,
            "currency": "EUR"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "payout",
        "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=="
}

Payout by using Dashboard

To make a payout through Dashboard, the merchant sends a request and receives a notification with the request processing result. There are two ways to initiate payouts through Dashboard:

single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.

Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.

For more information about payout processing by using Dashboard, see Performing payouts.

Analysis of payments results

As with other payment methods Monetix offers, when using this method, you have several options to analyze the information about payments and operations.

You can load and analyze all the necessary information in Dashboard (dashboard.gtxpoint.com), for instance you can use the analytic panels in the Analytics section for this purpose.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

Dashboard allows you to download reports in CSV format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by means of sending requests to the /operations/get endpoint.

If you have any further questions regarding payment data analysis, contact Monetix technical support.

Binance Pay

Overview

Operations support

Purchase by using Payment Page

General information

Request

Callback

Related topics

Purchase by using Gate

General information

Request

Displaying the payment QR code to the customer

Callback

Related topics

Refund by using Gate

General information

Request

Callback

Related topics

COF purchase by using Gate

General information

Request for a COF purchase

Callback

Related topics

Payout by using Gate

General information

Request

Callback

Related topics

Payout by using Dashboard

Analysis of payments results