Payment Agency Bank transfer in Korea

Overview

Payment Agency Bank transfer in Korea is a payment method that allows customers to perform payments by using bank transfers. With Payment Agency Bank transfer in Korea, you can perform purchases by using Payment Page or Gate, and payouts by using Gate or Dashboard.

Download the logo in vector format here.
Payment method type bank transfers
Countries and regions Republic of Korea
Payment currencies USD
Currency conversion On the Monetix side
Purchases
Payouts
COF payments
Full refunds
Partial refunds
Chargebacks
Special considerations Customer is required to do some preparing steps before performing the first purchase. These actions described in details in the corresponding section.
Onboarding and access fee Refer to your key account manager at Monetix

Interaction diagram

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

Operations support

Interfaces Amounts, USD Times
Payment Page Gate Dashboard minimum maximum basic threshold
Purchases 40.00 50,000.00 10 seconds 24 hours
Payouts 2.00 50,000.00 20 seconds 24 hours

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 Payment Agency Bank transfer in Korea method, purchases and payouts follow different processing procedures. To perform a purchase, you need to redirect customer to the provider service, while to initiate a payout, you need to notify customer via merchant web service.

Figure 1. Purchase by using Payment Page
Figure 2. Refund by using Gate
Figure 3. Payout by using Gate

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

Customer preparation for purchase performing

Customer is required to complete the following steps before performing the first purchase:

  1. Sign up on the merchant web service.
  2. Sign up on the provider website.
  3. Complete KYC (Know Your Customer) verification on the provider website by opening the sign up page on the provider website and entering their email, phone number and bank account number.

    The personal data must relate to the same person, otherwise the KYC procedure will fail.

  4. Link the merchant code to the customer email on the provider website by completing the following steps.
    1. Go to the corresponding page on the provider website.
    2. Enter the name of the merchant shop and click the button with the merchant code on it.
    3. Enter the email previously used for registration at the merchant web service and click the confirmation button.
    4. Click the confirmation button to link the email with the selected merchant code.
Note: If your customer does not have an account within the provider service or does not link the merchant code to the email address, the provider service will display a page with the error. This page provides the description of the error and a link to the provider's service. Here is an example of the page with the error:

The customer is required to complete these steps only once and only before the first purchase. Any subsequent purchases do not require the customer to repeat the steps.

Purchase by using Payment Page

General information

In the Payment Agency Bank transfer in Korea method, when processing a purchase by using Payment Page, the merchant web service sends a request with all the required parameters and signature to the Monetix URL and accepts the callback with the payment result from the payment platform. The full sequence of the purchase workflow is provided below.

Figure 4. Purchase workflow when using Payment Page
  1. Customer initiates purchase on the merchant's web service.
  2. The web service sends the request for Payment Page opening to the Monetix URL.
  3. The request for opening Payment Page is redirected to the payment platform.
  4. The payment platform performs initial request processing that includes validation whether all required parameters are available and signature is correct.
  5. The requested Payment Page is generated by the Monetix payment platform as specified in the project settings and request parameters.
  6. Payment Page is displayed to the customer.
  7. The customer selects Payment Agency Bank transfer in Korea as payment method.
  8. The payment platform receives the purchase request for payment processing from Payment Page.
  9. The payment platform performs the internal purchase request processing and forwards it to the provider service.
  10. The purchase request is processed on the provider service side.
  11. The provider service generates the data for redirecting the customer to its website form and sends it to the payment platform.
  12. The payment platform sends the customer redirection data to Payment Page.
  13. The customer is redirected to the provider website.
  14. The customer completes all the payment steps required.
  15. The payment is processed on the provider side.
  16. The result is displayed to the customer on the provider website.
  17. The customer is redirected to Payment Page.
  18. The provider service sends the result notification to the payment platform.
  19. The payment platform sends callback with the payment result to the web service.
  20. The payment platform sends the result to Payment Page.
  21. The page with the payment result information is displayed to the customer on Payment Page.

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

Request format

There are several things you need to consider when dealing with purchase requests in the Payment Agency Bank transfer in Korea method:

  1. You must provide values for the basic minimum of parameters. Listed below are the parameters that are required for any payment method:
    • project_id—the project ID obtained from Monetix
    • payment_id—payment ID unique within the project
    • customer_id—the unique ID of the customer within your project
    • customer_first_name—customer first name
    • customer_last_name—customer last 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 Payment Agency Bank transfer in Korea method pre-selected, set the force_payment_method parameter to the code on the unify_eBuy payment method.
  3. You can also add any other additional parameters Payment Page supports. For more information about parameters supported by Payment Page, see Payment Page invocation parameters.
  4. After you specify all the parameters you need, you need to generate 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 request for Payment Page opening:

