MoMo Wallet

Overview

Introduction

MoMo Wallet is a payment method which allows you to process payments in Vietnamese dongs using e-wallets in Vietnam. MoMo Wallet is available in Vietnam with 70% of the market share and around 5 million active users. MoMo Wallet accounts are linked to mobile phone numbers of the users. Funds can be added to the MoMo Wallet accounts by using bank transfers or credit cards, as well as by cash at MoMo stores across Vietnam. This method supports purchases.

This article provides information about working with the MoMo Wallet method: general insights are presented in the Overview section, while information about the actions required to process payments and perform other actions is presented in the sections that follow.

General information

Payment method type digital wallet payments
Payment instruments digital wallets
Countries and regions VN
Payment currencies VND
Currency conversion on the ecommpay side
One-time purchases +
Credential-on-file purchases –
Full refunds –
Partial refunds –
Payouts *
Chargebacks –
Notes
  • the lifetime of the qr code on the provider side is 10 minutes
  • * payouts are available for processing by using the Vietnamese Online Banking payment method.
Obtaining access to the payment method and access fee refer to your ecommpay key account manager

Interaction diagram

Payment processing by using the MoMo Wallet method involves the merchant's web service, one of ecommpay interfaces, the ecommpay payment platform, and technical facilities of the provider service.



Operations support

Various platform interfaces can be used to process payments and perform operations using the MoMo Wallet method. Purchases can be processed by using Payment Page, Gate and Dashboard (using payment links). At the same time, regardless of the interfaces used, the following properties and limitations are applicable.

The following properties and limitations apply to the MoMo Wallet method.

Amounts, VND Times ¹
minimum maximum basic threshold
Purchases 100,000 20,000,000 3 minutes 30 minutes
Note:
  1. The base and threshold times are defined as follows:
    • The base time is the average estimated time between the moment a payment is initiated in the payment platform to the moment the payment result is sent to the web service. The base time evaluation is made on the assumption of normal operation of all technical facilities and communication channels and typical customer behaviour (if any input from the customer is required). Use the base time to estimate when to react to the absence of payment result callbacks or when to check payment status (details).
    • The threshold time is the maximum possible time between the moment a payment is initiated in the payment platform to the moment the web service receives the callback with the payment result. A payment is automatically assigned the decline status if it wasn't processed within the threshold time. For individual customisation of the threshold time limit, contact ecommpay technical support.

Processing scenarios

To perform a purchase by using the MoMo Wallet method, you need to redirect the customer to the provider service.

Figure 1. Purchase by using Payment Page


Figure 2. Purchase by using Gate


Scenarios for performing operations via the main interfaces of the payment platform correspond to those presented in the diagrams. Similarly, when additional features (such as payment links) are used, scenarios for performing operations also correspond to the specifics of those features.

Purchases by using Payment Page

General information

To process a purchase through Payment Page by using the MoMo Wallet method, the merchant's web service is required to send a request with all required parameters and signature to the ecommpay URL and receive a callback with the result. The full sequence and special aspects of purchase processing are provided below.



Figure 3. Purchase processing by using Payment Page: step-by-step description
  1. A customer initiates a purchase in the web service.
  2. The web service sends the request for opening Payment Page to the specified ecommpay URL.
  3. The request for opening Payment Page is sent to the payment platform.
  4. The payment platform receives the request and validates the required parameters and signature.
  5. Payment Page is generated based on the project and request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects the MoMo Wallet method.
  8. The payment platform receives the request for processing the payment by using the MoMo Wallet method.
  9. The payment platform processes the request and sends it to the provider service.
  10. The request is processed on the provider service side.
  11. The data for redirecting the customer to the provider service is sent from the provider service to the payment platform.
  12. The data for redirecting the customer is sent from the payment platform to Payment Page.
  13. The customer is redirected to the provider service.
  14. The customer completes all required payment steps.
  15. The purchase is processed in the provider service.
  16. The result information is displayed to the customer in the provider service.
  17. The customer is redirected to Payment Page.
  18. The provider service sends a notification about the result to the payment platform.
  19. The payment platform sends the payment result callback to the web service.
  20. The payment platform sends the result information to Payment Page.
  21. The result information is displayed to the customer on Payment Page.

