Buy Now, Pay Later

Process Flow

BNPL_flow

API Configuration

HTTP Information

Your permissions need included payWithInstallmentFlik (request permission to use) to use these APIs.

Get Installment Information

If merchant provide interface for user to choose installment plan on their website or app, calling this api is required to get information of installment plans.
Otherwise, If merchant don't provide interface for user to choose installment plan, and want end user choose installment plan on their MoMo app, merchant can skip calling this api and call api Initiate Installment Method directly.

HTTP Request

POST /v2/gateway/api/installment/getInfo

Attribute	Type	Description
partnerCode	String(20)	Merchant ID Integration information
partnerName	String	Partner name
requestId	String(50)	Request ID, unique for each request.
orderId	String	Order ID, unique for each request
requestType	String(20)	`payWithInstallmentFlik`
orderGroupId	Long	The orderGroupId will be provided by MoMo to classify groups of orders for further operational activities. Please contact MoMo to use this field.
amount	Long	Amount needs to be paid (Total value of installment orders must be from 200.000VND) Currency: `VND` Data type: `Long`
userInfo	Object	User Information
deliveryInfo	Object	Delivery Info
installmentRequest	Object	Short installment request.
items	List	List items.
lang	String(20)	Language return: `vi` or `en`
signature	String(65)	Signature to confirm information. Secure transaction in Hmac_SHA256 algorithm with format: a String sort all key name of data field from a-z: `accessKey=$accessKey&amount=$amount&orderId=$orderId` `&partnerCode=$partnerCode&requestId=$requestId` `&requestType=$requestType`

Data of `userInfo`

Attribute	Type	Description
phoneNumber	String	Phone number
email	String	Email of user
name	String	Name of user

Data of `deliveryInfo`

Attribute	Type	Description
deliveryAddress	String	Delivery address
deliveryFee	Long	Delivery fee
quantity	Long	Quantity of product

Data of `installmentRequest`

Attribute	Type	Required	Description
installmentType	String		`payInOrder` : Installment apply for all Item `payInItem` : Installment apply for each Item

Data of each `items`

Attribute	Type	Description
id	String	The Id of item.
name	String	The name of item.
description	String	The description of item.
category	String	The type of item.
currency	String	`VND`
quantity	Integer	Quantity number of each item. It must be greater than `0`
price	Long	Price of single unit item
totalAmount	Long	`price` x `quantity`
purchaseAmount	Long	The amount need to be purchased
isInstallment	Boolean	- `True`: Installment. - `False`: Pay now. Require if installmentRequest.installmentType = `payInItem`
manufacturer	String	Name of manufacturer
imei	String	The imei of item.
barCode	String	The barCode of item.
serialNumber	String	The serialNumber of item.
imageUrl	String	Link image of product.

Example Request

Installment level: Order

{
  "partnerCode": "MOMO_PARTNER_A",
  "partnerName": "MoMo Developer",
  "requestType": "payWithInstallmentFlik",
  "requestId": "RE1668668711653",
  "amount": "200000",
  "deliveryInfo": {
    "deliveryAddress": "Phu My Hung Tower",
    "deliveryFee": 30000,
    "quantity": 2
  },
  "userInfo": {
    "name": "MoMo Developer",
    "phoneNumber": "1900 636 652",
    "email": "merchant.care@momo.vn"
  },
  "installmentRequest": {
    "installmentType": "payInOrder"
  },
  "items": [
    {
      "id": "1655435780SKU_1",
      "name": "Iphone 13",
      "description": "Iphone 13",
      "category": "category iphone",
      "price": 200000,
      "currency": "VND",
      "quantity": 1,
      "totalAmount": 200000,
      "purchaseAmount": 200000,
      "manufacturer": "Apple",
      "imei": "IMEI123213",
      "serialNumber": "SERIAL12312",
      "barCode": "CODE12312"
    },
    {
      "id": "1655435780SKU_2",
      "name": "Macbook Pro 13 2018",
      "description": "Macbook Pro 13 2018",
      "category": "category macbook",
      "price": 100000,
      "currency": "VND",
      "quantity": 1,
      "totalAmount": 100000,
      "purchaseAmount": 100000,
      "manufacturer": "Apple",
      "imei": "IMEI123213",
      "serialNumber": "SERIAL12312",
      "barCode": "CODE12312"
    }
  ],
  "lang": "vi",
  "signature": "53f6052d9a55b6d92c17c74af81a3c6d8e36a01d9dad064ff50ce569b90eba1c"
}

