Unify Bank transfers in Korea - Scenario 2. Purchase with payment instructions

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	Republic of Korea
Payment currencies	KRW
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 The amounts for the KRW currency must be specified in major currency units (without any fractional part) according to the ISO-4217 alpha-3 standard. For example, if the customer initiates a 1000 KRW purchase in your system, you are required to submit the `1000` as the payment amount in your purchase request. You can check the number of digits for minor currency units for any currency in Currency codes. If the customer enters an amount which is different from the amount specified in the purchase request, the payment processing will proceed as described in Handling payments with amount changed by customer. The payment will be declined if the customer doesn't complete the purchase within 15 minutes after the payment was initiated.

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 Unify Bank transfers in Korea 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 Unify Bank transfers in Korea 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 Unify Bank transfers in Korea payment method.
The payment platform forwards the request to the provider service.
The provider service generates the payment instructions to show to the customer and sends them to the payment platform.
The checkout page displays the payment instructions to the customer.
The customer completes the purchase.
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 need to include in the request for purchase through the checkout page with the Unify Bank transfers in Korea 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

account_number
string
required

Customer's account number.

Example: 1234567890

payment_currency
string
strictly required

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

Example: KRW

payment_amount
integer
strictly required

Payment amount in major currency units (without fractional part).

If the currency has minor units (i.e. the number of digits for minor currency units is not zero), set this parameter to the amount in the minor currency units without any decimal point or comma. To check whether the currency has any minor units, see Currency codes.

Example: 100,000 KRW must be sent as 100000

force_payment_method
string
optional

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

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

Example: force_payment_method: 'unify_bank-transfer-korea'

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_day_of_birth
string
required

Customer's day of birth in the DD-MM-YYYY format.

Example: 22-11-2000

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',
		account_number: '1234567890',
		payment_currency: 'KRW',
		payment_amount: 100000,
		force_payment_method: 'unify_bank-transfer-korea',
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg==',
		customer_day_of_birth: '22-11-2000'
	}
)

Callback

In the Unify Bank transfers in Korea 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": "unify",
        "sum": {
            "amount": 100000,
            "currency": "KRW"
        },
        "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": 100000,
            "currency": "KRW"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KRW"
        },
        "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": "unify",
        "sum": {
            "amount": 100000,
            "currency": "KRW"
        },
        "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": 100000,
            "currency": "KRW"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KRW"
        },
        "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 Unify Bank transfers in Korea 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 Unify Bank transfers in Korea 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 processes the request and forwards it to the provider service.
The provider service generates the payment instructions to show to the customer and sends them to the payment platform.
The payment platform forwards the instructions to your system in the display_data array.
Your system displays the payment instructions to the customer.
The customer completes the purchase.
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 Unify Bank transfers in Korea payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	/v2/payment/unify/sale

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 omit this parameter from the request, the payment platform will request the parameter by sending your system a callback with the list of all the missing parameters you are required to submit. For more information on how to act in such cases, see Submission of additional payment information.

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

day_of_birth
string
required

Customer's day of birth in the DD-MM-YYYY format.

Example: 22-11-2000

account
object
strictly required

number
string
required

Customer's account number.

Example: 1234567890

bank_id
string
strictly required

Customer's bank ID. For information on how to get the list of the supported banks IDs, see Banks available for purchase.

Example: 12345

customer_name
string
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: KRW

amount
integer
strictly required

Payment amount in major currency units (without fractional part).

Example: 100,000 KRW must be sent as 100000

by_method
string
strictly required

Payment method code.

The value of this parameter is always equal to bank-transfer-korea.

Example: bank-transfer-korea

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 Unify Bank transfers in Korea 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",
        "day_of_birth": "22-11-2000"
    },
    "account": {
        "number": "1234567890",
        "bank_id": "12345",
        "customer_name": "John Doe"
    },
    "payment": {
        "currency": "KRW",
        "amount": 100000,
        "by_method": "bank-transfer-korea"
    }
}

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.

Each element of this array contains the following parameters:

type—element type. its value is always add_info.
title—name of the payment instruction data, can take one the following values:
- receiver_account—account number of the payment recipient
- bank_name—recipient's bank name
data—payment instruction data

Here is an example of the callback snippet with the data for displaying the payment instructions to the customer.

"display_data": [
    {
        "type": "add_info",
        "title": "receiver_account",
        "data": "5151515151515"
    },
    {
        "type": "add_info",
        "title": "bank_name",
        "data": "테스트은행"
    }
]

Callback

In the Unify Bank transfers in Korea 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": "unify",
        "sum": {
            "amount": 100000,
            "currency": "KRW"
        },
        "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": 100000,
            "currency": "KRW"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KRW"
        },
        "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": "unify",
        "sum": {
            "amount": 100000,
            "currency": "KRW"
        },
        "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": 100000,
            "currency": "KRW"
        },
        "sum_converted": {
            "amount": 100000,
            "currency": "KRW"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Banks available for purchase

Supported banks

In the Unify Bank transfers in Korea payment method, payments are performed through the banks the payment method supports. For the purchase to be performed, your request must contain the ID of the customer's bank in the account.bank_id parameter.

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

Table 3. Banks available for purchase
Bank	ID
Bank of America	67751
Bank of China	67761
BNP Paribas Bank	70652
Busan Bank	1376
China Construction Bank	70582
Citibank Korea	1476
Daegu Bank	1366
Deutsche Bank	67801
HSBC Bank	70562
IBK	761
Industrial and Commercial Bank of China	67771
Jeju Bank	1456
Jeonbuk Bank	1446
JPMorgan Chase Bank	70712
K Bank	1486
KakaoBank	1406
KDB	1386
KEB Hana Bank	1466
Kookmin Bank	2751
Kwangju Bank	1356
Kyungnam Bank	1346
National Forestry Cooperative Federation	81814
Nonghyup Bank	2761
Post Bank	1436
Saemaul	811
Saving Bank	70622
SC First Bank	2801
Shinhan	751
Shinhyup Bank	70272
Suhyup Bank	1416
TossBank	70282
Woori	791

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 Unify Bank transfers in Korea 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 Unify Bank transfers in Korea payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	`/v2/info/banks/unify/sale/list`
Full API endpoint specification	/v2/info/banks/{parentMethod}/{childMethod}/{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 major currency units (without fractional part).

Example: 100,000 KRW must be sent as 100000

currency
string
strictly required

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

Example: KRW

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 Unify Bank transfers in Korea 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": 100000,
        "currency": "KRW"
    }
}

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": "KRW", // 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": "KRW", // 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": 0 // Number of decimal places after decimal point
            }
        ]
    }
]

Unify Bank transfers in Korea - Scenario 2. Purchase with payment instructions

Operations support

Purchase by using Payment Page

General information

Request

Callback

Related topics

Purchase by using Gate

General information

Request

Displaying the payment instructions to the customer

Callback

Related topics

Banks available for purchase

Supported banks

Request for the list of available banks