Bank transfers in Myanmar - Purchase

When performing a purchase, the customer follows the payment instructions displayed on the checkout page or in your system (when performing the purchase by using Gate).


Countries and regions	Myanmar
Payment currencies	MMK
Payment amount limits	Contact your key account manager at Monetix for details. Also you can check the payment amount limits in your project by using Dashboard.
Payment processing time	Contact your key account manager at Monetix for details.
Currency conversion	On the Monetix side
Refund
Onboarding and access fee	Contact your key account manager at Monetix for details.
Special considerations If the customer enters an amount which is different from the amount specified in the purchase request, the provider service will decline the payment.

Operations support


	Interfaces
	Payment Page	Gate	Dashboard
Purchase

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section, and then click the Payment methods tab.

The following sections provide more information about the payment processing flow and the analysis of completed payments.

Purchase by using Payment Page

General information

To perform a purchase by using Payment Page with the Bank transfers in Myanmar payment method:

Send a request with all the required parameters and signature to the Monetix URL.
Accept the callback with the purchase result from the payment platform.

The following figure shows the complete purchase processing flow in the Bank transfers in Myanmar payment method.

Figure 1. Purchase processing steps for a purchase by using Payment Page

The customer initiates a purchase in your system.
Your system sends the request for the purchase through Payment Page to the Monetix URL.
The checkout page is displayed to the customer.
The customer chooses to make a purchase with the Bank transfers in Myanmar payment method.
The checkout page displays the payment instructions to the customer.
The customer completes the purchase.
The customer is redirected back to the checkout page.
The provider service sends the purchase result information to the payment platform.
The payment platform sends a callback with the payment result to your system.
The payment platform displays the payment result to the customer on the checkout page.

Request

The following table lists the parameters that you have to include in the request for purchase through the checkout page with the Bank transfers in Myanmar payment method.

strictly required—the parameter must be in the initial request.

required—the parameter is required for purchase processing but using it in the initial request is optional. If you don't specify this parameter in your request, the checkout page will contain an additional field for the customer to enter the missing information. For more information on how to act in such cases, see Submission of additional payment information.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.

Parameter Description

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

customer_id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

customer_email
string
strictly required

Customer's email.

Example: johndoe@example.com

account_customer_name
string
required

Customer's full name.

Example: John Doe

payment_currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: MMK

payment_amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency units and Currency codes.

Example: 50,000.00 MMK must be sent as 5000000

force_payment_method
string
optional

Parameter that allows you to enforce the Bank transfers in Myanmar payment method for your customer and skip the page with payment method selections.

To enforce the Bank transfers in Myanmar payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to bank-transfer-myanmar. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: ' bank-transfer-myanmar'

language_code
string
optional

The language code of the payment results message. By default, these messages are displayed in Burmese language. To change the language to English, set this parameter to en.

Example: en

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

You can also add any other optional parameters to the request, if necessary. For the list of all the parameters possible in requests to Payment Page, see Payment Page invocation parameters.

Here is an example of the data from a request to open the checkout page by using EPayWidget:

EPayWidget.run(
	{
		project_id: 1234,
		payment_id: 'payment_47',
		customer_id: 'customer_123',
		customer_email: 'johndoe@example.com',
		account_customer_name: 'John Doe',
		payment_currency: 'MMK',
		payment_amount: 5000000,
		force_payment_method: ' bank-transfer-myanmar',
		language_code: 'en',
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=='
	}
)

Callback

In the Bank transfers in Myanmar payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Payment Page.

The following is an example of a callback body with information about a successfully completed purchase.

