Payout

When performing a payout, the customer initiates a payout and then just waits for the funds to be credited to their account. The customer themself doesn't participate in the payout processing procedure.

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.

Operations support

Interfaces
Payment Page Gate Dashboard
Payout

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.

Payout by using Gate

General information

To perform a payout by using Gate with the Unify Banks of Korea payment method:

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

The following picture provides the details of the payout processing flow in the Unify Banks of Korea payment method.

Figure 1. Payout processing flow when performing a payout by using Gate
  1. The customer initiates a payout in your system.
  2. Your system sends the payout request to the Monetix payment platform.
  3. 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.)
  4. The payment platform processes the request and forwards it to the provider service.
  5. The provider service informs the payment platform about the payout result.
  6. The payment platform sends a callback with the payout result to your system.
  7. Your system sends the payout result to the customer.

Request

This section provides the instructions on how to build the request for payout with the Unify Banks of Korea payment method.

HTTP request method POST
Request body format JSON
API endpoint /v2/payment/unify/payout
Table 1. Basic parameters of a payout request

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

ObjectParameterDescription

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

number
string
strictly required

Customer's account number.

Example: 1234567890123456

bank_id
integer
strictly required

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

Example: 1486

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

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

by_method
string
strictly required

Payment method code.

The value of this parameter is always equal to banks/korea.

Example: banks/korea

You can also add any other optional parameters to the payout 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 payout with the Unify Banks of Korea payment method:

Figure 2. Example of the payout 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": {
        "number": "1234567890123456",
        "bank_id": 1486,
        "customer_name": "John Doe"
    },
    "payment": {
        "currency": "KRW",
        "amount": 100000,
        "by_method": "banks/korea"
    }
}

Callback

In the Unify Banks of Korea payment method, the payment platform returns the payout 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 payout.

Figure 3. Example of the data from a successful payout callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "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": "payout",
        "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": ""
        }
    },
    "account": {
        "number": "1234567890123456"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure 4. Example of the data from a declined payout callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "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": "payout",
        "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": ""
        }
    },
    "account": {
        "number": "1234567890123456"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Payout by using Dashboard

To make a payout through Dashboard, the merchant sends a request and receives a notification with the request processing result. There are two ways to initiate payouts through Dashboard:
  • single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
  • as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.

Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.

For more information about payout processing by using Dashboard, see Performing payouts.

Banks available for payout

Supported banks

In the Unify Banks of Korea payment method, payments are performed through the banks the payment method supports. For the payout 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 payout in the Unify Banks of Korea payment method.

Table 2. Banks available for payout
BankID
Busan Bank - 부산은행1376
Citibank Korea - 한국씨티은행1476
Credit Union - 신용협동조합1426
Daegu Bank - 대구은행1366
dmsgod Mutual Savings Bank - 상호저축1396
Industrial Bank of Korea - 기업은행66672
Jeju Bank - 제주은행1456
Jeonbuk Bank - 전북은행1446
Jiyeok Nonghyup - NH지역농.축협75452
K Bank - 케이뱅크1486
KakaoBank - 카카오뱅크1406
KDB - 산업은행1386
KEB - 외환은행75532
KEB Hana Bank - 하나은행1466
Kookmin Bank - KB국민은행2751
Kwangju Bank - 광주은행1356
Kyongnam Bank - 경남은행66712
Kyungnam Bank - 경남은행77296
NACUFOK (shinhyup) - 신협중앙회77286
National Agricultural Cooperative Federation - 농협66682
Nonghyup Bank - NH농협은행2761
Post Bank - 우체국은행1436
Saemaeul Bank - 새마을금고77276
Shinhan - 신한은행751
Standard Chartered First Bank Korea - SC은행66692
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 Banks of Korea payment method supports, contact your key account manager at Monetix.