Installment level: Item

{
  "partnerCode": "MOMO_PARTNER_A",
  "partnerName": "MoMo Developer",
  "requestType": "payWithInstallmentFlik",
  "requestId": "RE1668668711653",
  "amount": "200000",
  "deliveryInfo": {
    "deliveryAddress": "Phu My Hung Tower",
    "deliveryFee": 30000,
    "quantity": 2
  },
  "userInfo": {
    "name": "MoMo Developer",
    "phoneNumber": "1900 636 652",
    "email": "merchant.care@momo.vn"
  },
  "installmentRequest": {
    "installmentType": "payInItem"
  },
  "items": [ // must be have at least item with isInstallment = true
    {
      "id": "1655435780SKU_1",
      "name": "Iphone 13",
      "description": "Iphone 13",
      "category": "category iphone",
      "price": 200000,
      "currency": "VND",
      "quantity": 1,
      "totalAmount": 200000,
      "purchaseAmount": 200000,
      "manufacturer": "Apple",
      "imei": "IMEI123213",
      "serialNumber": "SERIAL12312",
      "barCode": "CODE12312",
      "isInstallment": true // installment item
    },
    {
      "id": "1655435780SKU_2",
      "name": "Macbook Pro 13 2018",
      "description": "Macbook Pro 13 2018",
      "category": "category macbook",
      "price": 100000,
      "currency": "VND",
      "quantity": 1,
      "totalAmount": 100000,
      "purchaseAmount": 100000,
      "manufacturer": "Apple",
      "imei": "IMEI123213",
      "serialNumber": "SERIAL12312",
      "barCode": "CODE12312",
      "isInstallment": false // paynow item
    }
  ],
  "lang": "vi",
  "signature": "53f6052d9a55b6d92c17c74af81a3c6d8e36a01d9dad064ff50ce569b90eba1c"
}

HTTP Response

Attribute	Type	Description
partnerCode	String	Integration information
requestId	String	Same as the original request
orderId	String	Same as the original request
resultCode	int	Error code
responseTime	Long	Time to respond payment results to partner Format: `timestamp`
message	String	Error description, error language is based on `lang`
installmentResponse	Json Object	Short order information
items	List	List items. Empty if installmentRequest.installmentType = `payInOrder`
installmentTerms	List	List installment terms. Empty if installmentRequest.installmentType = `payInItem`

Data of `installmentResponse`

Attribute	Type	Required	Description
installmentType	String		Installment type in request

Data of `items`

Attribute	Type	Required	Description
id	String		The Id of item.
installmentTerms	List		List installment terms.

Data of each `installmentTerms`

Attribute	Type	Description
installmentTerm	String	The Id of installment term.
installmentTermName	String	The name installment term.
itemAmount	Long	Amount of item.
interestAmount	Long	Interest amount.
insAmount	Long	Installment amount.
principalAmount	Long	Principal amount.
dpPercent	Double	Down payment percent.
dpAmount	Long	Down payment amount.
emi	Long	Total amount each tenor.
lastEmi	Long	Amount of last tenor.
apr	Double	Interest rate(%)/year.
tenor	Integer	The number of tenor.

Example Response

Installment level: Order

{
  "partnerCode": "MOMO_PARTNER_A",
  "requestId": "RE1668668127798",
  "resultCode": 0,
  "message": "Giao dịch thành công.",
  "responseTime": 1668668434082,
  "installmentResponse": {
    "installmentType": "payInOrder"
  },
  "items": [],
  "installmentTerms": [
    {
      "installmentTerm": "payIn30",
      "installmentTermName": "Trả góp trong 30 ngày",
      "itemAmount": 400000,
      "interestAmount": 0,
      "insAmount": 400000,
      "principalAmount": 400000,
      "dpPercent": 0.0,
      "dpAmount": 0,
      "emi": 400000,
      "lastEmi": 400000,
      "tenor": 1,
      "apr": 0.0
    },
    {
      "installmentTerm": "payIn4",
      "installmentTermName": "Trả góp trong 4 kỳ",
      "itemAmount": 405016,
      "interestAmount": 5016,
      "insAmount": 305016,
      "principalAmount": 300000,
      "dpPercent": 25.0,
      "dpAmount": 100000,
      "emi": 101672,
      "lastEmi": 101672,
      "tenor": 3,
      "apr": 10.0
    },
    {
      "installmentTerm": "payIn3",
      "installmentTermName": "Trả góp trong 3 kỳ",
      "itemAmount": 400000,
      "interestAmount": 0,
      "insAmount": 400000,
      "principalAmount": 400000,
      "dpPercent": 0.0,
      "dpAmount": 0,
      "emi": 133334,
      "lastEmi": 133332,
      "tenor": 3,
      "apr": 0.0
    }
  ]
}