Information about the formats of requests and callbacks used for processing payments by using the MoMo Wallet method via Payment Page is presented further in this section; general information about working with the Payment Page API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the MoMo Wallet method:

  1. The following parameters required for any payment must be specified:
    • project_id—project identifier obtained from ecommpay during integration
    • payment_id—payment identifier unique within the project
    • payment_currency—payment currency code in the ISO-4217 alpha-3 format
    • payment_amount—payment amount in the smallest currency unit
    • customer_id—customer identifier unique within the project
  2. The following parameters required for any payment must be specified: project_id, payment_id, payment_currency, payment_amount, customer_id.
  3. It is also necessary to specify the first and last names of the customer, as well as the email address of the customer in the parameters customer_first_name, customer_last_name and customer_email.
  4. If you need to have the payment form displayed with the MoMo Wallet method selected, set the force_payment_method parameter to momopay.
  5. Additionally, any other parameters available for working with Payment Page can be used (details).
  6. After all target parameters are specified, generate a signature (details).

Thus, a correct request for opening the payment form using the MoMo Wallet method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information and signature.

{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "VND",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_last_name": "Doe",
   "customer_email": "johndoe@example.com",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}
Figure 4. Example of sufficient data in a purchase request
{
   "project_id": 120,
   "payment_id": "580",
   "payment_amount": 1000,
   "payment_currency": "VND",
   "customer_id": "customer1",
   "customer_first_name": "John",
   "customer_last_name": "Doe",
   "customer_email": "johndoe@example.com",
   "signature": "kUi2x9dKHAVNU0FYldOcZzUCwX6R\/ekpZhkIQg=="
}

Callback format

The MoMo Wallet method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with information about a 110,000 VND purchase made in the 1926 project.

Figure 5. Example of callback data indicating that the purchase has been processed
{
        "project_id": 1926,
        "payment": {
            "id": "1053",
            "type": "purchase",
            "status": "success",
            "date": "2021-03-12T08:34:25+0000",
            "method": "momopay",
            "sum": {
                "amount": 110000,
                "currency": "VND"
            },
            "description": ""
        },
        "operation": {
            "id": 18,
            "type": "sale",
            "status": "success",
            "date": "2021-03-12T08:34:25+0000",
            "created_date": "2021-03-12T08:34:12+0000",
            "request_id": "48be0494d37ab7106325f4eb16597a0d0-00000001",
            "sum_initial": {
                "amount": 110000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 110000,
                "currency": "VND"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2892,
                "payment_id": "1615538057957",
                "auth_code": ""
            }
        },
        "signature": "KMCoAR2yCd70I8VoAVT3NSF98zwoMfcDx2zwLixVsMW/Cvonik4A=="
    }

The following is the example of a callback with information about a declined purchase.

Figure 6. Example of callback data indicating that the purchase has been declined
{
        "project_id": 1926,
        "payment": {
            "id": "XPAY_1054",
            "type": "purchase",
            "status": "decline",
            "date": "2021-03-12T08:38:57+0000",
            "method": "momopay",
            "sum": {
                "amount": 110000,
                "currency": "VND"
            },
            "description": ""
        },
        "operation": {
            "id": 19,
            "type": "sale",
            "status": "decline",
            "date": "2021-03-12T08:38:57+0000",
            "created_date": "2021-03-12T08:38:48+0000",
            "request_id": "8df6a94820540aa079d3c4643f2fa329a9ec78a-00000001",
            "sum_initial": {
                "amount": 110000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 110000,
                "currency": "VND"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2892,
                "payment_id": "1615538332499",
                "auth_code": ""
            }
        },
        "signature": "u1YtNglF6H64ZWDiW+8D6K56/WmDUT6AySz0PF0wQvBMhuTsWrODsc32g=="
    }

Useful links

The following articles can be useful when implementing purchases via Payment Page:

Purchases by using Gate

General information

To process a purchase through Gate by using the MoMo Wallet method, the merchant's web service is required to do the following:

  1. Send a request with all the required parameters and signature to the ecommpay URL.
  2. Receive an intermediate callback from the payment platform and redirect the customer to the provider service.
  3. Receive the final callback from the payment platform.

The full sequence and special aspects of purchase processing are provided below.



