DocumentationRecipesAPI ReferenceChangelog
Documentation

Generate QR Code

POST/snap/v{version}/qr/qr-mpm-generate

Use this API in the following ways to process payments:

  • To initiate a QR payment request



Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see：


Request Parameters

partnerReferenceNo String Required

Unique invoice number to identify the order on the merchant side, which is assigned by the merchant.


merchantId String Required

Unique merchant ID that is registered with 2C2P


amount Object Required

Show Child Parameters

value String Required

The value of the amount as a positive integer in the smallest currency unit.
For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00
or if the currency is IDR and the amount is IDR 10000, set the value of this parameter to 10000

currency String Required

Transaction currency code in 3 alphabetical values as specified in ISO 4217.

If the value is empty, the system will use the merchant's base currency


additionalInfo Object Required

Show Child Parameters

paymentToken Object Required

Show Child Parameters

description String Required

Product description. HTML Encode is required if it contains special characters.

Avoid using unnecessary special characters, as they may cause issues with parsing or rendering on the receiving end.

request3DS Boolean Optional

Specify enable/disable 3ds authentication

  • Y – Enable 3ds (default)
  • N – Disable 3ds

uiParams Object Required

Show Child Parameters

userInfo Object Required

Show Child Parameters

name String Required

The full name of the customer

Example: "John Doe"

email String Required

The email of the customer.

mobileNo String Optional

Customer's mobile number

payment Object Required

Show Child Parameters

code Object Required

Show Child Parameters

channelCode String Required

Example: "CC", "IPP", "APM", "QR"

Refer to Payment Channel List.

data Object Required

Show Child Parameters

qrType String Required

Possible values: RAW


urlParams Array[urlParam] Required

Show Child Parameters

type String Required

URL Type

Possible values: PAY\_RETURN, PAY\_NOTIFY

url String Required

The URL that the user is redirected to after the payment is completed or to to receive the payment notification.

isDeepLink Boolean Required

To indicates if URL is a deeplink URL or not





Response Parameters

responseCode String Required

Response code.

Possible values are listed in the response codes table on this page.


responseMessage String Required

Response message that explains the response code.


webRedirectUrl String

The URL that redirects customers to an external page in the default browser or the embedded WebView.


additionalInfo Object

Show Child Parameters

explanation String

Note: This field is returned when additionalInfo is returned.

Updated 10 months ago