EPayWidget.run(
    {
        project_id: 1234, 
        payment_id: 'payment_123',
        customer_id: 'customer_123',
        payment_currency: 'USD',
        payment_amount: 10000,  
        customer_email: 'john-doe@example.com',
        customer_first_name: 'John',
        customer_last_name: 'Doe',
        customer_email: 'johndoe@email.com',      
        signature: "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KvySO\/RLCvhtT4DqtVUkJrOcZzUCwX6R\/ekpZhkIQg=="
    }
)

For information about all parameters available in the Payment Agency Bank transfer in Korea method , see Payment Page invocation parameters.

Callback format

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

The following is an example of a callback with an information about successful 100.00 USD purchase in the 1234 project.

Figure 5. Example of data from a successful purchase callback
{ 
    "project_id": 1234, 
    "payment": { 
        "id": "payment_47", 
        "type": "purchase", 
        "status": "success", 
        "date": "2022-03-18T07:55:42+0000", 
        "method": "unify", 
        "sum": { 
            "amount": 10000, 
            "currency": "USD" 
        }, 
        "description": "" 
    }, 
    "customer": { 
        "id": "customer_123" 
    }, 
    "operation": { 
        "sum_initial": { 
            "amount": 10000, 
            "currency": "USD" 
        }, 
        "sum_converted": { 
            "amount": 10000, 
            "currency": "USD" 
        }, 
        "code": "0", 
        "message": "Success", 
        "provider": { 
            "id": 12345, 
            "payment_id": "123-abc", 
            "auth_code": "" 
        }, 
        "id": 76543211234567, 
        "type": "sale", 
        "status": "success", 
        "date": "2022-03-18T07:55:42+0000", 
        "created_date": "2022-03-18T07:53:19+0000", 
        "request_id": "e37262894746bdc0610c5e852f39ae05fbc63efb" 
    }, 
    "signature": "i4pFETjW+HU7YlPhZMNRK/Qp6hijGDPV2FozEFHC36CTPu++OsteV18ttcVN0NyIUCBhXNyg==" 
}

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

Figure 6. Example of data from a declined purchase callback
{ 
    "project_id": 1234, 
    "payment": { 
        "id": "payment_47", 
        "type": "purchase", 
        "status": "decline", 
        "date": "2022-04-01T09:00:16+0000", 
        "method": "unify", 
        "sum": { 
            "amount": 10000, 
            "currency": "USD"  
        }, 
        "description": "" 
        }, 
    "customer": { 
        "id": "customer_123" 
    }, 
    "operation": { 
        "sum_initial": { 
            "amount": 10000, 
            "currency": "USD"  
        }, 
        "sum_converted": { 
            "amount": 10000, 
            "currency": "USD" 
        }, 
        "code": "20000", 
        "message": "General decline", 
        "provider": { 
            "id": 1234, 
            "payment_id": "123-abc", 
            "auth_code": "" 
        }, 
        "id": 76543211234567, 
        "type": "sale", 
        "status": "decline", 
        "date": "2022-04-01T09:00:16+0000", 
        "created_date": "2022-04-01T08:46:49+0000", 
        "request_id": "9d8102e6d123dfd9f0f147bceda442a4" 
    }, 
    "signature": "Vga2qnuGHlD0TbBioE/34xWV7z4GF2QCaJ6HxlR2sZ4+OHptq4T4tE49uGCDRsdowGb+Bpg==" 
}

Related topics

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

Purchase by using Gate

General information

In the Payment Agency Bank transfer in Korea method, the merchant web service is required to do the following when processing a purchase by using Gate:

  1. Send request with all the required parameters and signature to the Monetix URL.
  2. Redirect the customer to the provider service.
  3. Accept the callback with the payment result from the payment platform.

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

Figure 7. Purchase by using Gate
  1. Customer initiates purchase with Payment Agency Bank transfer in Korea on the merchant's web service side.
  2. The web service sends a request for processing the purchase by using Gate to the Monetix URL.
  3. The payment platform receives the request for processing the purchase from Gate.
  4. The payment platform performs initial request processing that includes validation whether all required parameters are available and signature is correct.
  5. The payment platform sends the response with request receipt confirmation and validation result to the web service. For more information about the response format, see Response structure.
  6. The payment platform performs the internal payment request processing and redirects the request to the provider service.
  7. The request is processed on the provider service side.
  8. The provider service sends the data for redirecting the customer to the provider service to the payment platform.
  9. The payment platform sends the callback with the redirection data inside the redirect_data object to the web service.
  10. The customer is redirected from the web service to the provider service.
  11. The customer completes all the payment steps required.
  12. The payment is processed on the provider service side.
  13. The result is displayed to the customer.
  14. The customer is redirected to the merchant web service.
  15. The provider service sends the payment result notification to the payment platform.
  16. The payment platform sends the callback with the payment result to the web service.
  17. The web service sends the payment result to the customer.

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

