Carga Virtual

Overview

Carga Virtual is a payment method that allows customers to perform purchases in Argentina by using vouchers. Purchases are performed by using Payment Page and Gate.

General information

Payment method type payments by using vouchers
Countries and regions AR
Payment currencies USD
Currency conversion
Purchases +
Payouts for payout processing refer to your ECommPay key account manager
Stored credentials payments
Full refunds
Partial refunds
Chargebacks
Special considerations
  • the validity period of the payment voucher is 3 days
  • all payment amounts are integer
Obtaining access to the payment method and access fee refer to your ECommPay key account manager

Interaction diagram

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



Operations support

  Interfaces Amounts, USD
Payment Page CMS Plug-ins Gate Dashboard minimum maximum
Purchases + + 50.00

Processing scenarios

In the Carga Virtual method, a purchase operation is performed on Payment Page or in merchant web-service, where a customer provides the necessary information and than gets a barcode. The customer finishes the purchase operation by using the barcode in one of the available payment kiosks.

Figure: Purchase by using Payment Page



Figure: Purchase by using Gate



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

Purchase by using Payment Page

General information

In the Carga Virtual method, when processing 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 the Carga Virtual method selected. For more information about preselecting payment methods, see in Preselecting payment method. The full sequence and particularities of the purchase process are provided below.



Figure: Purchase sequence by usingPayment Page

  1. A customer initiates a purchase on the merchant's web service.
  2. Merchant's web service sends the request for Payment Page opening to the specified URL.
  3. The request for opening is redirected to the ECommPay payment platform.
  4. The request is processed and checked by the payment platform.
  5. A payment form is generated according to the received parameters.
  6. Payment Page is displayed for the customer.
  7. The customer selects the Carga Virtual payment method.
  8. Payment Page redirects the request to the payment platform for further processing.
  9. The payment platform sends the request to the provider service.
  10. The purchase request is processed on the provider service side.
  11. The provider service generates the data for redirecting the customer to its website form and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the provider service.
  14. The voucher with the instructions are displayed to the customer. The payment status awaiting redirect result remains until the customer completes the payment. The validity period of the payment voucher is 3 days.
  15. The customer completes all the payment steps required in one of the payment kiosks using the received voucher.
  16. The payment is processed on the kiosks service side.
  17. The kiosks service sends the result notification to the provider.
  18. The provider service sends the result notification to the payment platform.
  19. The payment platform sends a callback with the payment result to the web service.
  20. The customer receives the payment result from the web service.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Carga Virtual 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 Carga Virtual 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—currency code in ISO-4217 alpha-3 format
    • payment_amount—integer payment amount in minor units
    • customer_id—the unique ID of the customer within your project
  2. The currency of payment can only be USD.
  3. If you need to have payment form displayed with the Carga Virtual method selected, set the force_payment_method parameter to cargavirtual.
  4. If required, you can also add any other additional parameters Payment Page supports.
  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.

Thus, a correct payment request in the Carga Virtual method must include project, customer and payment IDs, currency code and the amount of a payment, as well as signature, as shown in the following example:

    { payment_id: 'X03936', 
      payment_amount: 1000, 
      payment_currency: 'USD',
      customer_id: 'customer1', 
      project_id: 123, 
      signature: "kUi2x9dKHAVNU0FYldJRLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }

For information about all parameters available in the Carga Virtual method , see Payment Page invocation parameters.

Callback format

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

The following is the example of a callback with an information about successful 10.00 USD purchase made in the 239 project.

Figure: Example of data in a successful purchase callback

{
        "project_id": 239,
        "payment": {
            "id": "S0100_20200626_102701_21215202",
            "type": "purchase",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "method": "cargavirtual",
            "sum": {
                "amount": 1000,
                "currency": "USD"
            },
            "description": "purchase"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 1592,
            "type": "sale",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "created_date": "2020-06-26T07:27:02+0000",
            "request_id": "dd536f8cbe316cb418170a81a6be7ad1c900e2b2056-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2174,
                "payment_id": "1593156426371",
                "auth_code": "",
                "date": "2020-06-26T07:27:06+0000"
            }
        },
        "signature": "a9/KmYMksEr+0ZAMCBA0F8tEhts55i3IxSl/bdLVvzhhMFg=="
    }
}

The following is the example of a callback for a declined purchase.

Figure: Example of data in a declined purchase callback

{
        "project_id": 2511,
        "payment": {
            "id": "D0100_20200626_103733_29570862",
            "type": "purchase",
            "status": "decline",
            "date": "2020-06-26T07:37:43+0000",
            "method": "cargavirtual",
            "sum": {
                "amount": 20500,
                "currency": "USD"
            },
            "description": "purchase"
        },
        "customer": {
            "id": "customer2"
        },
        "operation": {
            "id": 1593,
            "type": "sale",
            "status": "decline",
            "date": "2020-06-26T07:37:43+0000",
            "created_date": "2020-06-26T07:37:33+0000",
            "request_id": "13f5e69966da766f2fbbdf836f481c-00000001",
            "sum_initial": {
                "amount": 20500,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 20500,
                "currency": "USD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2174,
                "payment_id": "1593157057421",
                "auth_code": "",
                "date": "2020-06-26T07:37:37+0000"
            }
        },
        "signature": "+ydiKiPFRjEVgpbSMi6U2BwiWYKgjt1DHr6Nqwg4SsrA=="
    }
}

Related topics

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

Purchase by using Gate

General information