Installment level: Item

{
    "partnerCode": "MOMO_PARTNER_A",
    "requestId": "RE1668668711653",
    "resultCode": 0,
    "message": "Giao dịch thành công.",
    "responseTime": 1668668721659,
    "installmentResponse": {
        "installmentType": "payInItem"
    },
    "items": [
        {
            "id": "1655435780SKU_1",
            "installmentTerms": [
                {
                    "installmentTerm": "payIn30",
                    "installmentTermName": "Trả góp trong 30 ngày",
                    "itemAmount": 200000,
                    "interestAmount": 0,
                    "insAmount": 200000,
                    "principalAmount": 200000,
                    "dpPercent": 0.0,
                    "dpAmount": 0,
                    "emi": 200000,
                    "lastEmi": 200000,
                    "tenor": 1,
                    "apr": 0.0
                },
                {
                    "installmentTerm": "payIn4",
                    "installmentTermName": "Trả góp trong 4 kỳ",
                    "itemAmount": 202508,
                    "interestAmount": 2508,
                    "insAmount": 152508,
                    "principalAmount": 150000,
                    "dpPercent": 25.0,
                    "dpAmount": 50000,
                    "emi": 50836,
                    "lastEmi": 50836,
                    "tenor": 3,
                    "apr": 10.0
                },
                {
                    "installmentTerm": "payIn3",
                    "installmentTermName": "Trả góp trong 3 kỳ",
                    "itemAmount": 200000,
                    "interestAmount": 0,
                    "insAmount": 200000,
                    "principalAmount": 200000,
                    "dpPercent": 0.0,
                    "dpAmount": 0,
                    "emi": 66667,
                    "lastEmi": 66666,
                    "tenor": 3,
                    "apr": 0.0
                }
            ]
        },
        {
            "id": "1655435780SKU_2",
            "installmentTerms": [
                {
                    "installmentTerm": "payNow",
                    "installmentTermName": "Trả thẳng",
                    "interestAmount": 0,
                    "insAmount": 0,
                    "dpAmount": 100000,
                    "emi": 0,
                    "tenor": 0,
                    "apr": 0.0
                }
            ]
        }
    ],
    "installmentTerms": []
}

Initiate Installment Method

HTTP Request

POST /v2/gateway/api/create

Attribute	Type	Description
partnerCode	String(20)	Merchant ID Integration information
subPartnerCode	String	Sub partner Id
partnerName	String	Partner name
storeId	String	Store ID
requestId	String(50)	Request ID, unique for each request, MoMo's partner uses the requestId field for idempotency control
orderId	String	Partner Transaction ID Regex: `^[0-9a-zA-Z]([-_.][0-9a-zA-Z]+)$`
amount	Long	Amount needs to be paid Min: 200.000 VND Max: 50.000.000 VND Currency: `VND` Data type: `Long`
orderInfo	String(200)	Order info from merchant
orderGroupId	Long	The orderGroupId will be provided by MoMo to classify groups of orders for further operational activities. Please contact MoMo to use this field.
redirectUrl	String(200)	MoMo Payment will redirect end-user back to Merchant using this URL, to notify result for end-user using HTTP GET request type
ipnUrl	String(200)	MoMo Payment will notify this URL. Merchant server needs to build this URL to receive results sent from MoMo, using HTTP POST request type with header application/json.
autoCapture	Boolean	If set to false, the payment will not be automatically captured.
extraData	String	Default value is empty `""` Encode base64 follow Json Format: `{"key": "value"}` Example with data: `{"username": "momo"}`=> data of `extraData`: `eyJ1c2VybmFtZSI6ICJtb21vIn0=`
requestType	String	`payWithInstallmentFlik`
userInfo	Object	User Information
deliveryInfo	Object	Delivery Info
installmentRequest	Object	Short installment request.
items	List	The list of items
lang	String(20)	Language return: `vi` or `en`
signature	String(65)	Signature to confirm information. Secure transaction in Hmac_SHA256 algorithm with format: a String sort all key name of data field from a-z: `accessKey=$accessKey&amount=$amount&extraData=$extraData` `&ipnUrl=$ipnUrl&orderId=$orderId&orderInfo=$orderInfo` `&partnerCode=$partnerCode&redirectUrl=$redirectUrl` `&requestId=$requestId&requestType=$requestType`