Figure 2. Example of the data from a successful purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Bank transfer Myanmar",
        "sum": {
            "amount": 5000000,
            "currency": "MMK"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 5000000,
            "currency": "MMK"
        },
        "sum_converted": {
            "amount": 5000000,
            "currency": "MMK"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 3. Example of the data from a declined purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Bank transfer Myanmar",
        "sum": {
            "amount": 5000000,
            "currency": "MMK"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 5000000,
            "currency": "MMK"
        },
        "sum_converted": {
            "amount": 5000000,
            "currency": "MMK"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Purchase by using Gate

General information

To perform a purchase by using Gate with the Bank transfers in Myanmar payment method:

Send a request with all the required parameters and signature to the Monetix URL.
Show the screen with payment instructions to the customer.
Accept the callback with the purchase result from the payment platform.

The following figure provides the details of the purchase processing flow in the Bank transfers in Myanmar payment method.

Figure 4. Purchase processing flow when performing a purchase by using Gate

The customer initiates a purchase in your system.
Your system sends the purchase request to the Monetix payment platform.
The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response structure.)
The payment platform generates the data for displaying the payment instructions to the customer and sends the data to your system in the display_data array.
Your system displays the payment instructions to the customer.
The customer completes the purchase.
The customer is redirected to your system.
The provider service informs the payment platform about the purchase result.
The payment platform sends the callback with the payment result to your system.
Your system sends the payment result to the customer.

Request

This section provides the instructions on how to build the request for purchase with the Bank transfers in Myanmar payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	`/v2/payment/bank-transfer/myanmar/sale`
Full API endpoint specification	/v2/payment/bank-transfer/{payment_method}/sale

strictly required—the parameter must be in the initial request.

Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

IP address of the customer's device.

Example: 198.51.100.47

email
string
strictly required

Customer's email.

Example: johndoe@example.com

account
object
strictly required

customer_name
string
strictly required

Customer's full name.

Example: John Doe

payment
object
strictly required

currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: MMK

amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

Example: 50,000.00 MMK must be sent as 5000000

You can also add any other optional parameters to the purchase request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a purchase with the Bank transfers in Myanmar payment method:

Figure 5. Example of the purchase request body

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "email": "johndoe@example.com"
    },
    "account": {
        "customer_name": "John Doe"
    },
    "payment": {
        "currency": "MMK",
        "amount": 5000000
    }
}

Customer redirection

After receiving and processing your purchase request, the payment platform sends you the callback with the data for redirecting the customer to the provider service.

To redirect the customer, use the values of the following parameters in the redirect_data object:

url—the URL to redirect the customer to
body—the data to send in the request body
method—the HTTP method for retrieving the website page (for example, POST or GET)
encrypted—this is the service parameter. Ignore it.

Here is an example of the callback snippet with the data to redirect the customer.

