PagoEfectivo

Interaction diagram

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

Operations support

	Interfaces			Amounts, PEN		Times
	Payment Page	Gate	Dashboard	minimum	maximum	basic	threshold
Purchases				5.00	3,500.00
Full refunds
Partial refunds

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

For purchase processing by using the PagoEfectivo method you need to redirect the customer to the provider service, while to perform a refund, you need to notify customer via merchant web service.

General information

To process a purchase through Payment Page by using the PagoEfectivo method, the merchant web service needs to send a request with all the required parameters and signature to the Monetix URL and receive a callback with the payment result from the payment platform. The PagoEfectivo method can also be set as preselected payment method when Payment Page opens. For more information about preselecting payment methods, see the Preselecting payment methods section. The full sequence and special aspects of the purchase processing are provided below.

The following sections provide the detailed information about the request format and the Payment Page parameters to use in the PagoEfectivo 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 PagoEfectivo method:

1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are required for any payment method:
   • project_id—the project ID obtained from Monetix
   • payment_id—payment ID unique within the project
   • 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.
   • customer_id—the unique ID of the customer within your project
   • customer_first_name—customer first name
   • customer_last_name—customer last name
   • customer_email—customer email address
2. It is also recommended to specify the identify_doc_number parameter with the number of the identity document (DNI) of the customer. This number must contain from 8 to 9 digits without punctuation or special characters (example: 123456789). If this parameter is missing, Payment Page will contain an additional field for the customer to enter the missing information. For more information about additional information submission, see in Submission of additional payment information.
3. If you need the payment form to open with the PagoEfectivo method as preselected payment method, set the force_payment_method parameter to pagoefectivo-voucher.
4. If required, you can also add any other additional parameters supported by Payment Page. For information about all parameters available in the PagoEfectivo 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 request for Payment Page opening:

EPayWidget.run(
    { 
        payment_id: 'X03936', 
        payment_amount: 1000, 
        payment_currency: 'PEN', 
        project_id: 123,
        customer_id: 'customer1',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        customer_email: 'johndoe@example.com',
        identify_doc_number: '123456789',
        signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y1Y4HASCQ9vy...ekpZhkIQg=="
    }
)

Callback format

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

The following is the example of a callback with an information about successful 100.00 PEN purchase made by the customer1 customer in the 123 project.

{
        "project_id": 123,
        "payment": {
            "id": "abc12345",
            "type": "purchase",
            "status": "success",
            "date": "2021-03-17T09:06:52+0000",
            "method": "pagoefectivo",
            "sum": {
                "amount": 10000,
                "currency": "PEN"
            },
            "description": ""
        },
        "customer": {
            "id": "customer1"
        },
        "operation": {
            "id": 12345,
            "type": "sale",
            "status": "success",
            "date": "2021-03-17T09:06:52+0000",
            "created_date": "2021-03-17T09:06:27+0000",
            "request_id": "a8ad912602397d524a9097216293408e...00001",
            "sum_initial": {
                "amount": 10000,
                "currency": "PEN"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "PEN"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 5031,
                "payment_id": "616ef1f30fa...8f7729b",
                "auth_code": "",
                "date": "2021-03-17T09:06:42+0000"
            }
        },
        "signature": "w4qyf78RSWm4nU7D88QzYfimMsDSyna0RpL1v...AMCJ0H8Ffvw=="
    }
}

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