Data of `deliveryInfo`

Attribute	Type	Description
deliveryAddress	String	Delivery address
deliveryFee	Long	Delivery fee
inStorePickUp	Boolean	- True : If users pickup their good at store or drop-off ponit - False : If users expect their goods to be delivered at their place
description	String	The description of item.

Data of `userInfo`

Attribute	Type	Description
phoneNumber	String	Phone number.
email	String	Email of user.
name	String	Name of user.

Data of `installmentRequest`

Attribute	Type	Required	Description
installmentType	String		`payInOrder` : Installment apply for all Item `payInItem` : Installment apply for each Item
installmentTerm	String		- If installmentRequest.installmentType = `payInOrder` and choose installment plan on `Merchant site` value must be in: `payIn3` : pay in 3 installment `payIn4` : pay in 4 installment `payIn30` : pay later in 30 days - If installmentRequest.installmentType = `payInOrder` and choose installment plan on `MoMo App` value must be null. - If installmentRequest.installmentType = `payInItem` value must be null.

Data of each `item`

Attribute	Type	Description
id	String	The Id of item.
name	String	The name of item.
description	String	The description of item.
category	String	The type of item.
currency	String	`VND`
quantity	Integer	Quantity number of each item. It must be greater than `0`
price	Long	Price of single unit item
totalAmount	Long	`price` x `quantity`
purchaseAmount	Long	The amount need to be purchased
isInstallment	Boolean	- `True`: Installment. - `False`: Pay now. Require if installmentRequest.installmentType = `payInItem`
installmentTerm	String	Installment term. Require if installmentRequest.installmentType = `payInItem` and `isInstallment` = `true`. Not null if choose installment plan on Merchant site, if choose installment plan on MoMo App value must be null.
manufacturer	String	Name of manufacturer.
imei	String	The imei of item.
barCode	String	The barCode of item.
serialNumber	String	The serialNumber of item.
imageUrl	String	Link image of product.

Example Request

Installment level: Order and choose installment plan on Merchant site

{
    "partnerCode": "MOMO_PARTNER_A",
    "partnerName": "MoMo Developer",
    "requestType": "payWithInstallmentFlik",
    "requestId": "RE1668668711653",
    "orderId": "OD1668668711653",
    "orderInfo": "Thanh toán hóa đơn OD1668586204144",
    "extraData": "eyJ1c2VybmFtZSI6ICJtb21vIn0=",
    "amount": "360000",
    "redirectUrl": "https://webhook.site/0853b64e-c86b-4e40-8b35-3ff52fb9d51c",
    "ipnUrl": "https://webhook.site/0853b64e-c86b-4e40-8b35-3ff52fb9d51c",
    "autoCapture": "false",
    "deliveryInfo": {
        "deliveryAddress": "123 Nguyen Trai, Phuong 1, Quan 1, Thanh pho Ho Chi Minh",
        "deliveryFee": 30000,
        "inStorePickUp" : true,
        "description": "Phi giao hang"
    },
    "userInfo": {
        "name": "MoMo Developer",
        "phoneNumber": "1900 636 652",
        "email": "merchant.care@momo.vn"
    },
    "installmentRequest": {
        "installmentType": "payInOrder",
        "installmentTerm": "payIn4" // not null
    },
    "items": [
       {
            "id": "1655435780SKU_1",
            "name": "Iphone 13",
            "description": "Iphone 13",
            "category": "category iphone",
            "price": 100000,
            "currency": "VND",
            "quantity": 1,
            "totalAmount": 100000,
            "purchaseAmount": 100000,
            "manufacturer": "Apple",
            "imei": "IMEI123213",
            "serialNumber": "SERIAL12312",
            "barCode": "CODE12312"
        },
        {
            "id": "1655435780SKU_2",
            "name": "Macbook Pro 13 2018",
            "description": "Macbook Pro 13 2018",
            "category": "category macbook",
            "price": 230000,
            "currency": "VND",
            "quantity": 1,
            "totalAmount": 230000,
            "purchaseAmount": 230000,
            "manufacturer": "Apple",
            "imei": "IMEI123213",
            "serialNumber": "SERIAL12312",
            "barCode": "CODE12312"
        }
    ],
  "lang": "vi",
  "signature": "53f6052d9a55b6d92c17c74af81a3c6d8e36a01d9dad064ff50ce569b90eba1c"
}

