Rapipago

General information

To process a purchase through Payment Page by using the Rapipago method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.

Information about the formats of requests and callbacks used for processing payments by using the Rapipago method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

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

1. The following parameters required for any payment must be specified:
   • project_id—project identifier obtained from ecommpay during integration
   • payment_id—payment identifier unique within the project
   • payment_currency—payment currency code in the ISO-4217 alpha-3 format
   • payment_amount—payment amount in the smallest currency unit
   • customer_id—customer identifier unique within the project
2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
3. The currency of payment can only be ARS or USD.
4. Additionally, the following customer information should be specified:
   • customer_first_name and customer_last_name—first and last names of the customer
   • customer_email—customer email
   • identify_doc_number—number of the customer's identity document, should consist of 7, 8 or 11 digits.
5. If you need to have the payment form displayed with the Rapipago method selected, set the force_payment_method parameter to rapipago.
6. Additionally, any other parameters available for working with Payment Page can be used (details).
7. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the Rapipago method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information and signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 10000,
   "payment_currency": "ARS",
   "customer_id": "customer1",
   "customer_first_name": "Guido",
   "customer_last_name": "Marques",
   "customer_email": "customer@example.com",
   "identify_doc_number": "12345678901",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 10000,
   "payment_currency": "ARS",
   "customer_id": "customer1",
   "customer_first_name": "Guido",
   "customer_last_name": "Marques",
   "customer_email": "customer@example.com",
   "identify_doc_number": "12345678901",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

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

Useful links

The following articles can be useful when implementing purchases via Payment Page:

• Interaction concepts—about the interaction with the payment platform by using Payment Page.
• Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
• Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
• One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
• Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.

General information

To process a purchase through Gate by using the Rapipago method, the merchant's web service is required to do the following:

1. Send a request with all the required parameters and signature to the ecommpay URL.
2. Receive an intermediate callback from the payment platform and redirect the customer to the Rapipago service.
3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.

Information about the formats of requests and callbacks used for processing payments by using the Rapipago method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the Rapipago method:

1. To initiate each purchase, send a separate POST request to the /v2/payment/voucher/rapipago/sale endpoint. This endpoint belongs to the group /v2/payment/voucher/{payment_method}/sale.
2. Each request must include the following objects and parameters:
   • Object general—general purchase information:
     • project_id—project identifier obtained from ecommpay during integration
     • payment_id—payment identifier unique within the project
     • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
   • Object payment—payment information:
     • amount—payment amount in the smallest currency unit
     • currency—payment currency code in the ISO-4217 alpha-3 format
   • Object customer—customer information:
     • id—customer identifier unique within the project
     • ip_address—customer IP address relevant for the initiated payment
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email address
     • Object identify—information about the document which establishes identity:
       • doc_number—number of the customer's identity document, should consist of 7, 8 or 11 digits
3. The currency of payment can be ARS or USD.
4. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the Rapipago method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information, as well as signature.

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

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

Formats of intermediate callbacks for customer redirection

Each payment made with the Rapipago method requires redirection of customers from the merchant's web service to the Rapipago service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the redirect_data object. The format of such callbacks is standard (details), and the following objects and parameters are included in the redirect_data object:

• body—object with data to be sent in the request body
• method—parameter specifying the HTTP method for sending the request (GET or POST)
• url—parameter containing a link for redirection

  "redirect_data": {
    "body": {},
    "method": "GET",
    "url": "https://www.example.com/pay"
  }

Callback format

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

Useful links

The following articles can be useful when implementing purchases via Gate:

• Interaction concepts—about the interaction with the payment platform by using Gate.
• Signature generation and verification—about the procedure of generating and verifying signatures in requests and callbacks.
• Payment models and statuses—about the types, processing models, and possible statuses of supported payments and operations.
• One-time one-step purchase—about processing of one-time one-step purchases by using Payment Page.
• Information of operations performing—about error and response codes that are used in the payment platform to record information about performing of operations.