{
        "customer": {
            "id": "123"
        },
        "project_id": 1234,
        "payment": {
            "id": "ABC123456",
            "type": "purchase",
            "status": "decline",
            "date": "2021-04-06T11:03:34+0000",
            "method": "pagoefectivo",
            "sum": {
                "amount": 10000,
                "currency": "PEN"
            },
            "description": ""
        },
        "operation": {
            "id": 5042427010050682,
            "type": "sale",
            "status": "decline",
            "date": "2021-04-06T11:03:34+0000",
            "created_date": "2021-04-06T11:03:29+0000",
            "request_id": "c26588ff2136b7f154fa3c3a614210d...5042428",
            "sum_initial": {
                "amount": 10000,
                "currency": "PEN"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "PEN"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 5031,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "YkYwTw5LRCA/pdOl3tWi3l...ajHtofqx3kYNwSiYw=="
    }
}

Related topics

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

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

General information

To process a purchase through Gate by using the PagoEfectivo method, 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 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.

The following sections provide the detailed information about the request format and the Gate parameters to use in the PagoEfectivo payment method and provide the information on the format of callbacks with purchase results. For the general information on how to use the API, see API Description.

Request format

1. You perform purchase by sending the request to /v2/payment/voucher/pagoefectivo/sale 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 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—IP address of the customer's device
     • first_name—customer first name
     • last_name—customer last name
     • email—customer email
     • identify—object with information about the document which establishes identity:
       • doc_number—number of the identity document (DNI) of the customer, must contain from 8 to 9 digits without punctuation or special characters (example: 123456789)
   • 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
3. The following parameters with the return URLs are optional, but we strongly advise you to specify them in the request to provide your customer a better user experience. 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.
   • return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer:
     • 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
     • return—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.
4. If required, you can also add any other additional parameters Gate supports.

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

{
    "general": {
        "project_id": 123,
        "payment_id": "1234567",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
        "id": "54321",
        "email": "test@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "identify": {
            "doc_number": "123456789"
        },
        "ip_address": "198.51.100.47"
    },
    "payment": {
        "amount": 1000,
        "currency": "PEN"
    },
    "return_url": {
        "success": "https://example.com/success/",
        "decline": "https://example.com/decline/",
        "return": "https://example.com/return/"
    }
}

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 provider 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": [],
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Callback format

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

The following is the example of a callback with an information about successful 100.00 PEN purchase made in the 456 project.

{
        "project_id": 456,
        "payment": {
            "id": "abc12345",
            "type": "purchase",
            "status": "success",
            "date": "2021-03-17T09:06:52+0000",
            "method": "pagoefectivo",
            "sum": {
                "amount": 10000,
                "currency": "PEN"
            },
            "description": ""
        },
        "operation": {
            "id": 12345,
            "type": "sale",
            "status": "success",
            "date": "2021-03-17T09:06:52+0000",
            "created_date": "2021-03-17T09:06:27+0000",
            "request_id": "a8ad912602397d524a9097216293408e...00001",
            "sum_initial": {
                "amount": 10000,
                "currency": "PEN"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "PEN"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 5031,
                "payment_id": "616ef1f30fa...8f7729b",
                "auth_code": "",
                "date": "2021-03-17T09:06:42+0000"
            }
        },
        "signature": "w4qyf78RSWm4nU7D88QzYfimMsDSyna0RpL1v...AMCJ0H8Ffvw=="
    }
}

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

{
        "project_id": 1234,
        "payment": {
            "id": "ABC123456",
            "type": "purchase",
            "status": "decline",
            "date": "2021-04-06T11:03:34+0000",
            "method": "pagoefectivo",
            "sum": {
                "amount": 1000,
                "currency": "PEN"
            },
            "description": ""
        },
        "operation": {
            "id": 1234567890,
            "type": "sale",
            "status": "decline",
            "date": "2021-04-06T11:03:34+0000",
            "created_date": "2021-04-06T11:03:29+0000",
            "request_id": "c26588ff2136b7f154fa3c3a614210d...5042428",
            "sum_initial": {
                "amount": 1000,
                "currency": "PEN"
            },
            "sum_converted": {
                "amount": 1000,
                "currency": "PEN"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 5031,
                "payment_id": "",
                "auth_code": ""
            }
        },
        "signature": "YkYwTw5LRCA/pdOl3tWi3l...ajHtofqx3kYNwSiYw=="
    }
}

Related topics

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

• Synchronous and asynchronous message processing
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

General information

PagoEfectivo supports processing of partial and full refunds. Refunds are performed by using bank transfers. Refund processing can be initiated within 180 days after purchase. In the PagoEfectivo method, any refund 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. The full sequence of the refund process is provided below.

The following sections provide the detailed information about the request format and the Gate parameters to use in the PagoEfectivo payment method and provide the information on the format of callbacks with refund results. For the general information on how to use the API, see Payment Page API Description.

Request format

