Paynet Paynet through Openpay is a payment provider allowing customers to pay using payment methods saved to their Paynet account. This section is intended to help you implement Paynet based on your preferred integration workflow.

Services and compatibility


Payment method gateway name	Openpay
Supported transaction types	Sale ( API / Tutorial )
Supported integration methods	Iframe ( multi or individual ) Custom redirect
Supported processing currencies	MXN
Webhook event types	TRANSACTION_PENDING TRANSACTION_SETTLED

Gateway-specific information

Work with Integrations Support to configure your Openpay gateway credentials in Nexio for the Extract-Transform-Load (ETL) process, which is important for keeping the transaction statuses in sync with Openpay.

The source ID (Openpay token) is auto-assigned through Nexio. This is only supported if the TokenEx account is owned by Nexio.

Configuring and utilizing webhooks is necessary as part of the Paynet workflow. For information about webhooks, see Webhooks and event types.

The following are not supported with Openpay:

Kount

Configuration

Apart from working with Integrations to add Paynet as a payment method, you do not need to do any other configuration steps.

Integration flow

The general integration flow is the same for all APMs and depends on which APMs you want to integrate with.

First, the decision about which APMs to use affects the possible integration methods and the required parameters for the APM one-time-use token request. Use the information from this integration guide with the information from any other applicable integration guides as you plan your integration. In order to integrate an APM after it has been added to your merchant account, you need to decide which integration method you want to use, which may be dependent on the method you have used with other APMs. Note that you can mix and match those methods for each APM but your page may not look as usable or clear as when using a single method. There are pros and cons to each method. For additional information, see the Supported integration methods for APMs topic.

After deciding on the integration method, you need to make sure that you know which currencies are supported (for an overview of all APMs, see Supported currencies for APMs) and which parameters are required in a request. This is especially important for integrations with multiple APMs. Make sure that all the required parameters are accounted for across all the APMs used. For an overview of common parameters across the APMs, see Common required parameters.

You also need to decide whether you want to specify where you want the APM to return the customer after they pay or just to the page that opened the APM payment page. If you specify a page, you must include the customerRedirectUrl parameter in the APM one-time-use token request, you need to create that page on your site, and you need to create the code for the page that parses the query string parameters passed along with that redirect URL. Note that you must use this option when using the custom integration method. If you use the referring page, that page needs to listen for event messages.

In addition to either of the previous options, you should also configure webhooks to get event messages. This is especially helpful for instances where the APM process fails or there are problems with a transaction request.