Installment level: Order and choose installment plan on MoMo App

{
    "partnerCode": "MOMO_PARTNER_A",
    "partnerName": "MoMo Developer",
    "requestType": "payWithInstallmentFlik",
    "requestId": "RE1668668711653",
    "orderId": "OD1668668711653",
    "orderInfo": "Thanh toán hóa đơn OD1668586204144",
    "extraData": "eyJ1c2VybmFtZSI6ICJtb21vIn0=",
    "amount": "360000",
    "redirectUrl": "https://webhook.site/0853b64e-c86b-4e40-8b35-3ff52fb9d51c",
    "ipnUrl": "https://webhook.site/0853b64e-c86b-4e40-8b35-3ff52fb9d51c",
    "autoCapture": "false",
    "deliveryInfo":{
        "deliveryAddress": "123 Nguyen Trai, Phuong 1, Quan 1, Thanh pho Ho Chi Minh",
        "deliveryFee": 30000,
        "inStorePickUp" : true,
        "description": "Phi giao hang"
    },
    "userInfo": {
        "name": "MoMo Developer",
        "phoneNumber": "1900 636 652",
        "email": "merchant.care@momo.vn"
    },
    "installmentRequest": {
        "installmentType": "payInOrder",
        // remove installmentTerm
    },
    "items": [
       {
            "id": "1655435780SKU_1",
            "name": "Iphone 13",
            "description": "Iphone 13",
            "category": "category iphone",
            "price": 100000,
            "currency": "VND",
            "quantity": 1,
            "totalAmount": 100000,
            "purchaseAmount": 100000,
            "manufacturer": "Apple",
            "imei": "IMEI123213",
            "serialNumber": "SERIAL12312",
            "barCode": "CODE12312"
        },
        {
            "id": "1655435780SKU_2",
            "name": "Macbook Pro 13 2018",
            "description": "Macbook Pro 13 2018",
            "category": "category macbook",
            "price": 230000,
            "currency": "VND",
            "quantity": 1,
            "totalAmount": 230000,
            "purchaseAmount": 230000,
            "manufacturer": "Apple",
            "imei": "IMEI123213",
            "serialNumber": "SERIAL12312",
            "barCode": "CODE12312"
        }
    ],
  "lang": "vi",
  "signature": "53f6052d9a55b6d92c17c74af81a3c6d8e36a01d9dad064ff50ce569b90eba1c"
}

Installment level: Item and choose installment plan on Merchant site