1. You perform refunds by sending the request to the /v2/payment/voucher/pagoefectivo/refund endpoint by using HTTP method POST. This request refers to the payment by using vouchers request group: /v2/payment/voucher/{payment_method}/refund.
2. The following objects and parameters must be specified in any request:
   • general—object with general refund information:
     • project_id—project identifier
     • payment_id—unique refund identifier
     • 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:
     • ip_address—customer device IP
   • payment—object with refund information:
     • description—comment or description
     • amount—refund 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.

       The parameter is required only for partial refund.

     • currency—refund currency in ISO-4217 alpha-3 format.

       The parameter is required only for partial refund.

3. It is recommended to specify the additional parameters and their values. If the request is missing the parameters, to collect this information, the provider requests the needed data by sending the customer a form which the customer should fill in and send back to the provider within 5 days. The form is valid for 5 days, and if the customer does not fill in the form and send it back to the provider within the given timeframe, the refund has to be initiated again.
   • Object account—customer bank account information:
     • number—account number
     • bank_name—bank name
     • bank_branch_name—bank branch name
     • bank_account_type—bank account type (available values: C—for current accounts, S—for savings accounts, I—for international accounts)
4. If required, you can also add any other additional parameters Gate supports.

Here is an example of the data from a refund request in the PagoEfectivo method.

{
    "general": {
        "project_id": 580,
        "payment_id": "abc1234567",
        "signature": "111"
    },
    "customer": {
        "ip_address": "198.51.100.47"
    },
    "payment": {
        "description": "refund12345",
        "amount": 1000,
        "currency": "PEN"
    },
    "account": {
        "number": "1234567890",
        "bank_name": "ABC123",
        "bank_branch_name": "ABC456",
        "bank_account_type": "C"
}

Callback format

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

The following is the example of a callback with an information about successful 100.00 PEN refund in the 789 project.

{
        "project_id": 789,
        "payment": {
            "id": "EPe42d-71a0",
            "type": "purchase",
            "status": "refunded",
            "date": "2021-03-17T09:10:26+0000",
            "method": "pagoefectivo",
            "sum": {
                "amount": 0,
                "currency": "PEN"
            },
            "description": ""
        },
        "operation": {
            "id": 631,
            "type": "refund",
            "status": "success",
            "date": "2021-03-17T09:10:26+0000",
            "created_date": "2021-03-17T09:10:18+0000",
            "request_id": "df5dd26de895be9a74c65f533e61bb815b1a...0001",
            "sum_initial": {
                "amount": 10000,
                "currency": "PEN"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "PEN"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 5031,
                "payment_id": "810ac3775591395706e9c305dd91fe5e",
                "auth_code": "",
                "date": "2021-03-17T09:10:20+0000"
            }
        },
        "signature": "B5z9XqJ6X9SaFYcrHArxvbu93Z+r4HrqnoxUa...B9PIgCPzQ=="
    }
}

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

{
        "project_id": 7890,
        "payment": {
            "id": "EP19be-c3fe",
            "type": "purchase",
            "status": "refunded",
            "date": "2021-03-17T09:23:18+0000",
            "method": "pagoefectivo",
            "sum": {
                "amount": 10000,
                "currency": "PEN"
            },
            "description": ""
        },
        "operation": {
            "id": 634,
            "type": "refund",
            "status": "decline",
            "date": "2021-03-17T09:23:19+0000",
            "created_date": "2021-03-17T09:23:09+0000",
            "request_id": "4015c379d1d7a39a0b8e1a7b310e1ae0a...0001",
            "sum_initial": {
                "amount": 10000,
                "currency": "PEN"
            },
            "sum_converted": {
                "amount": 10000,
                "currency": "PEN"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 5031,
                "payment_id": "9228a20821b0f9...e944062",
                "auth_code": "",
                "date": "2021-03-17T09:23:11+0000"
            }
        },
        "signature": "YYS5iX2SB/15kBmw9WX7G4qSSDS/9h0eThnKy...e1yjp5fjJw=="
    }
}

Related topics

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

• Synchronous and asynchronous message processing
• Signature generation and verification
• Payment types, operations and payments
• Operation statuses and response codes

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.