Next, decide on where you are displaying the APM as a payment option (on a product page, shopping cart page, checkout page, or some combination of those. For example, PayPal (with Braintree) has a “Continue button” flow that you can use on a shopping cart page, which may affect how you integrate.

On each page where you are putting the APM option, first you need an APM one-time-use token. This is where you can send most of the required parameters. If necessary, you can also send customization options for the iframe display (whether multi or individual). This returns URLs and an APM token that you use for the integration method you want. Use this URL for the iframe or link. Each APM gets a different URL (except for the multi-iframe method, which gets one for all APMs that are supported).

You will also want to note the asyncTraceId (it is the same for all APMs returned from the APM one-time-use token) because you can use that to track the status of the transaction and narrow down the problem when troubleshooting.

Many of the APMs open a new webpage when the customer selects to pay using that method. The ideal payment flow returns control to the merchant website after the customer authenticates and pays from the APM website. As mentioned previously, your integration needs to include code that gets the data returned from the APM. This will be in the URL query parameters or as event messages or as webhooks. Use this information for display a payment success or failure message for the customer.

Required fields

The following table shows the required and conditional fields for Paynet transactions in the Create APM one-time-use token request.

Field	Required?	Description
`data.amount`	Yes	The transaction amount.
`data.currency`	Yes	The three-character ISO currency code for the transaction. Paynet only supports `MXN` for the processing currency,
`data.customer.orderNumber`	Yes	The order number.
`data.customer.firstName`	Yes	The customer's first name, as it is set for the payment method.
`data.customer.lastName`	Yes	The customer's last name, as it is set for the payment method.
`data.customer.email`	Yes	The customer's email address.
`customerRedirectUrl`	No	The URL to which the customer will be redirected after completing their payment. The customer will be sent here upon successful or failed payment. This URL must use the HTTPS protocol.
`data.cart.items[n].item`	No	Item number or code.
`data.cart.items[n].description`	No	A description of the item.
`data.cart.items[n].quantity`	No	The quantity sold.
`data.cart.items[n].price`	No	The price per item.
`data.customer.billToAddressOne`	No	The street address for the customer.
`data.customer.billToAddressTwo`	No	Additional street address information, if required.
`data.customer.billToCity`	No	The city for the address record.
`data.customer.billToState`	No	The state or province on file with the payment provider. (If in the US, this must be the two-character state abbreviation).
`data.customer.billToPostal`	No	The postal code on file.
`data.customer.billToCountry`	No	The two-character (Alpha-2) ISO country code.
`data.customer.billToPhone`	No	The billing phone number.
`data.customer.birthDate`	No	The customer's date of birth. For specific details related to this parameter, see the Create APM one-time-use token endpoint. This parameter only applies for the Paynet and SPEI alternative payment methods.
`data.customer.customerRef`	No	Customer identifier. You can use this field to pass a customer ID to the APM or to manage user subscriptions.
`data.customer.invoice`	No	The invoice number.
`data.customer.shipToAddressOne`	No	The shipping address, if different from the billing address.
`data.customer.shipToAddressTwo`	No	Additional shipping address information, if required.
`data.customer.shipToCity`	No	The shipping city.
`data.customer.shipToState`	No	The shipping state or province. (If in the US, this must be the two-character state abbreviation).
`data.customer.shipToPostal`	No	The shipping postal code.
`data.customer.shipToCountry`	No	The two-character (Alpha-2) ISO shipping country code.
`data.customer.shipToPhone`	No	The shipping phone number.
`data.customFields`	No	Nexio stores information in custom fields and passes custom fields to the gateway.
`data.description`	No	A description of the transaction.
`data.descriptor`	No	Include this parameter to dynamically change the descriptor on the customer's statement.
`data.dueDate`	No	The date by which the customer must complete the payment. If the transaction is not settled before this date, it will be voided. If you do not provide a value, the system automatically sets the date to be 30 days from the current date. This parameter only applies for the Paynet and SPEI alternative payment methods.
`data.paymentMethod`	No	The identifier for the alternative payment method. Use this parameter when you want to only return the Paynet iframe button URL or the Paynet redirect URL (rather than data for all payment methods associated with the account). The value to use is `paynet`.
`data.totalTaxAmount`	No	Total tax amount.
`processingOptions.merchantId`	No	The Nexio merchant ID (MID).
`processingOptions.paymentOptionTag`	No	A custom value used to route transactions to a specific gateway or merchant account.
`uiOptions.displaySubmitButton`	No	Set to true to include a submit button in the iframe.
`uiOptions.css`	No	The URL where your custom CSS file is hosted.

Example requests

The following is an example one-time-use token request for Paynet.

curl -X POST https://api.nexiopaysandbox.com/apm/v3/token \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic [Base64_encoded_login]'
  -d '{
  "data": {
    "amount": 4.00,
    "currency": "MXN",
    "paymentMethod": "paynet",
    "customer": {
      "orderNumber": "12345678",
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]"
    }
  }
}'