Figure 7. Purchase processing by using Gate: step-by-step description
  1. A customer initiates a purchase by using the MoMo Wallet method in the web service.
  2. The web service sends the request for processing the purchase by using Gate to the specified ecommpay URL.
  3. The payment platform receives the request.
  4. The payment platform validates the required parameters and signature in the request.
  5. The payment platform sends the response to the web service with information about the receipt of the request and its validity (details).
  6. The payment platform performs further processing of the request (with parameter consistency check) and sends it to the provider service.
  7. The request is processed on the provider service side.
  8. The provider service sends the redirection data to the payment platform.
  9. The payment platform sends the callback with the redirection data to the web service.
  10. The customer is redirected to the provider service.
  11. The customer completes all required payment steps.
  12. The purchase is processed in the provider service.
  13. The result is displayed to the customer.
  14. The customer is redirected to the web service.
  15. The provider service sends the payment result notification to the payment platform.
  16. The payment platform sends the payment result callback to the web service.
  17. The customer receives the payment result information from the web service.

Information about the formats of requests and callbacks used for processing payments by using the MoMo Wallet method via Gate is presented further in this section. General information about working with the Gate API is presented in Interaction concepts.

Request format

There are several things you need to consider when sending purchase requests by using the MoMo Wallet method:

  1. To initiate each purchase, send a separate POST request to the /v2/payment/wallet/momopay/sale endpoint. This endpoint belongs to the group /v2/payment/wallet/{payment_method}/sale.
  2. Each request must include the following objects and parameters:
    • Object general—general purchase information:
      • project_id—project identifier obtained from ecommpay during integration
      • payment_id—payment identifier unique within the project
      • signature—request signature generated after all required parameters are specified (details—in the Signature generation and verification) (details)
    • Object payment—payment information:
      • amount—payment amount in the smallest currency unit
      • currency—payment currency code in the ISO-4217 alpha-3 format
    • Object customer—customer information:
      • id—customer identifier unique within the project
      • ip_address—customer IP address relevant for the initiated payment
      • first_name—customer first name
      • last_name—customerlast name
      • email—customer email address
    • Object return_url—contains the URLs to which customer is redirected during or after payment processing:
      • success—URL for redirecting a customer after a processed purchase
      • decline—URL for redirecting a customer after a declined purchase
      • return—URL to return customer to the web service during any step before the payment is completed
  3. Additionally, any other parameters included in the specification can be used.

Thus, a correct purchase request by using the MoMo Wallet method must contain the project identifier, basic payment information (identifier, amount, and currency code), customer information, URLs for redirection and signature.

{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 1000,
    "currency": "VND"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0",
    "first_name": "John",
    "last_name": "Doe",
    "email": "johndoe@example.com"
  },
  "return_url": {
    "success": "https://example.com/success",
    "decline": "https://example.com/decline",
    "return": "https://example.com/return"
  }
}
Figure 8. Example of sufficient data in a purchase request
{
  "general": {
    "project_id": 210,
    "payment_id": "test_payment",
    "signature": "PJkV8ej\/UG0Di8hTng6JvipTv+AWoXW\/9MTO8yJA=="
  },
  "payment": {
    "amount": 1000,
    "currency": "VND"
  },
  "customer": {
    "id": "customer123",
    "ip_address": "192.0.2.0",
    "first_name": "John",
    "last_name": "Doe",
    "email": "johndoe@example.com"
  },
  "return_url": {
    "success": "https://example.com/success",
    "decline": "https://example.com/decline",
    "return": "https://example.com/return"
  }
}

Formats of intermediate callbacks for customer redirection

Each payment made with the MoMo Wallet method requires redirection of customers from the merchant's web service to the MoMo Wallet service. To redirect a customer it is necessary to receive an intermediate callback from the payment platform and use the information included in the redirect_data object. The format of such callbacks is standard (details), and the following objects and parameters are included in the redirect_data object:

  • body—object with data to be sent in the request body
  • method—parameter specifying the HTTP method for sending the request (GET or POST)
  • url—parameter containing a link for redirection