In the Carga Virtual method, 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 the redirection of a customer to the provider service.
  3. Get the callback with the payment result from the payment platform.

The following diagram provides the detailed picture of the payment processing procedure.



Figure: Purchase sequence by using Gate

  1. A customer initiates a purchase on the merchant's web service side.
  2. The web service sends the request for processing the purchase by using Gate to the specified ECommPay URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs the initial request processing that includes validation of the required parameters and signature.
  5. The payment platform sends the response with request receipt confirmation and correctness check result to the web service. For more information, see Response format.
  6. The payment platform performs the internal payment request processing and redirects the request to the provider service.
  7. The request is processed on the provider side.
  8. The provider service sends the data for redirecting the customer to the provider service to the payment platform.
  9. The payment platform sends the callback with the customer redirection data in the redirect_data object to the web service.
  10. The customer is redirected from the web service to the provider service.
  11. The voucher with the barcode and the instructions are displayed to the customer. The payment status awaiting redirect result remains until the customer completes the payment. The validity period of the payment voucher is 3 days.
  12. The customer completes all the payment steps required in one of the payment kiosks using the received voucher.
  13. The payment is processed on the kiosks service side.
  14. The kiosks service sends the result notification to the provider.
  15. The provider service sends the payment result notification to the payment platform.
  16. The ECommPay payment platform sends a callback to the web service.
  17. The customer receives the payment result from the web service.

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

Request format

There are several things you must consider when using purchase requests in the Carga Virtual method:
  1. You perform purchases by sending the /v2/payment/voucher/cargavirtual/sale request by using POST (HTTP) method. This is the online-banking payments request group: /v2/payment/voucher/{payment_method}/sale.
  2. The following objects and parameters must be specified in any request:
    • Object general—general request identification information:
      • project_id—the project ID obtained from ECommPay
      • 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.
    • Object payment—payment information:
      • amount—integer payment amount in minor units
      • currency—currency code in ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—the unique ID of the customer within your project
      • ip_address—customer IP address
  3. The currency of purchase can only be USD.
  4. If required, you can also add any other additional parameters Gate supports.

Thus, a correct payment request in the Carga Virtual method must include project, customer and payment IDs, currency code and amount of the purchase, as well as signature, as shown in the following example:

Figure: Example of a purchase request

{
    "general": {
        "project_id": 1233,
        "payment_id": "test_payment_1",
        "signature": "fgret983tyufghndfh*YURGJhuufgsdf=="
    },
    "payment": {
        "amount": 1000,
        "currency": "USD"  
    }
    "customer": {
        "id": "customer123",
        "ip_address": "1.1.1.1"
    }
}

Formats of the customer redirection data

To redirect a customer from the web service to the Carga Virtual 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": {
            "merchantID": "example-4b019406196c",
            "country": "AR",
            "user": "592461",
            "operation_id": 334,
            "paymentID": "exampleID",
            "returnURL": "http://test.ams",
            "callbackURL": "http://text.test/callback/",
            "amount": "10.00"
        },
        "method": "POST",
        "url": "http://example.test/"
    }

Callback format

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

The following is the example of a callback with an information about successful 10.00 USD purchase made in the 239 project.

Figure: Example of data in a successful purchase callback

{
        "project_id": 239,
        "payment": {
            "id": "S0100_20200626_102701_21215202",
            "type": "purchase",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "method": "cargavirtual",
            "sum": {
                "amount": 1000,
                "currency": "USD"
            },
            "description": "purchase"
        },
        "customer": {
            "id": "123"
        },
        "operation": {
            "id": 1592,
            "type": "sale",
            "status": "success",
            "date": "2020-06-26T07:27:11+0000",
            "created_date": "2020-06-26T07:27:02+0000",
            "request_id": "dd536f8cbe316cb418170a81a6be7ad1c900e2b2056-00000001",
            "sum_initial": {
                "amount": 1000,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "USD"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2174,
                "payment_id": "1593156426371",
                "auth_code": "",
                "date": "2020-06-26T07:27:06+0000"
            }
        },
        "signature": "a9/KmYMksEr+0ZAMCBA0F8tEhts55i3IxSl/bdLVvzhhMFg=="
    }
}

The following is the example of a callback for a declined purchase.

Figure: Example of data in a declined purchase callback

{
        "project_id": 2511,
        "payment": {
            "id": "D0100_20200626_103733_29570862",
            "type": "purchase",
            "status": "decline",
            "date": "2020-06-26T07:37:43+0000",
            "method": "cargavirtual",
            "sum": {
                "amount": 20500,
                "currency": "USD"
            },
            "description": "purchase"
        },
        "customer": {
            "id": "customer2"
        },
        "operation": {
            "id": 1593,
            "type": "sale",
            "status": "decline",
            "date": "2020-06-26T07:37:43+0000",
            "created_date": "2020-06-26T07:37:33+0000",
            "request_id": "13f5e69966da766f2fbbdf836f481c-00000001",
            "sum_initial": {
                "amount": 20500,
                "currency": "USD"
            },
            "sum_converted": {
                "amount": 20500,
                "currency": "USD"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2174,
                "payment_id": "1593157057421",
                "auth_code": "",
                "date": "2020-06-26T07:37:37+0000"
            }
        },
        "signature": "+ydiKiPFRjEVgpbSMi6U2BwiWYKgjt1DHr6Nqwg4SsrA=="
    }
}

Related topics

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

Analysis of payments results

As with other payment methods ECommPay offers, when using the Carga Virtual 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.