{
  "expiration": "2018-09-18T15:43:05.664Z",
  "token": "830d36f6-a5e3-4455-9600-3a55b63e2fc2",
  "asyncTraceId": "830d36f6-a5e3-4455-9600-3a55b63e2fc2",
  "expressIFrameUrl": "https://www.api.nexiopaysandbox.com/v3?token=830d36f6-a5e3-4455-9600-3a55b63e2fc2",
  "redirectUrls": [
    {
      "paymentMethod": "paynet",
      "url": "https://www.api.nexiopaysandbox.com/v3/popup?token=830d36f6-a5e3-4455-9600-3a55b63e2fc2&paymentMethod=paynet"
    },
    {
      "paymentMethod": "payPal",
      "url": "https://www.api.nexiopaysandbox.com/v3/popup?token=830d36f6-a5e3-4455-9600-3a55b63e2fc2&paymentMethod=payPal"
    }
  ],
  "buttonIFrameUrls": [
    {
      "paymentMethod": "paynet",
      "url": "https://api.nexiopaysandbox.com/apm/v3?token=830d36f6-a5e3-4455-9600-3a55b63e2fc2&paymentMethod=paynet"
    },                   
    {
      "paymentMethod": "payPal",
      "url": "https://api.nexiopaysandbox.com/apm/v3?token=830d36f6-a5e3-4455-9600-3a55b63e2fc2&paymentMethod=payPal"
    }
  ]
}

For the multi iframe integration method: You use the expressIFrameUrl value in the steps for the transaction.

For the individual iframe option: You use the buttonIFrameUrls.url of the paynet APM for the transaction.

For the custom redirect option: You use the redirectUrls.url of the paynet APM for the transaction.

Transaction types and integration methods

Regardless of the integration method workflow you implement, consumers are redirected to Paynet to complete their transactions.

Nexio supports the following transaction types for Paynet:

Sale
- In an iframe that displays all payment methods available to the customer (based on the customer’s location and the merchant’s configured payment methods)
- In an individual iframe
- Using your own button or image

A page similar to the following displays when a user clicks the Paynet payment option. It contains instructions (in the user's default browser language) for how to use the voucher. The consumer can click the "Ver todas las tiendas afiliadas" button to see a list of participating stores. Or, click the "Localiza tu punto de pago más cercano" button to open a Paynet map site for their area to see payment sites close to them.

Testing data

For testing data, see Openpay's Pruebas [Tests] page.

Response handling

In the one-time-use token request, Paynet gets returned in the paymentMethod parameter as paynet.

Nexio responds with transaction results in one of the following ways, depending on your integration workflow:

Event messages: This applies to integrations that do not pass a customerRedirectUrl in the request.
Response fields in the URL: This applies to integrations that do provide a customerRedirectUrl in the request.

For information about how to run each of the integration workflows, see Transaction types and integration methods above.

Webhooks

In addition to one of the above, if your merchant account is configured to receive webhooks, Nexio provides responses to the webhook URLs that have been registered. For additional information about webhooks, see the Webhooks topic.

The response you get depends on the type of webhooks you have configured.

New - The new Nexio webhooks.
Legacy - The legacy webhooks.

New webhooks

For Paynet, the new webhook eventType will always be TRANSACTION with a processMethod value of 20 (for APMs).

Those TRANSACTION webhooks will also contain a numerical value for transactionStatus whenever that status changes. For specific information about the status values, see the Transaction status reference tables in the "Constant transaction values" topic. You can also reference the "Status workflows" table below.

For information about what information gets received in a webhook and how to use it, see the Receiving webhooks topic.

Legacy webhooks

For Paynet, these are the possible legacy webhook event types:

TRANSACTION_PENDING
TRANSACTION_SETTLED

For further explanation of the webhook event types, see the legacy webhook Event types table.

Status workflows

The status of a successful transaction with Paynet varies, depending on the options you choose.


Sale	Successful sale transactions have the following statuses: pending* settled

*Pending status displays as "authorized" or "AUTHORIZED" in the Nexio Dashboard; it displays as 10, meaning "authorized", in the response when querying transactions (for more information about transactionStatus, see the table).

Next steps

Now, you are ready to get started with running transactions:

Run a sale transaction

If you have any additional questions or feedback, see Contact us.