Bank transfers in Myanmar

Interaction diagram

Payment processing by using the Bank transfers in Myanmar payment method requires merchant web service, one of the Monetix interfaces, and the Monetix payment platform, as well as the provider's technical facilities.

Operations support

	Interfaces			Amounts, MMK		Times
	Payment Page	Gate	Dashboard	minimum	maximum	basic	threshold
Purchase				17,000.00	20,000,000.00	*	*

* Refer to your Monetix Key Account Manager for the information.

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 click the Payment methods tab.

Processing scenarios

In the Bank transfers in Myanmar method, you need to show your customer the payment instructions received from the provider service.

The sections that follow provide more information about what you need to perform payments and how you can analyze payments and operations information.

Supported banks

Payments through the Bank transfers in Myanmar method are carried out through the banks that support the method. To initiate a purchase by using Gate, you use the bank identifiers which are also used to display banks on Payment Page where your customer can choose a payment method.

The tables below provide information about supported banks.

General information

In the Bank transfers in Myanmar method, to perform a purchase by using Payment Page, the merchant web service is required to send a request with all the required parameters and signature to the Monetix URL and accept the callback with the payment result from the payment platform. When opening Payment Page, you can have Payment Page opened with the Bank transfers in Myanmar method preselected. For more information about preselecting payment methods, see Preselecting payment methods.

The full sequence and particularities of the purchase process are provided below.

The sections that follow discuss in more details the request format and the Payment Page parameters to use in the Bank transfers in Myanmar payment method and provide the information about the format of callbacks with payment results. For the general information on how to use the Payment Page API, see Payment Page API Description.

Request format

There are several things you need to consider when using the Bank transfers in Myanmar method:

1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are mandatory for any payment method:
   • project_id—the project ID obtained from Monetix
   • payment_id—payment ID unique within the project
   • customer_id—customer ID unique within the project
   • account_customer_name—customer full name
   • customer_email—customer email
   • payment_currency—code of payment currency in ISO-4217 alpha-3 format
   • payment_amount—payment amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
2. If you need to have payment form displayed with the Bank transfers in Myanmar method preselected, set the force_payment_method parameter to bank-transfer-myanmar.
3. By default, the messages with information about payment result are displayed in Burmese language. To change the language of the messages to English, add to your request the language_code parameter set to en.
4. If required, you can also add any optional parameters Payment Page supports. For information about all the parameters available in the Bank transfers in Myanmar method, see Payment Page invocation parameters.
5. After you specify all the parameters you need, you are required to create the signature for the request. For instructions on how to sign payment requests, see Signature generation and verification.

Here is an example of data from a purchase request.

