BancaNet Directo
BancaNet Directo is an online banking solution from Banamex. When payers select BancaNet Directo as their payment method, they are redirected to their BancaNet Directo Online Banking site where they can transfer the money to the merchant account. The transfer is immediate and there is no support for subsequent operations, e.g., Void, Refund, etc.
BancaNet is a supported browser payment method. This page describes integration details specific to BancaNet Directo including how to set up an account with BancaNet Directo. For a general overview of browser payments, and how to integrate a browser payment method with the Mastercard Gateway, see Implementing a Browser Payment Integration.
Prerequisites
To use BancaNet Directo as a payment method:
- You must have a bank account in a currency supported by the gateway for BancaNet Directo — MXN or USD.
- You must register with Banamex and sign a BancaNet Directo contract. The payer must have an online banking account with BancaNet Directo.
Registering with BancaNet Directo
During registration, you must specify the following data, which must be agreed upon with the Mastercard Gateway.
Merchant Domain URL
: This is the source URL used to redirect the payer's browser to BancaNet Directo online banking website. Use https://test-nbe.gateway.mastercard.com/api/bpui/bn/out/Merchant Destination URL
: This is the destination URL to which the payer's browser is redirected after successfully completing the payment at BancaNet Directo online banking website. Use https://test-nbe.gateway.mastercard.com/api/bpui/bn/in/
After registering with BancaNet, you need to provide the following BancaNet Directo account details to your payment service provider:
- Merchant Acquirer ID is the Banamex Electronic Banking ID that you specified when signing the BancaNet Directo contract
- Bank account details of the account to which the funds are transferred from the payer's account.
- Identifier for the bank account
- Account Number of the bank account
- Currency configured for the bank account
- Payment Reference Type is the format of the payment reference that you specified when signing the BancaNet Directo contract. For example, Numerical, Alphanumerical, etc.
- Business Number (only required if the payment reference type is "Capture Line B")
- Deposit Sequence as specified when signing the BancaNet Directo contract.
Using these details, your payment service provider will complete the configuration in Merchant Manager.
Adding BancaNet Directo to Your Integration
You can add BancaNet Directo to your integration using the following integration options.
If you are using the gateway's payment page (Hosted Checkout), BancaNet Directo will automatically be offered as a checkout option to your payers if:
- your payment service provider has configured the BancaNet acquirer link on your merchant profile.
- you are using API version 11 or above.
For details, see Browser Payments via Hosted Checkout Integration.
However, if you would like to support the Payment Reference Type "Capture Line A", you must provide the BancaNet fields when submitting the Create Checkout Session request to the gateway. Note that you must use API version 59 or higher when you submit this request.
Example Create Checkout Session request
URL | https://test-nbe.gateway.mastercard.com/api/rest/version/72/merchant/{merchantId}/session |
HTTP Method | POST |
{ "apiOperation": "CREATE_CHECKOUT_SESSION", "interaction" : { "operation" : "AUTHORIZE", "merchant" : { "url" : "https://example.com", "name" : "CaptureLine_A_Test" } }, "order" : { "id": "test1239089", "currency" : "USD" }, "transaction": { "bancanet": { "merchantPaymentReference":"Testing", "paymentDueDate":"2022-01-30", "paymentReason": "pay@test" } } }
Direct Payment integration allows you to offer BancaNet Directo payment method on your own checkout page if you use API version 11 or above.
To add BancaNet Directo to your Direct Payment integration, provide the following fields in the Initiate Browser Payment request in addition to the standard fields required for a Browser Payments via Direct Payment Integration.
sourceOfFunds.type
=BANCANET
- See BancaNet Directo fields
BancaNet Directo Fields
transaction.bancanet.paymentDueDate
: (Optional) The date by when the payer should make the payment.transaction.bancanet.paymentReason
: (Optional) The reason for the payment, for example, "Pago de tarjeta". The reason is displayed to the payer on the BancaNet Directo website.-
transaction.bancanet.merchantPaymentReference
: (Optional) The payment reference for the payment. The gateway generates the payment reference based on the BancaNet payment reference type configured on your merchant profile; however, with some conditions.Payment Reference Type Merchant Payment Reference Condition 1 - Numerical The gateway uses the MOD-97 algorithm to generate the payment reference. The MOD-97 algorithm uses the following data to compute the reference: - The bank identifer as configured on your gateway merchant profile
- The bank account number as configured on your gateway merchant profile
- An automatically generated numerical reference
- An automatically generated alphanumerical reference
- Check digit
You must be configured on BancaNet for the MOD-97 algorithm. If not, BancaNet does not accept the payment reference sent by the gateway as a valid reference and rejects the payment. 2 - Alphanumerical 3 - Both Numerical and Alphanumerical 4 - Capture Line A The generation of the payment reference is not supported by the gateway. If you do not supply a value, the gateway rejects the payment. - 5 - Capture Line B The gateway uses the Type Zero algorithm to generate the payment reference. The Type Zero algorithm uses the following data to compute the reference: - The business number as onfigured on your gateway merchant profile
- The value for the
transaction.reference
as supplied by you - Check digit
If you do not provide a value for the field "transaction.reference" and/or if you are not configured on BancaNet for the Type Zero algorithm, the gateway rejects the payment.
Example Initiate Browser Payment request
URL | https://test-nbe.gateway.mastercard.com/api/rest/version/72/merchant/{merchantId}/order/{orderid}/transaction/{transactionid} |
HTTP Method | PUT |
{ "apiOperation" : "INITIATE_BROWSER_PAYMENT", "browserPayment" : { "operation" : "PAY", "returnUrl" : "<returnURL>" }, "order" : { "amount" : "399", "currency" : "MXN" }, "sourceOfFunds" : { "type" : "BANCANET" }, "transaction" : { "reference": null, "bancanet" : { "merchantPaymentReference" : "131234345", "paymentReason" : "test" } } }
How to Interpret the Transaction Result
BancaNet Directo redirects the payer's browser to the return URL (provided by you when initiating the payment) only upon successful completion of the payment at the BancaNet Directo website. In any other case (for example, the payment is cancelled or the browser is lost after payment completion), BancaNet Directo does not return the browser to your website.
The table below shows the transaction response codes for the possible scenarios you may encounter after initiating a browser payment.
Initiate Browser Payment Response | What This Means... |
---|---|
response.gatewayCode=SUBMITTED result=SUCCESS |
Redirect the payer using the URL provided in the response. |
Retrieve Transaction/Retrieve Order Response | What This Means... |
response.gatewayCode=APPROVED result=SUCCESS
|
The payment is successful. |
response.gatewayCode=UNKNOWN result=FAILURE
|
The gateway was unable to find out if the payment was successful or not. |