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 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:
- Send a request with all the required parameters and signature to the Monetix URL.
- 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.
- The customer initiates a payout in your system.
- Your system sends the payout 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 informs the payment platform about the payout result.
- The payment platform sends a callback with the payout result to your system.
- 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 |
|
|||
---|---|---|---|
Object | Parameter | Description | |
general | project_id | Project ID you obtained from Monetix when integrating. Example: | |
payment_id | Payment ID unique within your project. Example: | ||
signature | Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification. | ||
customer | id | Unique ID of the customer within your project. Example: | |
ip_address | IP address of the customer's device. Example: | ||
email | Customer's email. Example: | ||
account | number | Customer's account number. Example: | |
bank_id | Customer's bank ID. For information on how to get the list of the supported banks IDs, see Banks available for payout. Example: | ||
customer_name | Customer's full name. Example: | ||
payment | currency | Code of the payment currency in the ISO-4217 alpha-3 format. Example: | |
amount | 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 | ||
by_method | Payment method code. The value of this parameter is always equal to Example: | ||
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:
{ "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.
{
"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.
{
"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
- 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.
Bank | ID |
---|---|
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.