Vietnamese online banking Redirect Component

If you have an existing iOS Components integration, you can use our Redirect Component to redirect the shopper to MoMo ATM to complete the payment.

When making an MoMo ATM payment, you need to:

• Include MoMo ATM in the list of available payment methods.
• Handle the redirect.

Before you begin

This page explains how to add MoMo ATM to your existing iOS Components integration. The iOS Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your MoMo ATM integration:

1. Make sure that you have set up your back end implementation for making API requests.
2. Add MoMo ATM in your test Customer Area.

Show MoMo ATM in your payment form

Include MoMo ATM in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.

1. Specify in your /paymentMethods request:
   • countryCode: VN
   • amount.currency: VND
   • amount.value: The value of the payment.

The response contains paymentMethod.type: momo_atm.

Make a payment

When the shopper proceeds to pay, you need to:

1. From your server, make a /payments request, specifying:

   • paymentMethod.type: Set this to momo_atm to redirect to the MoMo ATM mobile app or website.
   • returnUrl: The URL where the shopper will be redirected back to after completing the payment. This URL can have a maximum of 1024 characters. Use the custom URL for your app, for example, my-app://. For more information on setting custom URL schemes, refer to the Apple Developer documentation.
   https://docs.adyen.com/payment-methods/vietnamese-online-banking/ios-component#ios-payments

   • curl
   • Ruby
   • Java
   • PHP
   • Python
   • C#
   • NodeJS

   curl Ruby Java PHP Python C# NodeJS

   curl https://checkout-test.adyen.com/v52/payments \
   -H "x-API-key: YOUR_X-API-KEY" \
   -H "content-type: application/json" \
   -d '{
     "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
     "reference":"YOUR_ORDER_NUMBER",
     "amount":{
       "currency":"VND",
       "value":1000
     },
     "{hint:data.paymentMethod from didSubmit}paymentMethod{/hint}":{
       "type":"momo_atm"
     },
     "returnUrl":"my-app://"
   }'

   # Set your X-API-KEY with the API key from the Customer Area.
   adyen = Adyen::Client.new
   adyen.api_key = "YOUR_X-API-KEY"
    
   response = adyen.checkout.payments({
     :amount => {
       :currency => "VND",
       :value => 1000
     },
     :reference => "YOUR_ORDER_NUMBER",
     :paymentMethod => {
       :type => "momo_atm"
     },
     :returnUrl => "my-app://",
     :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
   })

   // Set YOUR_X-API-KEY with the API key from the Customer Area.
   // Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
       Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
       Checkout checkout = new Checkout(client);
   
       PaymentsRequest paymentsRequest = new PaymentsRequest();
   
       String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
       paymentsRequest.setMerchantAccount(merchantAccount);
   
       Amount amount = new Amount();
       amount.setCurrency("VND");
       amount.setValue(15000L);
       paymentsRequest.setAmount(amount);
   
       DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
       paymentMethodDetails.setType("momo_atm");
       paymentsRequest.setPaymentMethod(paymentMethodDetails);
   
       paymentsRequest.setReference("YOUR_ORDER_NUMBER");
       paymentsRequest.setReturnUrl("my-app://");
   
       PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);

   // Set your X-API-KEY with the API key from the Customer Area.
   $client = new \Adyen\Client();
   $client->setXApiKey("YOUR_X-API-KEY");
   $service = new \Adyen\Service\Checkout($client);
   
   $params = array(
     "amount" => array(
       "currency" => "VND",
       "value" => 1000
     ),
     "reference" => "YOUR_ORDER_NUMBER",
     "paymentMethod" => array(
       "type" => "momo_atm"
     ),
     "returnUrl" => "my-app://",
     "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
   );
   $result = $service->payments($params);

   #Set your X-API-KEY with the API key from the Customer Area.
   adyen = Adyen.Adyen()
   adyen.client.xapikey = 'YOUR_X-API-KEY'
   
   result = adyen.checkout.payments({
      'amount': {
         'value': 1000,
         'currency': 'VND'
      },
      'reference': 'YOUR_ORDER_NUMBER',
      'paymentMethod': {
         'type': 'momo_atm'
      },
      'returnUrl': 'my-app://',
      'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
   })

   // Set your X-API-KEY with the API key from the Customer Area.
   var client = new Client ("YOUR_X-API-KEY", Environment.Test);
   var checkout = new Checkout(client);
   
   var amount = new Model.Checkout.Amount("VND", 1000);
   var details = new Model.Checkout.DefaultPaymentMethodDetails{
     Type = "sofort"
   };
   var paymentsRequest = new Model.Checkout.PaymentRequest
   {
     Reference = "YOUR_ORDER_NUMBER",
     Amount = amount,
     ReturnUrl = @"momo_atm",
     MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
     PaymentMethod = details
   };
   
   var paymentResponse = checkout.Payments(paymentsRequest);

   // Set your X-API-KEY with the API key from the Customer Area.
   const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
   const config = new Config();
   // Set your X-API-KEY with the API key from the Customer Area.
   config.apiKey = '[API_KEY]';
   config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
   const client = new Client({ config });
   client.setEnvironment("TEST");
   const checkout = new CheckoutAPI(client);
   checkout.payments({
       amount: { currency: "VND", value: 1000 },
       paymentMethod: {
           type: 'momo_atm'
       },
       reference: "YOUR_ORDER_NUMBER",
       merchantAccount: config.merchantAccount,
       returnUrl: "my-app://"
   }).then(res => res);

   The /payments response contains:

   • action: Object containing information about the redirect.
   https://docs.adyen.com/payment-methods/vietnamese-online-banking/ios-component#-payments-response

   /payments response

   {
      "resultCode":"RedirectShopper",
      "action":{
         "method":"GET",
         "paymentData":"Ab02b4c0!BQABAgCSZT7t...",
         "paymentMethodType":"momo_atm",
         "type":"redirect",
         "url":"https://test.adyen.com/hpp/redirect.shtml?brandCode=.."
      },
      "details":[
         {
            "key":"payload",
            "type":"text"
         }
      ],
      ...
   }
2. Pass the action object to your client app.

Handle the redirect

1. Use the Redirect Component to redirect the shopper to MoMo ATM.

2. After the shopper returns to your app, make a POST /payments/details request from your server and provide the data from the didProvide method from your client app.
   

   https://docs.adyen.com/payment-methods/gcash/ios-component#-payments-details-request

   /payments/details request

     {
      "{hint:data.paymentData from didProvide}paymentData{/hint}":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
      "{hint:data.details from didProvide}details{/hint}":{
        "payload":"Ab02b4c0!BQABAgCW5sxB4e/=="
      }
   }

   You receive a response containing:

   • resultCode: Use this to present the result to your shopper.
   • pspReference: Our unique identifier for the transaction.
   https://docs.adyen.com/payment-methods/gcash/ios-component#-payments-details-response

   /payments/details response

   {
   "resultCode": "Authorised",
   "pspReference": "88154795347618C"
   }

Present the payment result

Use the resultCode that you received in the /payments/details response to present the payment result to your shopper.

The resultCode values you can receive for MoMo ATM are:

If the shopper closed the browser and failed to return to your website, wait for notification webhooks to know the outcome of the payment. The notification webhooks you can receive for MoMo ATM are:

Test and go live

To test MoMo ATM payments, select any bank from the list and use the following test cards and credentials:

Check the status of MoMo ATM test payments in your Customer Area > Transactions > Payments.

Before you can accept live MoMo ATM payments, you need to submit a request for MoMo ATM in your live Customer Area.

See also