Request format

There are several things you need to consider when dealing with purchase requests in the Payment Agency Bank transfer in Korea method:

  1. You initiate a purchase by submitting a purchase request to the /v2/payment/unify/sale endpoint by using the HTTP method POST.
  2. The following objects and parameters must be specified in any request:
    • general—object with general request identification information:
      • project_id—the project ID you 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—IP address of the customer's device
      • first_name—customer first name
      • last_name—customer last name
      • email—customer email
    • payment—object with purchase 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 the ISO-4217 alpha-3 format
      • by_method—payment method code, always equal to eBuy
    • return_url—object with the information where to redirect the customer to when the payment is completed or prematurely terminated by the customer. In the request, it's necessary to use either both the success and decline parameters or only the return parameter:
      • success—the URL to redirect the customer to after the payment is successfully completed.
      • decline—the URL to redirect the customer to after the payment is declined.
      • return—the URL to redirect the customer to when they prematurely terminate the payment.
  3. If required, you can add any other additional parameters Gate supports.

Here is an example of data from a purchase request in the Payment Agency Bank transfer in Korea method.

Figure 8. Example of data from a purchase request
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "payment": {
        "amount": 10000,
        "currency": "USD",
        "by_method": "eBuy"
    },
    "return_url": {
        "return": "http://example.com/return"
    } 
}

Format of customer redirection data

After receiving and processing your purchase request, the payment platform sends a callback to your web service containing the data to redirect 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 be sent in the request body
  • method—the HTTP method to get an HTML page of the website (for example, POST or GET)
  • encrypted—this is the service parameter. Ignore the data it contains.

Here is an example of a piece of callback containing the data to redirect the customer.

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

Callback format

The Payment Agency Bank transfer in Korea 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 100.00 USD purchase in the 1234 project.

Figure 9. Example of data from a successful purchase callback
{ 
    "project_id": 1234, 
    "payment": { 
        "id": "payment_47", 
        "type": "purchase", 
        "status": "success", 
        "date": "2022-03-18T07:55:42+0000", 
        "method": "unify", 
        "sum": { 
            "amount": 10000, 
            "currency": "USD" 
        }, 
        "description": "" 
    }, 
    "customer": { 
        "id": "customer_123" 
    }, 
    "operation": { 
        "sum_initial": { 
            "amount": 10000, 
            "currency": "USD" 
        }, 
        "sum_converted": { 
            "amount": 10000, 
            "currency": "USD" 
        }, 
        "code": "0", 
        "message": "Success", 
        "provider": { 
            "id": 12345, 
            "payment_id": "123-abc", 
            "auth_code": "" 
        }, 
        "id": 76543211234567, 
        "type": "sale", 
        "status": "success", 
        "date": "2022-03-18T07:55:42+0000", 
        "created_date": "2022-03-18T07:53:19+0000", 
        "request_id": "e37262894746bdc0610c5e852f39ae05fbc63efb" 
    }, 
    "signature": "i4pFETjW+HU7YlPhZMNRK/Qp6hijGDPV2FozEFHC36CTPu++OsteV18ttcVN0NyIUCBhXNyg==" 
}

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

Figure 10. Example of data from a declined purchase callback
{ 
    "project_id": 1234, 
    "payment": { 
        "id": "payment_47", 
        "type": "purchase", 
        "status": "decline", 
        "date": "2022-04-01T09:00:16+0000", 
        "method": "unify", 
        "sum": { 
            "amount": 10000, 
            "currency": "USD"  
        }, 
        "description": "" 
        }, 
    "customer": { 
        "id": "customer_123" 
    }, 
    "operation": { 
        "sum_initial": { 
            "amount": 10000, 
            "currency": "USD"  
        }, 
        "sum_converted": { 
            "amount": 10000, 
            "currency": "USD" 
        }, 
        "code": "20000", 
        "message": "General decline", 
        "provider": { 
            "id": 1234, 
            "payment_id": "123-abc", 
            "auth_code": "" 
        }, 
        "id": 76543211234567, 
        "type": "sale", 
        "status": "decline", 
        "date": "2022-04-01T09:00:16+0000", 
        "created_date": "2022-04-01T08:46:49+0000", 
        "request_id": "9d8102e6d123dfd9f0f147bceda442a4" 
    }, 
    "signature": "Vga2qnuGHlD0TbBioE/34xWV7z4GF2QCaJ6HxlR2sZ4+OHptq4T4tE49uGCDRsdowGb+Bpg==" 
}