Figure 9. redirect_data example
"redirect_data": {
        "body": {
            "Data": "4dg65h72G63k68g61J6eK74I49h44i3dj41H43g50h30G30k30g33J26K43I75h73i74j49H44g3dh6dG65k72g63J68K61I6eh74i5fj31H30g26h43G75k73g74J49K50I3dh26i43j75H72g72
h3dG54k48g42J26K41I6dh6fi75j6eH74g3dh34G36k35g2eJ35K32I26h52i65j66H49g44h3dG34k30g30J30K30I30h30i30j31H30g26h54G72k61g6eJ73K54I69h6di65j3dH32g30h32G30k2dg30J34K2dI31h35i
20j31H33g3ah32G36k3ag34J33K26I52h65i74j75H72g6eh55G52k4cg3dJ68K74I74h70i3aj2fH2fg70h70G2ek74g65J72K6dI69h6ei61j6cH2eg74h65G73k74g2fJ70K72I6fh63i65j73H73g2fh63G6fk6dg70J6
cK65I74h65i2dj72H65g64h69G72k65g63J74K2fI30h66i35j62H64g36h61G30k63g75J68K73I31h37i69j34H32g6dh34G76k37g72J37K39I66h36i2fj31H30g35h65G39k63g36J61K66I38h39i66j63H33g62h64
G26k52g65J71K75I65h73i74j55H52g4ch3dG68k74g74J70K73I3ah2fi2fj65H36g61h30G31k65g63J39K2eI6eh67i72j6fH6bg2eh69G6fk2fg63J61K6cI6ch62i61j63H6bg2fh78G70k61g79J2fK26I42h61i6ej
6bH43g6fh64G65k3dg54J4dK42I2eh46i54j",
            "Remarks": "",
            "EncryptText": "8F4AC9ED17D1579A7DE5121B16A45B4F"
        },
        "method": "POST",
        "url": "http://test.com/a/payment"
    }

Final callback format

The MoMo Wallet method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks.

The following is the example of a callback with information about a 110,000 VND purchase made in the 1926 project.

Figure 10. Example of callback data indicating that the purchase has been processed
{
        "project_id": 1926,
        "payment": {
            "id": "1053",
            "type": "purchase",
            "status": "success",
            "date": "2021-03-12T08:34:25+0000",
            "method": "momopay",
            "sum": {
                "amount": 110000,
                "currency": "VND"
            },
            "description": ""
        },
        "operation": {
            "id": 18,
            "type": "sale",
            "status": "success",
            "date": "2021-03-12T08:34:25+0000",
            "created_date": "2021-03-12T08:34:12+0000",
            "request_id": "48be0494d37ab7106325f4eb16597a0d0-00000001",
            "sum_initial": {
                "amount": 110000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 110000,
                "currency": "VND"
            },
            "code": "0",
            "message": "Success",
            "provider": {
                "id": 2892,
                "payment_id": "1615538057957",
                "auth_code": ""
            }
        },
        "signature": "KMCoAR2yCd70I8VoAVT3NSF98zwoMfcDx2zwLixVsMW/Cvonik4A=="
    }

The following is the example of a callback with information about a declined purchase.

Figure 11. Example of callback data indicating that the purchase has been declined
{
        "project_id": 1926,
        "payment": {
            "id": "XPAY_1054",
            "type": "purchase",
            "status": "decline",
            "date": "2021-03-12T08:38:57+0000",
            "method": "momopay",
            "sum": {
                "amount": 110000,
                "currency": "VND"
            },
            "description": ""
        },
        "operation": {
            "id": 19,
            "type": "sale",
            "status": "decline",
            "date": "2021-03-12T08:38:57+0000",
            "created_date": "2021-03-12T08:38:48+0000",
            "request_id": "8df6a94820540aa079d3c4643f2fa329a9ec78a-00000001",
            "sum_initial": {
                "amount": 110000,
                "currency": "VND"
            },
            "sum_converted": {
                "amount": 110000,
                "currency": "VND"
            },
            "code": "20000",
            "message": "General decline",
            "provider": {
                "id": 2892,
                "payment_id": "1615538332499",
                "auth_code": ""
            }
        },
        "signature": "u1YtNglF6H64ZWDiW+8D6K56/WmDUT6AySz0PF0wQvBMhuTsWrODsc32g=="
    }

Useful links

The following articles can be useful when implementing purchases via Gate:

Analysis of payments results

To analyse information about payments made with the MoMo Wallet method and other methods, you can use:

  • Dashboard interface toolkit with various lists and analytic panels.
  • Reports in CSV file format, available via the Reports section (one-time and periodically).
  • Data in JSON format, sent by program requests to a specified URL available by using the Data API interface.

If you have any questions, refer to the documentation (Dashboard and Using Data API) and ecommpay technical support.