"redirect_data": {
    "method": "GET",
    "body": [],
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Displaying the payment instructions to the customer

After receiving and processing your purchase request, the payment platform sends you the callback with the data for displaying the payment instructions to the customer.

Use the data from the display_data array to display the payment instructions to the customer.

Table 3. Description of the display_data array
Element	Description
{ "type": "add_info", "title": "invoice_number", "data": "12345678901234" }	Example: `12345678901234`
{ "type": "add_info", "title": "payment_amount_show", "data": "50000.00" }	Example: `50000.00`
{ "type": "add_info", "title": "bank_code", "data": "KBZ" }	Example: `KBZ`
{ "type": "add_info", "title": "account_number", "data": "123-456-789-012-34567" }	Example: `123-456-789-012-34567`
{ "type": "add_info", "title": "bank_name", "data": "KBZ" }	Example: `KBZ`
{ "type": "qr_url", "title": "qr_url", "data": "https://example.com/qr.png" }	Example: `https://example.com/qr.png`

The following is the callback fragment containing display_data array.

"display_data": [
    {
        "type": "add_info",
        "title": "invoice_number",
        "data": "12345678901234"
    },
    {
        "type": "add_info",
        "title": "payment_amount_show",
        "data": "50000.00"
    },
    {
        "type": "add_info",
        "title": "bank_code",
        "data": "KBZ"
    },
    {
        "type": "add_info",
        "title": "account_number",
        "data": "123-456-789-012-34567"
    },
    {
        "type": "add_info",
        "title": "bank_name",
        "data": "KBZ"
    },
    {
        "type": "qr_url",
        "title": "qr_url",
        "data": "https://example.com/qr.png"
    }
]

Callback

In the Bank transfers in Myanmar payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Gate.

The following is an example of a callback body with the information about a successfully completed purchase.

Figure 6. Example of the data from a successful purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Bank transfer Myanmar",
        "sum": {
            "amount": 5000000,
            "currency": "MMK"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 5000000,
            "currency": "MMK"
        },
        "sum_converted": {
            "amount": 5000000,
            "currency": "MMK"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined purchase.

Figure 7. Example of the data from a declined purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Bank transfer Myanmar",
        "sum": {
            "amount": 5000000,
            "currency": "MMK"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 5000000,
            "currency": "MMK"
        },
        "sum_converted": {
            "amount": 5000000,
            "currency": "MMK"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Banks available for purchase

Supported banks

In the Bank transfers in Myanmar payment method, payments are performed through the banks the payment method supports.

The table below lists the banks available for purchase in the Bank transfers in Myanmar payment method.

Table 4. Banks available for purchase
Bank	ID
Ayeyarwady Bank (AYA Bank) (Old)	63601
Ayeyarwady Bank (AYA Bank) (Special)	63611
Co-operative Bank (CB Bank) (Old)	63621
Co-operative Bank (CB Bank) (Special)	63631
Kanbawza Bank	146
Yoma Bank (Old)	63641
Yoma Bank (Special)	63651

The table with the list of banks is provided for informational purposes only. It may change without notice. To get the current list of banks the Bank transfers in Myanmar payment method supports, send a request to the payment platform.

Request for the list of available banks

This section provides the instructions on how to build the request for the list of banks supported in the Bank transfers in Myanmar payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	`/v2/info/banks/myanmar/sale/list`
Full API endpoint specification	/v2/info/banks/{payment_method}/{operationType}/list

strictly required—parameter is required in the initial request.

Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained when integrating with Monetix.

Example: 123

payment_id
string
strictly required

Payment ID unique within the project.

If the payment is not yet created, set this parameter to a unique value.

Example: payment_47

signature
string
strictly required

Signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.

payment
object
strictly required

amount
integer
strictly required

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

Example: 50,000.00 MMK must be sent as 5000000

currency
string
strictly required

Code of the purchase currency in the ISO-4217 alpha-3 format.

Example: MMK

You can also add any other optional parameters to the request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from the request for the list of banks available in the Bank transfers in Myanmar payment method.

Figure 8. Example of the data from the request for the list of available banks

{
    "general": {
        "project_id": 200,
        "payment_id": "ORDER_155860015",
        "signature": "K6jll2ym+PtOb3ocZtr345st...=="
    },
    "payment": {
        "amount": 5000000,
        "currency": "MMK"
    }
}

Figure 9. Example of the response with the list of banks available in the payment method

[
    {
        "minAmount": 100, // Minimum payment amount allowed for the payment (in minor currency units)
        "maxAmount": 1000, // Maximum payment amount allowed for the payment (in minor currency units)
        "limitCurrency": "MMK", // Code of the currency used for the payment limits (minAmount and maxAmount) in the ISO-4217 alpha-3 format
        "id": 123, // Bank ID
        "abbr": "EXB", // Bank shortcut name (for internal use)
        "name": "Example Bank", // General bank name
        "nativeName": "Example Bank", // Native bank name
        "currencies": [ // Array with currencies supported by the bank
            {
                "id": 123, // Currency ID in the payment platform
                "alpha_3_4217": "MMK", // Alphabetic code of the payment currency in the ISO-4217 alpha-3 format
                "number_3_4217": "123", // Numeric code of the payment currency in the ISO-4217 alpha-3 format
                "currency_type": "fiat", // Type of the currency
                "exponent": 2 // Number of decimal places after decimal point
            }
        ]
    }
]

Bank transfers in Myanmar - Purchase

Operations support

Purchase by using Payment Page

General information

Request

Callback

Related topics

Purchase by using Gate

General information

Request

Customer redirection

Displaying the payment instructions to the customer

Callback

Related topics

Banks available for purchase

Supported banks

Request for the list of available banks