Related topics

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

Payout by using Gate

General information

To perform payout with the Payment Agency Bank transfer in Korea method, merchant's web service sends a request with all the required parameters and signature to Monetix URL, and receives callback with the payment result. The complete sequence of the payout process is provided below.

Figure 11. Payout by using Gate
  1. Customer initiates payout through the Payment Agency Bank transfer in Korea system.
  2. Merchant's web service sends the request for the payout processing by using Gate to the appropriate Monetix URL.
  3. Gate redirects the request to the Monetix payment platform.
  4. The payment platform performs all the necessary checks and processes the request.
  5. The reply with the request processing results is sent to the merchant's web service. For more information, see Response structure.
  6. The payment platform redirects the payout request to the provider service.
  7. The payout is processed on the provider side.
  8. Provider service sends the result notification to the payment platform.
  9. The payment platform sends a callback with the payment result to the web service.
  10. The customer receives the notification about the payout result from the web service.

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

Request format

There are several things you must consider when using payout requests in the Payment Agency Bank transfer in Korea method:
  1. You initiate payout by sending a request to the /v2/payment/unify/payout endpoint by using HTTP method POST.
  2. The following objects and parameters must be specified in any request:
    • general—object with general request identification 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—IP address of the customer's device
      • first_name—customer first name
      • last_name—customer last name
      • email—customer email
    • account—object with customer account information:
      • number—customer email
    • payment—object with payout information:
      • amount—payout 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 payout currency in the ISO-4217 alpha-3 format
  3. The currency of payout can only be USD.
  4. If required, you can also add any other additional parameters Gate supports.

Here is an example of data from a payout request in the Payment Agency Bank transfer in Korea method.

Figure 12. Example of a payout request 
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "PJkV8ej\/UG0Di8hTng6JvC7vQsaC6tajQVVfBaNIipTv+AWoXW\/9MTO8yJA=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "account": {
        "number": "john@example.com"
    },
    "payment": {
        "amount": 10000,
        "currency": "USD"
    }
}

Callback format

The Payment Agency Bank transfer in Korea method uses the standard format for callbacks to deliver payout results. For more information, see Callbacks in Gate.

The following is the example of a callback with an information about successful 40.00 USD payout in the 1234 project.

Figure 13. Example of data from a successful payout callback
{
    "project_id": 1234,
    "customer": {
        "id": "customer_123"
    },
    "account": {
        "number": "john@example.com"
    },
    "payment": {
        "id": "payment_123",
        "type": "payout",
        "status": "success",
        "date": "2022-04-13T13:44:16+0000",
        "method": "unify",
        "sum": {
            "amount": 4000,
            "currency": "USD"
        },
        "description": ""
    },
    "operation": {
        "sum_initial": {
            "amount": 4000,
            "currency": "USD"
        },
        "sum_converted": {
            "amount": 4000,
            "currency": "USD"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "payment_321",
            "auth_code": ""
        },
        "id": 12345677654321,
        "type": "payout",
        "status": "success",
        "date": "2022-04-13T13:44:16+0000",
        "created_date": "2022-04-13T13:44:05+0000",
        "request_id": "14b7e478db824350ffa84221f0f362e6d7c97cc5e0c"
    },
    "signature": "tz5SSyh1GZyyy9NvuQqyEtLpO47ZkhnlvCK2oQS6mvSn9xDjygVqN3lyDMQ=="
}

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

Figure 14. Example of data from a declined payout callback
{
    "project_id": 1234,
    "customer": {
        "id": "customer_123"
    },
    "account": {
        "number": "john@example.com"
    },
    "payment": {
        "id": "payment_123",
        "type": "payout",
        "status": "decline",
        "date": "2022-04-14T09:52:03+0000",
        "method": "unify",
        "sum": {
            "amount": 4000,
            "currency": "USD"
        },
        "description": ""
    },
    "operation": {
        "sum_initial": {
            "amount": 4000,
            "currency": "USD"
        },
        "sum_converted": {
            "amount": 4000,
            "currency": "USD"
        },
        "code": "100",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "payment_321",
            "auth_code": ""
        },
        "id": 12345677654321,
        "type": "payout",
        "status": "decline",
        "date": "2022-04-14T09:52:03+0000",
        "created_date": "2022-04-14T09:51:55+0000",
        "request_id": "510873c7bd365ff8847218def8adbd435871dc60b9f00b94e2a9a"
    },
    "signature": "yrBjHMTRdsrkZYWBWdA7/NlYNJIYbiigTYLPg8nj6zbGTU2mixgWAXuW4vTLJuY1OrUPMRQ=="
}

Related topics

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

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.

Analysis of payments results

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.