ADVCash

Interaction diagram

Payment processing by using the ADVCash payment method requires merchant's web service, one of the Monetix interfaces, and the payment platform, as well as provider's technical facilities.

Operations support

	Interfaces			Amounts, USD		Times
	Payment Page	Gate	Dashboard	Minimum	Maximum	basic	threshold
Purchases						2-3 minutes	35 days
Payouts						2-3 minutes

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 click the Payment methods tab.

Processing scenarios

In the ADVCash method, to perform a purchase operation, you need to redirect customer to the service, while to initiate a payout, you need to notify customer via merchant's web service.

The sections that follow provide detailed information about what you need to perform payments and how you can analyze the information on payments and operations.

General information

The full sequence and particularities of the purchase process are provided below.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the ADVCash payment method and provide the information on the format of callbacks with payment results. For the general information on how to use the API, seePayment Page API Description.

Request format

There are several things you need to consider when using the ADVCash method:

1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
   • project_id—project ID you obtained from Monetix
   • payment_id—payment ID unique within the project
   • customer_id—unique ID of the customer within your project
   • customer_email—customer email
   • customer_first_name—customer first name
   • customer_last_name—customer last name
   • payment_currency—payment currency in ISO-4217 alpha-3 format
   • payment_amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
2. The currency of payment can only be EUR, BRL, GBP, KZT, RUB, UAH, USD. It is possible to display the payment currency selection on Payment Page. To enable and configure functionality, contact the technical support by support@monetix.pro.
3. If you need to have payment form displayed with the ADVCash method selected, send the force_payment_method parameter advcash or advcash_direct. For the information on the code selection, refer to the key account manager.
4. If required, you can also add any other additional parameters Payment Page supports. For information about all parameters available in the ADVCash method, see Payment Page invocation parameters.
5. After you specify all the parameters you need, you must create the signature for the request. For instructions on how to sign a payment request, see Signature generation and verification.

Here is an example of data from a purchase request.

Callback format

The ADVCash method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks in Payment Page.

Related topics

The following topics might be useful when implementing payments through Payment Page:

• Integration procedure
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

General information

In the ADVCash methods, when processing a purchase by using Gate, the merchant web service is required to do the following:

1. Send a request with all the required parameters and signature to the Monetix URL.
2. Perform redirecting customer to the ADVCash service.
3. Get the callback with the payment result from the payment platform.

The full sequence and particularities of the purchase processes are provided below.

Request format

1. You send purchase requests by sending the /v2/payment/advcash/sale request by using HTTP method POST.
2. The following objects and parameters must be specified in any request:
   • general—object with general request identification information:
     • project_id—the project ID you obtained from Monetix
     • payment_id—payment ID unique within the project
     • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
   • customer—object with customer information:
     • id—the unique ID of the customer within your project
     • ip_address—customer device IP
     • email—customer email
     • first_name—customer first name
     • last_name—customer last name
   • payment—object with purchase information:
     • amount—purchase amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
     • currency—code of purchase currency in the ISO-4217 alpha-3 format
   • return_url—object with the information where to redirect the customer to when the payment is completed:
     • success—the URL to redirect the customer to after the payment is successfully completed.
     • decline—the URL to redirect the customer to after the payment is declined.
3. The currency of purchase can only be EUR, BRL, GBP, KZT, RUB, UAH, USD.
4. The following parameter with the return URL is optional, but we strongly advise you to specify it in the request to provide your customer a better user experience.
   • return_url—object with the information where to redirect the customer to when the payment is prematurely terminated by the customer:
     • return—the URL to redirect the customer to when they prematurely terminate the payment.
5. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a purchase request in the ADVCash method.

Format of customer redirection data

After receiving and processing your purchase request, the payment platform sends a callback to your web service containing the data to redirect the customer to the ADVCash service.

To redirect the customer, use the values of the following parameters in the redirect_data object:

• url—the URL to redirect the customer to
• body—the data to be sent in the request body
• method—the HTTP method to get an HTML page of the website (for example, POST or GET)
• encrypted—this is the service parameter. Ignore the data it contains.

Here is an example of a piece of callback containing the data to redirect the customer.

"redirect_data": {
    "method": "GET",
    "body": {
        "example_parameter_1": "value_1",
        "example_parameter_2": "value_2",
    },
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Callback format

The ADVCash method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks in Gate.

Related topics

The following topics might be useful when implementing payments through Gate:

• Integration procedure
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

General information

In the ADVCash method, any payout follows the usual procedure which is common to Gate: merchant's web service sends a request with all the required parameters and signature to Monetix URL, Gate accepts the request and redirects to the payment platform for further processing, after that a callback is sent to merchant's web service.

The sections that follow discuss in more details the request format and the Gate parameters to use in the ADVCash payment method and provide the information on the format of callbacks with payout results.

Request format

1. You send payout requests by sending the /v2/payment/advcash/payout request by using HTTP method POST.
2. The following objects and parameters must be specified in any request:
   • general—object with general request identification information:
     • project_id—the project ID obtained from Monetix
     • payment_id—payment ID unique within the project
     • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
   • customer—object with customer information:
     • id—the unique ID of the customer within your project
     • ip_address—customer device IP
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email
   • account—object with customer account information:
     • number—customer email address linked to the e-wallet account
   • payment—object with payout information:
     • amount—payout amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
     • currency—code of payout currency in the ISO-4217 alpha-3 format
3. The currency of payout can only be EUR, BRL, GBP, KZT, RUB, UAH, USD.
4. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a payout request in the ADVCash method.

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "account": {
        "number": "johndoe@example.com"
    },
    "payment": {
        "amount": 700,
        "currency": "RUB"
    }
}

Callback format

The ADVCash method uses the standard format for callbacks to deliver payout results. For more information, see Callbacks in Gate.

Related topics

The following topics might be useful when implementing payments through Gate:

• Integration procedure
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

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

General information

For the ADVCash method the testing of purchases by using Payment Page and Gate.

Testing can be performed within a test project, to enable and disable the testing availability, contact Monetix technical support via support@monetix.pro.

When performing a test payment, take into account that you must specify the identifier of the test project in the requests, the currency can be only UAH, and the interfaces of the payment forms emulator of Payment Page and ADVCash differ from the production environment.

Test payments statuses

When testing purchases, the final payment status is determined by the amount specified in the request:

• decline status with 40000 or 40400 amount
• success status with any other amount

Testing purchase by using Payment Page

To perform a test purchase by using Payment Page, do the following:

1. Send a correct test request for Payment Page opening to the payment platform.
2. If the advcash method was not specified in the request—select the method on the emulator page.
3. Click the Success or Decline button (depending on the amount specified in the request).
4. Accept a callback with information about the payment result.

The full information about purchase process by using ADVCash through Payment Page is provided in the section Purchase by using Payment Page.

Testing purchase by using Gate

To perform a test purchase by using Gate, do the following:

1. Send a correct test request for purchase to the payment platform.
2. Accept a callback with redirection data.
3. Go to the received URL and click the Success or Decline button (depending on the amount specified in the request).
4. Accept a callback with information about the payment result.

The full information about purchase process by using ADVCash through Gate is provided in the section Purchase by using Gate.

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 (dash-light.trxhost.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.