Search

Are you looking for test card numbers?

Would you like to contact support?

Payment-method icon

Vietnamese online banking Component

Add Vietnamese online banking through MoMo ATM to an existing Components integration.

Our MoMo ATM Component renders MoMo ATM in your payment form. When making an MoMo ATM payment, you additionally need to use createFromAction to handle the redirect to MoMo ATM and back to your website.

Before you begin

This page explains how to add MoMo ATM to your existing Web Components integration. The Web 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, and created an instance of AdyenCheckout.
  2. Add MoMo ATM in your test Customer Area.

Show MoMo ATM in your payment form

To present the MoMo ATM Component in your payment form:

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

  2. Pass the full response to the paymentMethodsResponse object when creating an instance of the AdyenCheckout.

  3. Add the MoMo ATM Component:
    a. Create a DOM element for MoMo ATM, placing it where you want the form to be rendered:

    <div id="momo_atm-container"></div>

    b. Create an instance of the MoMo ATM Component, and mount it.

     const momo_atm = checkout.create('momo_atm').mount('#momo_atm-container');

Make a payment

When the shopper selects to pay, the Component calls the onChange event, which contains a state.data.

  1. If state.isValid is true, collect the state.data and pass this to your server.

  2. From your server, make a /payments, specifying:

    • paymentMethod: The state.data.paymentMethod from the onChange event from your front end.
    • returnUrl: The URL where the shopper will be redirected back to after completing the payment. This URL can have a maximum of 1024 characters and should include the protocol such as http:// or https://. For example, https://your-company.com/checkout/. You can also include your own additional query parameters, for example, shopper ID or order reference number.
    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:state.data.paymentMethod from onSubmit}paymentMethod{/hint}":{
        "type":"momo_atm"
      },
      "returnUrl":"https://your-company.com/checkout?shopperOrder=12xy.."
    }'
    # 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 => "https://your-company.com/checkout?shopperOrder=12xy..",
      :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("https://your-company.com/checkout?shopperOrder=12xy..");
    
        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" => "https://your-company.com/checkout?shopperOrder=12xy..",
      "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': 'https://your-company.com/checkout?shopperOrder=12xy..',
       '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 = "momo_atm"
    };
    var paymentsRequest = new Model.Checkout.PaymentRequest
    {
      Reference = "YOUR_ORDER_NUMBER",
      Amount = amount,
      ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
      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: "https://your-company.com/checkout?shopperOrder=12xy.."
    }).then(res => res);

    The /payments response contains:

    • action.method: GET or POST. The HTTP request method that you should use. After the shopper completes the payment, they will be redirected back to your returnURL using the same method.
      The redirect method depends on your payment method configuration and the length of the data included in the request, so make sure that your integration can handle both HTTP GET and HTTP POST methods.

    To verify the payment result, you also need the following from the /payments response:

    • action.paymentData: Store this on your server — this is the paymentData value that you send in your /payments/details request.
    • details: Array of parameters that you need to send in your /payments/details request. For example, payload or redirectResult.
      The parameters can vary based on the payment method configuration. Make sure to check the details array to confirm the parameters that you need to send in your next API request.
    /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"
      }
    ],
    ...
    }
  3. Pass the action object to your front end.

Handle the redirect

  1. Call createFromAction and pass the action object from the previous step. This will return a new Component that you need to mount:
       checkout.createFromAction(action).mount('#my-container');

    The Component redirects the shopper to MoMo ATMto complete the payment.

  2. After the shopper is redirected back to your website, check the payment result by making a /payments/details request, specifying:

    • paymentData: Value you received in the /payments response.
    • details: Object that contains the URL-decoded values of the parameters that were returned when the shopper was redirected back to your site. For example, payload. To check the parameters that you should submit, refer to the details array that you received in the /payments response.

    /payments/details request
    {
      "paymentData":"Ab02b4c0!BQABAgCJN1wRZuGJmq8dMncmypvknj9s7l5Tj...",
      "details":{
        "{hint:Verify the parameters from /payments response}payload{/hint}":"Ab02b4c0!BQABAgCW5sxB4e/=="
      }
    }

    You receive a response containing:

    • resultCode: Use this to present the result to your shopper.
    • pspReference: Our unique identifier for the transaction.

    /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:

resultCode Description Action to take
Authorised The payment was successful. Inform the shopper that the payment has been successful.
Cancelled The shopper cancelled the payment while on MoMo ATM or NAPAS's website. Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Pending The shopper has completed the payment but the final result is not yet known. Inform the shopper that you've received their order, and are waiting for the payment to be completed.

To know the final result of the payment, wait for the AUTHORISATION notification webhook.
Refused The payment was refused by the shopper's bank. Ask the shopper to try the payment again using a different payment method.

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:

eventCode success field Description Action to take
AUTHORISATION false The transaction failed. Cancel the order and inform the shopper that the payment failed.
AUTHORISATION true The shopper successfully completed the payment. Inform the shopper that the payment has been successful and proceed with the order.
OFFER_CLOSED true The shopper did not complete the payment. Cancel the order and inform the shopper that the payment timed out.

Test and go live

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

Scenario Card name Card number Expiry One-time password
Successful Nguyen Van A 9704000000000018 03/07 otp
Card blocked Nguyen Van A 9704000000000026 03/07 otp
Insufficient funds Nguyen Van A 9704000000000034 03/07 otp
Amount exceeded limit Nguyen Van A 9704000000000042 03/07 otp

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