{
    "partnerCode": "MOMO_PARTNER_A",
    "partnerName": "MoMo Developer",
    "requestType": "payWithInstallmentFlik",
    "requestId": "RE1668668711653",
    "orderId": "OD1668668711653",
    "orderInfo": "Thanh toán hóa đơn OD1668586204144",
    "extraData": "eyJ1c2VybmFtZSI6ICJtb21vIn0=",
    "amount": "360000",
    "redirectUrl": "https://webhook.site/0853b64e-c86b-4e40-8b35-3ff52fb9d51c",
    "ipnUrl": "https://webhook.site/0853b64e-c86b-4e40-8b35-3ff52fb9d51c",
    "autoCapture": "false",
    "deliveryInfo":{
        "deliveryAddress": "123 Nguyen Trai, Phuong 1, Quan 1, Thanh pho Ho Chi Minh",
        "deliveryFee": 30000,
        "inStorePickUp" : true,
        "description": "Phi giao hang"
    },
    "userInfo": {
        "name": "MoMo Developer",
        "phoneNumber": "1900 636 652",
        "email": "merchant.care@momo.vn"
    },
    "installmentRequest": {
        "installmentType": "payInItem"
    },
    "items": [ // must be have at least item with isInstallment = true
       {
            "id": "1655435780SKU_1",
            "name": "Iphone 13",
            "description": "Iphone 13",
            "category": "category iphone",
            "price": 100000,
            "currency": "VND",
            "quantity": 1,
            "totalAmount": 100000,
            "purchaseAmount": 100000,
            "manufacturer": "Apple",
            "imei": "IMEI123213",
            "serialNumber": "SERIAL12312",
            "barCode": "CODE12312",
            "isInstallment": false // pay now item, installmentTerm will be ignored if isInstallment = false
        },
        {
            "id": "1655435780SKU_2",
            "name": "Macbook Pro 13 2018",
            "description": "Macbook Pro 13 2018",
            "category": "category macbook",
            "price": 230000,
            "currency": "VND",
            "quantity": 1,
            "totalAmount": 230000,
            "purchaseAmount": 230000,
            "manufacturer": "Apple",
            "imei": "IMEI123213",
            "serialNumber": "SERIAL12312",
            "barCode": "CODE12312",
            "isInstallment": true, // installment item
            "installmentTerm": "payIn4" // must not be null if isInstallment = true
        }
    ],
  "lang": "vi",
  "signature": "53f6052d9a55b6d92c17c74af81a3c6d8e36a01d9dad064ff50ce569b90eba1c"
}

Installment level: Item and choose installment plan on MoMo App

{
    "partnerCode": "MOMO_PARTNER_A",
    "partnerName": "MoMo Developer",
    "requestType": "payWithInstallmentFlik",
    "requestId": "RE1668668711653",
    "orderId": "OD1668668711653",
    "orderInfo": "Thanh toán hóa đơn OD1668586204144",
    "extraData": "eyJ1c2VybmFtZSI6ICJtb21vIn0=",
    "amount": "360000",
    "redirectUrl": "https://webhook.site/0853b64e-c86b-4e40-8b35-3ff52fb9d51c",
    "ipnUrl": "https://webhook.site/0853b64e-c86b-4e40-8b35-3ff52fb9d51c",
    "autoCapture": "false",
    "deliveryInfo": {
        "deliveryAddress": "123 Nguyen Trai, Phuong 1, Quan 1, Thanh pho Ho Chi Minh",
        "deliveryFee": 30000,
        "inStorePickUp" : true,
        "description": "Phi giao hang"
    },
    "userInfo": {
        "name": "MoMo Developer",
        "phoneNumber": "1900 636 652",
        "email": "merchant.care@momo.vn"
    },
    "installmentRequest": {
        "installmentType": "payInItem"
    },
    "items": [
       {
            "id": "1655435780SKU_1",
            "name": "Iphone 13",
            "description": "Iphone 13",
            "category": "category iphone",
            "price": 100000,
            "currency": "VND",
            "quantity": 1,
            "totalAmount": 100000,
            "purchaseAmount": 100000,
            "manufacturer": "Apple",
            "imei": "IMEI123213",
            "serialNumber": "SERIAL12312",
            "barCode": "CODE12312"
        },
        {
            "id": "1655435780SKU_2",
            "name": "Macbook Pro 13 2018",
            "description": "Macbook Pro 13 2018",
            "category": "category macbook",
            "price": 230000,
            "currency": "VND",
            "quantity": 1,
            "totalAmount": 230000,
            "purchaseAmount": 230000,
            "manufacturer": "Apple",
            "imei": "IMEI123213",
            "serialNumber": "SERIAL12312",
            "barCode": "CODE12312"
        }
    ],
  "lang": "vi",
  "signature": "53f6052d9a55b6d92c17c74af81a3c6d8e36a01d9dad064ff50ce569b90eba1c"
}

HTTP Response