EPayWidget.run(
    { 
        project_id: 1234,
        payment_id: 'payment_123',
        customer_id: 'customer_123',
        account_customer_name: 'John Doe',
        customer_email: 'johndoe@example.com',
        payment_amount: 5000000,
        payment_currency: 'MMK',
        signature: "kUi2x9dKHAVNU0FYldJrxhRLCvhtT4DqtVUkDJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

Callback format

The Bank transfers in Myanmar method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks in Payment Page.

The following is the example of a callback with an information about successful 50,000.00 MMK purchase made in the 1234 project.

{
        "project_id": 1234,
        "payment": {
            "id": "1561223423",
            "type": "purchase",
            "status": "success",
            "date": "2019-07-01T07:54:16+0000",
            "method": "Bank transfer Myanmar",
            "sum": {
                "amount": 5000000,
                "currency": "MMK"
            },
            "description": "1561714332889"
        },
        "customer": {
            "id": "customer_123"
        },
        "operation": {
            "id": 39811000003358,
            "type": "sale",
            "status": "success",
            "date": "2019-07-01T07:54:16+0000",
            "created_date": "2019-07-01T07:53:19+0000",
            "request_id": "1fb651fe71b5db9db3d6382c995c8f51b08785ff",
            "sum_initial": {
                "amount": 5000000,
                "currency": "MMK"
            },
            "sum_converted": {
                "amount": 5000000,
                "currency": "MMK"
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "YreiJ0aXQgDVuo74tsBXVRcd/0M9twm5IDxiZ8C2sqcuuncjkbazWKg=="
    }
}

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

{
        "project_id": 200,
        "payment": {
            "id": "1561223423",
            "type": "purchase",
            "status": "decline",
            "date": "2019-07-01T07:54:16+0000",
            "method": "Bank transfer Myanmar",
            "sum": {
                "amount": 5000000,
                "currency": "MMK"
            },
            "description": "1561714332889"
        },
        "customer": {
            "id": "customer_123"
        },
        "operation": {
            "id": 39811000003358,
            "type": "sale",
            "status": "success",
            "date": "2019-07-01T07:54:16+0000",
            "created_date": "2019-07-01T07:53:19+0000",
            "request_id": "1fb651fe71b5db9db3d6382c995c8f51b08785ff",
            "sum_initial": {
                "amount": 5000000,
                "currency": "MMK"
            },
            "sum_converted": {
                "amount": 5000000,
                "currency": "MMK"
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "YreiJ0aXQgDVuo74tsBXpZ8tmJi0IRVCy9twm5IDxiZ8C2sqcuuncjkbazWKg=="
    }
}

Related topics

The following topics might be useful when implementing payments by using Payment Page:

• Integration procedure
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

General information

In the Bank transfers in Myanmar method, to perform a purchase by using Gate, the merchant web service is required to do the following:

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

The following diagram provides the detailed picture of the payment processing procedure.

The sections that follow discuss in more details the request format and the Gate parameters to use in the Bank transfers in Myanmar payment method and provide the information on the format of callbacks with purchase results.

Request format

1. You initiate a purchase by submitting a purchase request to the /v2/payment/bank-transfer/myanmar/sale endpoint by using the HTTP method POST. This endpoint belongs to the following group of endpoints for the bank transfer payments: /v2/payment/bank-transfer/{payment_method}/sale.
2. The following objects and parameters must be specified in any request:
   • general—object with general request information:
     • project_id—the project ID obtained from Monetix
     • payment_id—payment ID unique within the project
     • signature—signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.
   • customer—object with customer information:
     • id—the unique ID of the customer within your project
     • ip_address—customer device IP
     • email—customer email address
   • payment—object with payment information:
     • amount—purchase amount in minor currency units without any decimal point or comma except for cases where the currency does not have any minor currency units. If the currency has no minor units (that is, the number of digits for minor currency units is zero), then you must set this parameter to the amount in the major currency units. For the information on whether the currency has any minor units, see Currency codes.
     • currency—code of purchase currency in ISO-4217 alpha-3 format
3. The following parameter must be specified in any request:
   • account—object with customer account information:
     • customer_name—customer full name

   If you do not submit this parameter in the initial request, the payment platform will request all or some of these parameters by sending to the web service a callback with a list of the parameters web service is required to submit. (For more information about this procedure, see Submission of additional payment information.) If the web service submits all the required parameters in the initial request, the payment platform will not issue such a callback.

4. If required, you can also add any optional parameters Gate supports.

Here is an example of data from a purchase request.

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_123",
        "signature": "U5LCm6489ly9cXCKIVBNV0mFr4XiCruECSyQEbT1hSXJ70zuH4...=="
    },
    "customer": {
        "ip_address": "198.51.100.47",
        "id": "customer_123",
        "email": "johndoe@email.com"
    },
    "account": {
        "customer_name": "John Doe"
    },
    "payment": {
        "amount": 5000000,
        "currency": "MMK"
    }
}

Format of the data for displaying the payment instructions

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.

{
	"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"
}

The following is a sample callback snippet with the 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 format

The Bank transfers in Myanmar method uses the standard format for callbacks to deliver purchase results. For more information, see Callbacks in Gate.

The following is the example of a callback with an information about successful 50,000.00 MMK purchase made in the 1234 project.

{
        "project_id": 1234,
        "payment": {
            "id": "1561223423",
            "type": "purchase",
            "status": "success",
            "date": "2019-07-01T07:54:16+0000",
            "method": "Bank transfer Myanmar",
            "sum": {
                "amount": 5000000,
                "currency": "MMK"
            },
            "description": "1561714332889"
        },
        "customer": {
            "id": "customer_123"
        },
        "operation": {
            "id": 39811000003358,
            "type": "sale",
            "status": "success",
            "date": "2019-07-01T07:54:16+0000",
            "created_date": "2019-07-01T07:53:19+0000",
            "request_id": "1fb651fe71b5db9db3d6382c995c8f51b08785ff",
            "sum_initial": {
                "amount": 5000000,
                "currency": "MMK"
            },
            "sum_converted": {
                "amount": 5000000,
                "currency": "MMK"
            },
            "code": "0",
            "message": "Success"
        },
        "signature": "YreiJ0aXQgDVuo74tsBXpZ8tmJi0IRVCyFucJ1a8E9twm5IDxiZ8C2sqcuuncjkbazWKg=="
    }
}

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

{
        "project_id": 1234,
        "payment": {
            "id": "1561223423",
            "type": "purchase",
            "status": "decline",
            "date": "2019-07-01T07:54:16+0000",
            "method": "Bank transfer Myanmar",
            "sum": {
                "amount": 5000000,
                "currency": "MMK"
            },
            "description": "1561714332889"
        },
        "customer": {
            "id": "customer_123"
        },
        "operation": {
            "id": 39811000003358,
            "type": "sale",
            "status": "success",
            "date": "2019-07-01T07:54:16+0000",
            "created_date": "2019-07-01T07:53:19+0000",
            "request_id": "1fb651fe71b5db9db3d6382c995c8f51b08785ff",
            "sum_initial": {
                "amount": 5000000,
                "currency": "MMK"
            },
            "sum_converted": {
                "amount": 5000000,
                "currency": "MMK"
            },
            "code": "20000",
            "message": "General decline"
        },
        "signature": "YreiJ0aXQgDVuo74tsBXpZ8tmJi0IRVb8E9twm5IDxiZ8C2sqcuuncjkbazWKg=="
    }
}

Related topics

The following topics might be useful when implementing payments through Gate:

• Integration procedure
• Payment types, operations and payments
• Signature generation and verification
• Operation statuses and response codes

As with other payment methods Monetix offers, when using this method, you have several options to analyze the information about payments and operations.

You can load and analyze all the necessary information in Dashboard (dash-light.trxhost.com), for instance you can use the analytic panels in the Analytics section for this purpose.

Also, you can export the information for further analysis by using third party analytical tools. The following options are available:

• Dashboard allows you to download reports in CSV format by using the tools in the Reports section. You can perform export as a one-time or regular download of data to your local computer.
• Data API allows you to have payment information exported in JSON format and delivered to a URL you specify. The payment information is exported by means of sending requests to the /operations/get endpoint.

If you have any further questions regarding payment data analysis, contact Monetix technical support.