- METHOD TYPEBank Transfer
- PAYMENTS
- PAYOUTS
- REFUNDS
- RECURRING
Introduction
Banco Azteca is a Mexican bank with 1,500 branches throughout Central and South America. Offers loans, credit cards, financing, and payroll services. Online banking is secured with tokenization and digital fingerprints.
Supported Countries
- Mexico
Supported Currencies
- MXN
Payment (Deposit) Flow
Press tab to open…
Follow these steps to perform a payment using Nuvei REST API integration:
1. Generate a sessionToken
Press here for details.
2. Send a /payment
Request
Perform the payment by sending a /payment
request with its mandatory parameters including:
userTokenId
amount
currency
paymentOption.alternativePaymentMethod
block containing:paymentMethod
: “apmgw_Banco_Azteca“
deviceDetails
block containing:ipAddress
billingAddress
block containing:firstname
,lastname
,country
,email
userDetails
block containing:firstname
,lastname
,country
,email
Example /payment
Request
{ "sessionToken": "<sessionToken from /getSessionToken>", "merchantId": "<your merchantId>", "merchantSiteId": "<your merchantSiteId>", "userTokenId": "<unique customer identifier in merchant system>", "paymentOption": { "alternativePaymentMethod": { "paymentMethod": "apmgw_Banco_Azteca", } }, "currency": "MXN", "amount": "100", "deviceDetails": {"ipAddress": "<customer's IP address>"}, "billingAddress": { "firstName": "John", "lastName": "Smith", "email": "[email protected]", "country": "MX" }, "userDetails": { "firstName": "John", "lastName": "Smith", "email": "[email protected]", "country": "MX", }, "timeStamp": "<YYYYMMDDHHmmss>", "checksum": "<calculated checksum>" }
The response generates and returns a redirect URL (redirectUrl
) to redirect the customer to the payment page, as well as a UPO (userPaymentOptionId
) for use in future transactions.
Example /payment
Response
{ "orderId": "39143501", "userTokenId": "<unique customer identifier in merchant system>", "paymentOption": { "redirectUrl": "https://apmtest.gate2shop.com/ppp/resources/cdn/v1/qr-code-41205.html?qrCodeSource=https%3A%2F%2Fmedia.dapp.mx%2Fcobros%2F7ecb3973a2524cf291e71fc362ff7af2_1712729069.jpg&description=Test&amount=555.55¤cy=MXN&reference=529269&returnUrl=https%3A%2F%2Fjumpbox.safecharge.com%2Fdmz%2FApmConnector%2F4AE2FAB7F92FDE6E8FD8CF20E9A8CF8F&country=MX&locale=en_MX&creationDate=2024-04-10T06%3A04%3A29.630039Z&expirationDate=2024-04-10T06%3A05%3A29.574578Z&wss=wss%3A%2F%2Fsrv-bsf-websock.gw-4u.com%2Fws&sessionId=69b916cda2fc313ec0cf270a5b2a&mode=1&merchantLogoUrl=https%3A%2F%2Fsecure.safecharge.com%2Fppp%2Fresources%2Fimg%2Fsvg%2Fcross_bank_qr.svg", "userPaymentOptionId": "2152905171", "card": {} }, "transactionStatus": "REDIRECT", "sessionToken": "sessionToken from /getSessionToken", "internalRequestId": 26441241, "status": "SUCCESS", "errCode": 0, "reason": "", "merchantId": "<your merchantId>", "merchantSiteId": "<your merchantSiteId>", "version": "1.0" }
Example Payment Page Request
After the transaction is processed, Nuvei sends a Direct Merchant Notification (DMN) that includes the result of the transaction to urlDetails.notificationUrl
, which Nuvei recommends including in the /payment
request.
- REST API
-
Follow these steps to perform a payment using Nuvei REST API integration:
1. Generate a
sessionToken
Press here for details.
2. Send a
/payment
RequestPerform the payment by sending a
/payment
request with its mandatory parameters including:userTokenId
amount
currency
paymentOption.alternativePaymentMethod
block containing:paymentMethod
: “apmgw_Banco_Azteca“
deviceDetails
block containing:ipAddress
billingAddress
block containing:firstname
,lastname
,country
,email
userDetails
block containing:firstname
,lastname
,country
,email
Example
/payment
Request{ "sessionToken": "<sessionToken from /getSessionToken>", "merchantId": "<your merchantId>", "merchantSiteId": "<your merchantSiteId>", "userTokenId": "<unique customer identifier in merchant system>", "paymentOption": { "alternativePaymentMethod": { "paymentMethod": "apmgw_Banco_Azteca", } }, "currency": "MXN", "amount": "100", "deviceDetails": {"ipAddress": "<customer's IP address>"}, "billingAddress": { "firstName": "John", "lastName": "Smith", "email": "[email protected]", "country": "MX" }, "userDetails": { "firstName": "John", "lastName": "Smith", "email": "[email protected]", "country": "MX", }, "timeStamp": "<YYYYMMDDHHmmss>", "checksum": "<calculated checksum>" }
The response generates and returns a redirect URL (
redirectUrl
) to redirect the customer to the payment page, as well as a UPO (userPaymentOptionId
) for use in future transactions.Example
/payment
Response{ "orderId": "39143501", "userTokenId": "<unique customer identifier in merchant system>", "paymentOption": { "redirectUrl": "https://apmtest.gate2shop.com/ppp/resources/cdn/v1/qr-code-41205.html?qrCodeSource=https%3A%2F%2Fmedia.dapp.mx%2Fcobros%2F7ecb3973a2524cf291e71fc362ff7af2_1712729069.jpg&description=Test&amount=555.55¤cy=MXN&reference=529269&returnUrl=https%3A%2F%2Fjumpbox.safecharge.com%2Fdmz%2FApmConnector%2F4AE2FAB7F92FDE6E8FD8CF20E9A8CF8F&country=MX&locale=en_MX&creationDate=2024-04-10T06%3A04%3A29.630039Z&expirationDate=2024-04-10T06%3A05%3A29.574578Z&wss=wss%3A%2F%2Fsrv-bsf-websock.gw-4u.com%2Fws&sessionId=69b916cda2fc313ec0cf270a5b2a&mode=1&merchantLogoUrl=https%3A%2F%2Fsecure.safecharge.com%2Fppp%2Fresources%2Fimg%2Fsvg%2Fcross_bank_qr.svg", "userPaymentOptionId": "2152905171", "card": {} }, "transactionStatus": "REDIRECT", "sessionToken": "sessionToken from /getSessionToken", "internalRequestId": 26441241, "status": "SUCCESS", "errCode": 0, "reason": "", "merchantId": "<your merchantId>", "merchantSiteId": "<your merchantSiteId>", "version": "1.0" }
- Payment Page
-
Example Payment Page Request
After the transaction is processed, Nuvei sends a Direct Merchant Notification (DMN) that includes the result of the transaction to
urlDetails.notificationUrl
, which Nuvei recommends including in the/payment
request.
Example Payment DMN with Status
=APPROVED
...'ppp_status=OK&Status=APPROVED&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=0&PPP_TransactionID=42849621&userid=noUPOTestViaRest&merchant_unique_id=20240410090428&customData=&productId=&first_name=Test&last_name=Test+test&email=test%40test.com¤cy=MXN&clientUniqueId=20240410090428&customField1=&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=9408+Peachtree+Dunwoody+Rd&address2=&country=Mexico&state=&city=Atlanta&zip=30328&phone1=972528809741&phone2=&phone3=&client_ip=192.168.2.38&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=&acquirerBank=DAPP+MX-PI&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=&shippingState=&shippingCity=&shippingAddress=&shippingZip=&shippingFirstName=&shippingLastName=&shippingPhone=&shippingCell=&shippingMail=&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=253281&merchant_status=&action=&requestVersion=&message=APPROVED&merchantLocale=&unknownParameters=&payment_method=apmgw_Banco_Azteca&ID=&merchant_id=2716997754195194041&responseTimeStamp=2024-04-10.06%3A05%3A11&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Sale&externalEmail=&cardCompany=&eci=&user_token_id=noUPOTestViaRest&userPaymentOptionId=2153186111&TransactionID=2610000000000019076&externalTransactionId=_1rCzwWx&APMReferenceID=4AE2FAB7F92FDE6E8FD8CF20E9A8CF8F&orderTransactionId=24272691&totalAmount=555.55&dynamicDescriptor=QA+Test+site&item_name_1=NA&item_number_1=&item_amount_1=555.55&item_quantity_1=1&item_discount_1=0.00&item_handling_1=0.00&item_shipping_1=0.00&feeAmount=&amountWithoutFee=&houseNumber=&customCurrency=&externalToken_blockedCard=&externalToken_cardAcquirerId=&externalToken_cardAcquirerName=&externalToken_cardBin=&externalToken_cardBrandId=&externalToken_cardBrandName=&externalToken_cardExpiration=&externalToken_cardLength=&externalToken_cardMask=&externalToken_cardName=&externalToken_cardTypeId=&externalToken_cardTypeName=&externalToken_clubName=&externalToken_creditCompanyId=&externalToken_creditCompanyName=&externalToken_extendedCardType=&externalToken_Indication=&externalToken_tokenValue=&externalToken_tokenProvider=&ECIRaw=&cryptogram=&upoRegistrationDate=20240410&type=DEPOSIT&clientRequestId=20240410090428&relatedTransactionId=&sessionId=69b916cda2fc313ec0cf270a5b2a&responsechecksum=721e47867bafce98c23ad1b6436591ff&advanceResponseChecksum=6da8e1e3544c2cdd25ddf8f912debc8c',
Example Payment DMN with Status
=PENDING
...'ppp_status=PENDING&Status=PENDING&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=0&PPP_TransactionID=42307431&userid=ScMigrationTest3&merchant_unique_id=97c10831-d399-48d7-8ea5-41f89619d2fa6&customData=DimitarMerchant&productId=test_name_1&first_name=John&last_name=Doe&email=john.doe%40gmail.com¤cy=MXN&customField1=meccabingo.com&customField2=a2db82db-8186-44bb-a6d9-cb9f8f7ea25e&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=rnk_pr01&invoice_id=&address1=Test+Address&address2=2992&country=Mexico&state=&city=Atlanta&zip=30328&phone1=13094526617&phone2=&phone3=&client_ip=127.0.0.1&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=&acquirerBank=DAPP+MX-PI&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=&shippingState=&shippingCity=&shippingAddress=&shippingZip=&shippingFirstName=&shippingLastName=&shippingPhone=&shippingCell=&shippingMail=&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=253281&merchant_status=&action=&requestVersion=&message=PENDING&merchantLocale=en_US&unknownParameters=&payment_method=apmgw_Banco_Azteca&ID=&merchant_id=2716997754195194041&responseTimeStamp=2024-04-02.10%3A39%3A37&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Sale&externalEmail=&cardCompany=&eci=&user_token_id=testTesttestTest123455566777888&user_token=auto&userPaymentOptionId=2153167161&TransactionID=2610000000000016859&APMReferenceID=E3E0938B867F5058171BDAAC314BEE91&orderTransactionId=23741341&totalAmount=11.00&dynamicDescriptor=QA+Test+site&item_name_1=test_name_1&item_number_1=&item_amount_1=11.00&item_quantity_1=1&item_discount_1=0.00&item_handling_1=0.00&item_shipping_1=0.00&feeAmount=&amountWithoutFee=&houseNumber=&customCurrency=&externalToken_blockedCard=&externalToken_cardAcquirerId=&externalToken_cardAcquirerName=&externalToken_cardBin=&externalToken_cardBrandId=&externalToken_cardBrandName=&externalToken_cardExpiration=&externalToken_cardLength=&externalToken_cardMask=&externalToken_cardName=&externalToken_cardTypeId=&externalToken_cardTypeName=&externalToken_clubName=&externalToken_creditCompanyId=&externalToken_creditCompanyName=&externalToken_extendedCardType=&externalToken_Indication=&externalToken_tokenValue=&externalToken_tokenProvider=&ECIRaw=&cryptogram=&upoRegistrationDate=20240313&type=DEPOSIT&clientRequestId=&relatedTransactionId=&sessionId=e6295397bb13afe5bcbeb98fee05&responsechecksum=80211c105a56080d0136514a892778ff&advanceResponseChecksum=0aa1089137e6a4a0a7346e209169f6d0',
Example Payment DMN with Status
=DECLINED
...'ppp_status=FAIL&Status=DECLINED&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=9999&errScDescription=Default&Reason=Default&ReasonCode=9999&PPP_TransactionID=42307431&userid=ScMigrationTest3&merchant_unique_id=97c10831-d399-48d7-8ea5-41f89619d2fa6&customData=DimitarMerchant&productId=test_name_1&first_name=John&last_name=Doe&email=john.doe%40gmail.com¤cy=MXN&customField1=meccabingo.com&customField2=a2db82db-8186-44bb-a6d9-cb9f8f7ea25e&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=rnk_pr01&invoice_id=&address1=Test+Address&address2=2992&country=Mexico&state=&city=Atlanta&zip=30328&phone1=13094526617&phone2=&phone3=&client_ip=127.0.0.1&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=&acquirerBank=DAPP+MX-PI&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=&shippingState=&shippingCity=&shippingAddress=&shippingZip=&shippingFirstName=&shippingLastName=&shippingPhone=&shippingCell=&shippingMail=&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=253281&merchant_status=&action=&requestVersion=&message=DECLINED&merchantLocale=en_US&unknownParameters=&payment_method=apmgw_Banco_Azteca&ID=&merchant_id=2716997754195194041&responseTimeStamp=2024-04-02.10%3A56%3A29&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Sale&externalEmail=&cardCompany=&eci=&user_token_id=testTesttestTest123455566777888&user_token=auto&userPaymentOptionId=2153167161&TransactionID=2610000000000016859&externalTransactionId=_rL1pzor&APMReferenceID=E3E0938B867F5058171BDAAC314BEE91&orderTransactionId=23741341&totalAmount=11.00&dynamicDescriptor=QA+Test+site&item_name_1=test_name_1&item_number_1=&item_amount_1=11.00&item_quantity_1=1&item_discount_1=0.00&item_handling_1=0.00&item_shipping_1=0.00&feeAmount=&amountWithoutFee=&houseNumber=&customCurrency=&externalToken_blockedCard=&externalToken_cardAcquirerId=&externalToken_cardAcquirerName=&externalToken_cardBin=&externalToken_cardBrandId=&externalToken_cardBrandName=&externalToken_cardExpiration=&externalToken_cardLength=&externalToken_cardMask=&externalToken_cardName=&externalToken_cardTypeId=&externalToken_cardTypeName=&externalToken_clubName=&externalToken_creditCompanyId=&externalToken_creditCompanyName=&externalToken_extendedCardType=&externalToken_Indication=&externalToken_tokenValue=&externalToken_tokenProvider=&ECIRaw=&cryptogram=&upoRegistrationDate=20240313&type=DEPOSIT&clientRequestId=&relatedTransactionId=&sessionId=e6295397bb13afe5bcbeb98fee05&responsechecksum=4666cbd0dde213467dbf57c7ddb76293&advanceResponseChecksum=e60bcd15afcdafc1e88e0aba969f53f5',
User Experience
QR Code – Desktop
The user is redirected to a page hosted by Nuvei. A QR code appears on the page.
QR Code – Mobile
- The user is redirected to a page hosted by the provider.
- Tap the Banco Azteca icon.
The device type determines the subsequent experience.
flow, not user selection.