Attribute	Type	Description
partnerCode	String	Integration information
requestId	String	Same as the original request
orderId	String	Same as the original request
payUrl	String	URL for switching from the partner's page to the MoMo payment page
deeplink	String	URL to open MoMo application directly (Customers must install MoMo app first) and payment confirmation screen.
qrCodeUrl	String	Data to generate QR code if you want customers to scan the QR code directly on your purchase page or to print it on the invoice. `Note`: This URL is NOT containing the image of the QR code, you need to use an external library to generate the QR code.
deeplinkMiniApp	String	URL to open the MoMo app's payment confirmation screen. Apply when partner's website is embedded into MoMo app.
resultCode	int	Error code
message	String	Error description, error language is based on `lang`
responseTime	Long	Time to respond payment results to partner Format: `timestamp`

On the production environment: You need to request permission to use qrCodeUrl, deeplink, applink,deeplinkMiniApp fields.

Example Response

{
    "partnerCode": "MOMO_PARTNER_A",
    "orderId": "OD1663393109660",
    "requestId": "RE1663393158323",
    "amount": 10000,
    "responseTime": 1663393159319,
    "message": "Giao dịch thành công.",
    "resultCode": 0,
    "payUrl": "https://test-payment.momo.vn/v2/gateway/pay?t=TU9NTzJYT04yMDIxMDQyOHxPRDE2NjMzOTMxMDk2NjA=",
    "deeplink": "momo://?action=marketing&featureCode=credit_bnpl&orderId=OD1663393109660&refId=credit_bnpl&serviceCode=credit_bnpl",
    "qrCodeUrl": "https://test-payment.momo.vn/v2/gateway/app?isScanQr=true&t=TU9NTzJYT04yMDIxMDQyOHxPRDE2NjMzOTMxMDk2NjA=",
    "applink": "https://momoappdev.page.link/Fx5GVGSXDtTuxkDs9",
    "deeplinkMiniApp": "momo://?action=marketing&featureCode=credit_bnpl&orderId=OD1663393109660&refId=credit_bnpl&serviceCode=credit_bnpl"
}

Process Payment Result

For more information, see Payment Notification.

Parameter description

Description for parameters which are used by MoMo in the URL redirectUrl and the body content of ipnUrl.

Attribute	Type	Description
partnerCode	String	Integration information
requestId	String	Each Request’s Identification
amount	Long	Amount to pay
orderId	String	Initial OrderId
orderType	String	`momo_wallet`
orderInfo	String	Order info
transId	Long	MoMo's transaction ID
resultCode	Integer	Order status
message	String	description of `resultCode` based on `lang`
payType	String	Payment Type: `webApp`, `app`,`qr`or `miniapp`
responseTime	Long	Time to return payment result in miliseconds
extraData	String	Additional info
signature	String	Signature to confirm information. Secure transaction in Hmac_SHA256 algorithm with format: a String sort all key name of data field from a-z: `accessKey=$accessKey&amount=$amount&callbackToken=` `$callbackToken&extraData=$extraData&message=$message` `&orderId=$orderId&orderInfo=$orderInfo&orderType=$orderType` `&partnerCode=$partnerCode&payType=$payType&requestId=` `$requestId&responseTime=$responseTime&resultCode=` `$resultCode&transId=$transId`

The signature is encrypted using secretKey and accessKey, so you must keep it secret, not expose to any chat channels, or in source code, git, etc.

Buy Now, Pay Later

Process Flow​

API Configuration​

Get Installment Information​

HTTP Request​

Data of userInfo​

Data of deliveryInfo​

Data of installmentRequest​

Data of each items​

Example Request​

HTTP Response​

Data of installmentResponse​

Data of items​

Data of each installmentTerms​

Example Response​

Initiate Installment Method​

HTTP Request​

Data of deliveryInfo​

Data of userInfo​

Data of installmentRequest​

Data of each item​

Example Request​

HTTP Response​

Process Payment Result​

Parameter description​

See also​

Process Flow

API Configuration

Get Installment Information

HTTP Request

Data of `userInfo`

Data of `deliveryInfo`

Data of `installmentRequest`

Data of each `items`

Example Request

HTTP Response

Data of `installmentResponse`

Data of `items`

Data of each `installmentTerms`

Example Response

Initiate Installment Method

HTTP Request

Data of `deliveryInfo`

Data of `userInfo`

Data of `installmentRequest`

Data of each `item`

Example Request

HTTP Response

Process Payment Result

Parameter description

See also