Rapipago

General information

In the Rapipago method, to perform a purchase by using Payment Page, the merchant web service should send a request with all the required parameters and signature to the ecommpay URL and get the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the Rapipago method selected. For more information about preselecting payment methods, see in Preselecting payment methods.

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

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

Request format

There are several things you need to consider when using the Rapipago 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—the project ID obtained from ecommpay
   • payment_id—payment ID unique within the project
   • payment_currency—payment currency in ISO-4217 alpha-3 format
   • payment_amount—payment amount in minor units; depending on the payment processing provider, it may be necessary to specify an integer amount, refer to your ecommpay key account manager for more information
   • customer_id—customer ID unique within the project
2. The currency of payment can only be ARS or USD.
3. Additionally, the following customer data should be passed:
   • customer_first_name and customer_last_name—first and last names
   • customer_email—email
   • identify_doc_number—number of the identity document, should content 7, 8 or 11 digits.
4. 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.
5. If you need to have payment form displayed with the Rapipago method selected, set the force_payment_method parameter to rapipago.
6. If required, you can also add any other additional parameters Payment Page supports.

Thus, a correct payment request through the Rapipago method must include project and payment IDs, customer data, the currency and the amount of a payment in the appropriate currency, as shown in the following example:

EPayWidget.run(
    { payment_id: 'X03936', 
      payment_amount: 10000, 
      payment_currency: 'ARS', 
      project_id: 0,    
      customer_id: 'customer1',
      customer_first_name: 'Guido',
      customer_last_name: 'Marques',
      customer_email: 'marques@gmail.com',
      identify_doc_number: '12345678901',
      signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the Payment Page, see Parameters for opening payment form.

Callback format

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

Related topics

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

• Interaction concepts
• Signature generation and verification
• Payment models and statuses
• Information of operations performing

General information

In the Rapipago 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 ecommpay URL.
2. Perform redirection of the customer to the Rapipago 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.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Rapipago payment method and provide the information about formats of the data for redirecting customers and the information about the format of callbacks with payment results. The general information about working with API see in the API Description section.

Request format

1. You perform purchase by sending the /v2/payment/voucher/rapipago/sale request by using POST (HTTP) method. This is payments by using vouchers request group: /v2/payment/voucher/{payment_method}/sale
2. The following objects and parameters must be specified in the request:
   • Object general—general purchase information:
     • project_id—project identifier
     • payment_id—unique payout identifier
     • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification
   • Object customer—customer information:
     • id—the ID of the customer within the merchant project
     • ip_address—IP address
     • first_name—first name
     • last_name—last name
     • email—email address
     • Object identify—information about the document which establishes identity:
       • doc_number—number of the identity document, should consist of 7, 8 or 11 digits
   • Object payment—purchase information:
     • amount—purchase amount in minor units; depending on the payment processing provider, it may be necessary to specify an integer amount, refer to your ecommpay key account manager for more information
     • currency—purchase currency in the ISO-4217 alpha-3 format
3. The currency of payment can be ARS or USD.
4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request through the Rapipago method must include project and payment IDs, customer data, signature, currency and amount of the purchase, as shown in the following example:

{
    general: {
        project_id: 580,
        payment_id: "38202000002316",
        signature: "h4ZxUifBNaLuvlYXyvBuqG/tRr67tWadwpXnBeF+iSR0K5OFdK0B9CjMCc2DbkDrk3qhLg=="
    },
    customer: {
        id: "589256",
        email: "Paul@mail.com",
        first_name: "Paul",
        last_name: "Marques",
        identify: {
            doc_number: "84887177100"
        },
        ip_address: "66.249.64.45"
    },
    payment: {
        amount: 10000,
        currency: "USD",
        description: "38202000002316"
    }
}

Formats of the customer redirection data

To redirect a customer from the web service to the Rapipago site, you must receive a callback from the payment platform containing the URL for redirection in the redirect_data.url parameter and data to be sent in the request body in the redirect_data.body parameter, and use these parameters when opening the HTML page using the method specified in the redirect_data.method parameter.

The following is the callback fragment containing the redirection data.

"redirect_data" : {
			"body" : [	],
			"method" : "GET",
			"url" : "http://test/redirect_url/6f1412f514070d4e61850e4d5ff136e8"
		}

Callback format

The standard format for callbacks is used to deliver purchase results from Rapipago. For more information, see Callbacks.

Related topics

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

• Interaction concepts
• Signature generation and verification
• Payment models and statuses
• Information of operations performing

As with other payment methods ecommpay offers, when using the Rapipago method, you have several options to analyse the information about payments and operations performed by using the method—alone or in conjunction with other methods.

You can load and analyse all the necessary information in Dashboard, for instance you can use the analytic panels on the Analytics tab to this end.

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 and XLS formats—by using the tools on the Payments tab. You can perform export as a one-time download to your local computer or have payment data regularly exported and delivered to email addresses you specify.
• 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 using the /operations/get queries.

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