EXIMBAY Developers

Payment

In this section, you can find examples of the Eximbay API endpoint, along with object information, parameters, and request & response details.
The Eximbay API enables payment authorization, refunds, inquiries, and verification across multiple payment methods.
For details on the necessary keys, verification methods, and security measures required for API utilization, please refer to the Payment Page Integration Preparation section.

Payment preparation

POST/v1/payments/ready

FgKey is used to prevent unauthorized modifications and falsification, ensuring the integrity of the request and response parameters exchanged between the merchant and Eximbay during the validation process. Please refer to the Payment Preparation API to generate the FGKey required for calling the payment page.

The FGKey generated by the Payment Preparation API is required for calling the payment page using the JavaScript SDK. Please refer to the JavaScript SDK for further details on utilizing the FGKey to initiate the payment page.

Request parameter

payment object

transaction_type string

Mandatory

Classify the payment page type accordingly. The options include PAYMENT, PAYER_AUTH AUTHORIZE REBILL. For detailed information, please refer to the Payment Preparation documentation.

PAYMENT

: The payment page facilitates the automatic completion of payment authentication, authorization, and acquiring processes.

PAYER_AUTH

: In this model, only verification will be performed during the payment page initiation. Automated authorization and acquiring API or authorization-only API is required for this process.

AUTHORIZE

: In this model, verification and authorization will be performed during the payment page initiation.Settlement (acquiring) will be processed through the manual acquiring API initiated by the merchant.

* An additional contract is required for the manual acquiring API.

REBILL

: In this model, verification, authorization, and acquiring are performed without requiring additional card information input. Instead, the process utilizes the token ID generated during the Token Creation step after the payment page is invoked.

order_id string

Mandatory

This is a unique identifier used to classify a merchant's order. This value cannot be reused for failed orders.

currency string

Mandatory

Payment Currency Unit. For detailed information, please refer to the currency code.

amount string

Mandatory

Total Payment Amount. The amount must be greater than "0" and , cannot be used.

lang string

Mandatory

Language Code: Specifies the language used on the payment page.

payment_method string

Payment Method Code: Defines the designated payment method that will redirect to the payment page. Please refer to the payment method code for details.

multi_payment_method string

For multiple payment method designations, use a hyphen - as a separator (e.g., P000-P185-P186)

* For Cross-Border payment Integration.

merchant object

mid string

Mandatory

A unique merchant ID generated by Eximbay to identify the merchant.

shop string

Store Name: If the store name differs from the merchant name, please specify accordingly.

partner_code string

Partner code

url object

return_url string

Mandatory

URL Information for the Merchant Page which where the buyer will be redirected after completing the payment process and receiving the payment result. The return URL is browser-based for the customer. If the browser is forcefully terminated, the return URL will not be initiated.

status_url string

Mandatory

Upon completion of the payment, the parameters returned via both the return_url, which is triggered based on the customer's browser, and the status_url, which is triggered from the merchant's server, will be identical Script cookies and session storage cannot be used, as they are not accessible in the browser.

* Database tasks and payment processing should be handled within the statusURL.
* The returnURL will not be invoked if the customer forcefully terminates the session
* Duplicate invocation is allowed; however, please ensure that the payment is not processed multiple times.

buyer object

name string

Mandatory

Customer's name

phone_number string

Customer's contact number

email string

Mandatory

Customer's email address. (for sending payment confirmation letter)

tax object* This parameter is used for Korean local payment processing.

receipt_status string

Select Y or N for issuing a cash payment receipt. For bank transfer payments, you must choose either Y or N for receipt issuance.

amount_tax_free string

The amount deducted for tax from the total payment.

amount_taxable string

The amount for tax from the total payment.

amount_vat string

The amount for VAT from the total payment.

amount_service_fee string

The amount for service charge from the total payment.

Note. 1 - All parameters in the tax object are mandatory for Naver Point payments.
Note. 2 - The response codes for local and cross-border payments differ after the SDK callback.

other_param object

param1 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

param2 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

product array * The array length is limited to three.

name string

Mandatory

Merchandise Name

quantity string

Mandatory

Merchandise quantity

unit_price string

Mandatory

Merchandise unit price

link string

Mandatory

Merchandise purchasing link. this is mandatory for open market transactions.

surcharge array * The array length is limited to three.

name string

The name of the additional amount category (e.g., discount coupon, delivery fee).

quantity string

The quantity of the additional amount category, which must be greater than zero.

unit_price string

The unit price of the additional amount category, which cannot include , and may be sent with a negative quantity

ship_to object

city string

Delivery city

country string

Delivery country. ISO3166 two digit country code.

first_name string

Recipient's first name

last_name string

Recipient's last name

phone_number string

Recipient's contact number, with the option to include the country code.

postal_code string

Postal code

state string

Delivery state. This is applicable for delivery addresses in the U.S. and Canada, Please refer to the country code.

street1 string

Provide the remaining address details accordingly

bill_to object

city string

Billing city

country string

Billing country. ISO3166 two digit country code.

first_name string

Card holder's first name

last_name string

Card holder's first name

phone_number string

Card holder's contact number. with the option to include the country code.

postal_code string

Billing postal code

state string

Billing state. This is applicable for delivery addresses in the U.S. and Canada, Please refer to the country code.

street1 string

Provide the remaining address details accordingly

settings object

display_type string

Options for initiating the browser. The default value is P

: Opens the payment page as a pop-up.

: Redirects to the payment page from the merchant's site.

autoclose string

Options for closing the browser after payment completion. The default value is N.

: Redirects to the merchant's page.

: Redirects to the payment success page (default).

site_foreign_currency string

This parameter is essential for displaying the amount in the currency selected by the customer on the payment page

* If the payment_method parameter is used, only P000 (credit card) can be specified.

* Merchants utilizing the DCC service will have DCC-supported currencies displayed on the payment page. For information on DCC-supported currencies, please refer to the DCC currency code.

* The real-time exchange rate is applied to the transaction amount through Eximbay's DCC service provider. Once the credit card information is entered, the amount will be converted to the currency of the card-issuing country.

* For Cross-Border payment Integration.

call_from_app string

Options for distinguishing the client environment. The default value is N.

Y
: Call in the application environment (iOS, Android).
N
: Call in the web browser environment (default).
* Call the payment page within an app environment. Please refer to the External App Open in the WebView Integration Guide for further details.

call_from_scheme string

App scheme (App URL Scheme) to redirect from an external app to the merchant's app.

* Call the payment page within an app environment. Please refer to the External App Open in the WebView Integration Guide for further details.

issuer_country string

Parameters for merchants utilizing cross-border payments who wish to adopt Korean local payments. Add the parameter KR to call the Korean local payment page.

ostype string

To call the payment page in a client environment. The default value is P.

: PC environment (default)

: Mobile environment

virtualaccount_expiry_datestring

Set the expiration date for Korean local virtual account payments. The required format is YYYYMMDDHH24.

tokenbilling object

token_creation string

To verify whether a token creation request has been made for cross-border issuing card simplified payment.

: Token creation requested

* This is limited to transactions with the transaction type parameter set as PAYMENT.

unique_token_id string

To verify whether a token creation request has been made based on unique payment information (card).

: Token creation is allowed only for unique payment information (card). The request will be rejected if the payment information (card) already exists.

: Multiple token creations are allowed for the same payment information (card).

* This is limited to transactions with the transaction type parameter set as PAYMENT.

token_id string

Issued Token ID by Token creation request.

* This is limited to transactions with the transaction type parameter set as REBILL.

Note. 1 - An additional contract is required for the token payment.

recurring object * Parameters for recurring payment registration

recurring_amount string

Mandatory

Recurring payment total amount : A maximum of 10 digits, including two decimal places (e.g., 10.50, 9.15).
, are not allowed as separators.

recurring_start_date string

Mandatory

Recurring payment start date : must be in an 8-digit format (YYYYMMDD).
The recurring date (next payment date) must be set after the start date, with payments processed on a monthly basis.

recurring_interval string

Mandatory

Processed on a monthly basis. The maximum recurring payment cycle is 10 months. (e.g., If the cycle is 3 months, enter '3').

recurring_noti_url string

Merchant's page to be redirected to after the recurring payment is completed. Maximum length is 255 characters.

remind_email_interval string

Notification email sent prior to the recurring payment (default value: 3). Maximum length is 2 characters.
(Example: If set to '7', a notification email will be sent 7 days before the recurring payment date.)

fast_payment object

user_id string

Mandatory

User ID

user_ci string

Mandatory

User CI

* After completing identity verification on the merchant's site, set the 'userCi' as a parameter.

* If identity verification is not conducted on the merchant's site, prior notification to Eximbay is required, and 'userCi' should be set as a blank value.

phone_number string

Mandatory

Phone number

* Set as a blank value, if identity verification is not conducted on the merchant's site.

birthday string

Mandatory

Birth day (YYYYMMDD)

* Set as a blank value, if identity verification is not conducted on the merchant's site.

gender string

Mandatory

Gender

: Male

: Female

* Set as a blank value, if identity verification is not conducted on the merchant's site.

foreigner string

Mandatory

Foreigner

: Foreigner

: Citizen

* Set as a blank value, if identity verification is not conducted on the merchant's site.

Note. 1 - An additional contract is required for the fast payment.

Request

                                                        
            curl --request POST 'https://api-test.eximbay.com/v1/payments/ready' \
            --header 'Authorization: Basic dGVzdF8xODQ5NzA1QzY0MkMyMTdFMEIyRDo=' \
            --header 'Content-Type: application/json' \
            --data '{
                "payment" : {
                    "transaction_type" : "PAYMENT",
                    "order_id" : "20220819105102",
                    "currency" : "USD",
                    "amount" : "1",
                    "lang" : "EN"
                },
                "merchant" : {
                    "mid" : "1849705C64"
                },
                "buyer" : {
                    "name" : "eximbay",
                    "email" : "test@eximbay.com"
                },
                "url" : {
                    "return_url" : "eximbay.com",
                    "status_url" : "eximbay.com"
                },
                "tokenbilling" : {
                    "token_creation" : "Y",
                    "unique_token_id" : "Y"
                },
                "recurring" : {
                    "recurring_amount" : "1.15",
                    "recurring_start_date" : "20250210",
                    "recurring_interval" : "1",
                    "recurring_noti_url" : "https://Merchant url",
                    "remind_email_interval" : "5"
                }
            }'

Response parameter

rescode string

Mandatory

Response code

resmsg string

Mandatory

Description of Response Codes

fgkey string

Mandatory

After generating the FGKey, use the SDK to initiate the payment page. Please refer to the payment preparation for further details.

Response

                                                        
    {
        "rescode": "0000",
        "resmsg": "Success",
        "fgkey": "0E9BE04BA239A519E68171F26B68604ADA0A85C8350DBF5C8C0FCCF98461DB09"
    }

Payment authorization

POST/v1/payments/confirm

After completing payment verification on the 3DS payment page, invoke the 'Payment Authorization API' to finalize the payment.

Request parameter

transaction_type string

Mandatory

Select the payment authorization methods after completing payment verification on the 3DS payment page. The options include PAYMENT_PA AUTHORIZE_PA. Please refer to the payment preparation for further details.

PAYMENT_PA

: In this model, verification and authorization will be performed during the payment page initiation.

AUTHORIZE_PA

: In this model only payment authorization will be performed. acquiring will be processed through the manual acquiring API.

mid string

Mandatory

A unique merchant ID generated by Eximbay to identify the merchant.

payment object

order_id string

Mandatory

This is a unique identifier used to classify a merchant's order. This value cannot be reused for failed orders.

currency string

Mandatory

Payment Currency Unit. For detailed information, please refer to the currency code.

amount string

Mandatory

Total Payment Amount. The amount must be greater than "0" and , cannot be used.

payer_auth_id string

Mandatory

Initiating the payment page through the 3DS payment page under the PAYER_AUTH will return a transaction ID as a response.

lang string

Mandatory

Language Code: Specifies the language used on the payment page.

other_param object

param1 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

param2 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

Request

                                                        
    curl --request POST 'https://api-test.eximbay.com/v1/payments/confirm' \
    --header 'Authorization: Basic dGVzdF8xODQ5NzA1QzY0MkMyMTdFMEIyRDo=' \
    --header 'Content-Type: application/json' \
    --data '{
        "transaction_type" : "PAYMENT_PA",
        "mid" : "1849705C64",
        "payment" : {
            "order_id" : "20220902101716",
            "currency" : "USD",
            "amount" : "1",
            "payer_auth_id" : "20220902101716",
            "lang" : "EN"
        }
    }'

Response parameter

rescode string

Mandatory

Response code

resmsg string

Mandatory

Description of Response Codes

mid string

Mandatory

A unique merchant ID generated by Eximbay to identify the merchant.

payment object

order_id string

Mandatory

This is a unique identifier used to classify a merchant's order. This value cannot be reused for failed orders.

currency string

Mandatory

Payment Currency Unit. For detailed information, please refer to the currency code.

amount string

Mandatory

Total Payment Amount. The amount must be greater than "0" and , cannot be used.

email string

Mandatory

Customer's email address. (for sending payment confirmation letter)

transaction_id string

Mandatory

This is a unique Eximbay transaction ID used to classify a merchant.

auth_code string

Authorization number

* A simplified payment transaction does not generate an authorization number.

transaction_date string

Mandatory

The returned authorization date is formatted as YYYYMMDDHHMMSS.

access_country string

The customer's location at the time of the payment, represented by the ISO 3166 two digit country code.

payment_method string

Payment Method Code: Defines the designated payment method that will redirect to the payment page. Please refer to the payment method code for details.

pay_to string

Billing merchant's name

payment_url string

URL information providing the payment procedure details for customers at the "Registered" stage of the Japanese convenience store payment.

status string

Payment status for Virtual account payment or Japanese convenient store payment(eContext).

Registered

: Order Completed status can only be processed after the Sale request has been received.

Sale

: Once the customer completes the deposit, the statusurl will be sent.

base_currency string

Authorized amount

* In this model, the returned value will match the currency parameter. For MCP transactions, the original country currency will be returned as KRW or USD.

* Utilizing acquiring data for referral merchant.

* For Cross-Border payment Integration.

base_amount string

Authorized amount

* In this model, the returned value will match the currency parameter. For MCP transactions, the original country currency will be returned as KRW or USD.

* Utilizing acquiring data for referral merchant.

* For Cross-Border payment Integration.

base_rate string

Exchange rate for authorized currencies

* The exchange rate from the specified currency to the base currency. If the specified currency matches base_currency, a value of 1 will be returned.

* Utilizing acquiring data for referral merchant.

* For Cross-Border payment Integration.

dcc_rate string

Exchange rate information for DCC service

* The exchange rate from the specified base currency to the foreign currency. If the specified base_currency matches the foreign_currency, a value of 1 will be returned.

* For Cross-Border payment Integration.

terminal_id string

VAN terminal ID

card_number string

Credit card number

expiry_date string

Credit card expiration date

store_number string

Acquirer's merchant number

foreign object

foreign_currency string

The amount to be billed to the customer.

* The selected DCC currency unit chosen by the customer will be returned.

* For Cross-Border payment Integration.

foreign_amount string

Customer's billing amount

* The selected DCC currency unit chosen by the customer will be returned.

* For Cross-Border payment Integration.

foreign_rate string

Information regarding the exchange rate applied to the amount to be billed to the customer

* The exchange rate from the specified currency to the foreign currency. If the specified currency matches foreign_currency, a value of 1 will be returned.

* For Cross-Border payment Integration.

card_info object

card_holder string

Card holder's first name

card_number1 string

The first four digits of the card used for payment.

card_number4 string

The last four digits of the card used for payment.

cash_receipt object

use_flag string

To verify whether a cash payment receipt is issued.

* Required parameter for virtual account payments and Naver Point payments.

cash_receipt_type string

The purpose of issuing a cash payment receipt : Income Tax Deduction or Reimbursement Receipt.

* Required parameter for virtual account payments and Naver Point payments.

customer_information_type string

The issuing methods, such as a phone number, ID number, or card number, will be required for generating a cash payment receipt.

* Required parameter for virtual account payments and Naver Point payments.

customer_information string

Issuing method entered for issuing cash payment receipt.

* Required parameter for virtual account payments and Naver Point payments.

ship_to object

city string

Delivery city

country string

Delivery country. ISO3166 two digit country code.

first_name string

Recipient's first name

last_name string

Recipient's last name

phone_number string

Recipient's contact number, with the option to include the country code.

postal_code string

Postal code

state string

Delivery state. This is applicable for delivery addresses in the U.S. and Canada, Please refer to the country code.

street1 string

Provide the remaining address details accordingly

dm object

dm_decision string

DM Process Status : The status codes are as follows

: Payment is authorized following the DM Process risk assessment.

REJECT

: Payment is rejected following the DM Process risk assessment.

REVIEW

: Payment is under risk review and requires further evaluation to determine if it is a high-risk transaction.

ERROR

: DM Process failed.

dm_reject string

REJECT Rule Code: The rule code uses I as a separator. Additional documentation for the rule code will be provided.

dm_review string

REJECT Rule Code: The rule code uses I as a separator. Additional documentation for the rule code will be provided.

other_param object

param1 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

param2 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

Response

    
    {
        "rescode": "0000",
        "resmsg": "Success",
        "mid": "1849705C64",
    }

Payment verification

POST/v1/payments/verify

This is for initiating the payment page via SDK. Validate the FGKey included in the response.
Utilize the Payment Validation API to finalize the payment. Please refer to the precautions below.

The response parameters from the Eximbay server to the merchant's status_url is in query string format.
Response parameters received in the query string must be submitted to the Payment Verification API.
Please refer to the payment preparation for further details.

Note. 1 - Initiating the payment page via SDK will alter the response value received through status_url based on the selected transaction_type and request parameters used.
Note. 2 - The response codes for local and cross-border payments differ after the SDK callback.

Request parameter

version string

Mandatory

Payment page initiated via SDK version.

mid string

Mandatory

A unique merchant ID generated by Eximbay to identify the merchant.

transaction_type string

Mandatory

The payment page type corresponds to the initiation method via SDK. The response parameters received from the Eximbay server vary depending on the selected payment page type.

fgkey string

Mandatory

fgkey used for initiating payment page.

order_id string

Mandatory

This is a unique identifier used to classify a merchant's order. This value cannot be reused for failed orders.

currency string

Mandatory

Payment Currency Unit. For detailed information, please refer to the currency code.

amount string

Mandatory

Total Payment Amount. The amount must be greater than "0" and , cannot be used.

email string

Mandatory

Customer's email address. (for sending payment confirmation letter)

param1 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

param2 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

param3 string

A preparatory parameter available for merchants if needed.

rescode string

Mandatory

Response code

resmsg string

Mandatory

Description of Response Codes

transaction_id string

This is a unique Eximbay transaction ID used to classify a merchant.

auth_code string

Authorization number

* A simplified payment transaction does not generate an authorization number.

payer_auth_id string

Initiating the payment page through the 3DS payment page under the PAYER_AUTH will return a transaction ID as a response.

transaction_date string

The returned authorization date is formatted as YYYYMMDDHHMMSS.

access_country string

The customer's location at the time of the payment, represented by the ISO 3166 two digit country code.

payment_method string

Payment Method Code: Defines the designated payment method that will redirect to the payment page. Please refer to the payment method code for details.

payment_type string

Select Korean local simplified payments.

* Required parameter for Korean local simplified payments.

pay_to string

Billing merchant's name

card_holder string

Card holder's first name

card_number1 string

The first four digits of the card used for payment.

card_number4 string

The last four digits of the card used for payment.

installment_months string

Installment term

* Available for Korean local payment

status string

Mandatory

The status code for payment status through payment page is as follows.

SALE

: Payment successful (Sale is confirmed).

AUTH

: Payment authorized (Sale is not confirmed; manual acquisition is required).

REGISTERED

: Order registered (Sale will be confirmed after funds are transferred).

NONE

: No existing order.

ship_to_city string

Delivery city

ship_to_country string

Delivery country. ISO3166 two digit country code.

ship_to_first_name string

Recipient's first name

ship_to_last_name string

Recipient's last name

ship_to_phone_number string

Recipient's contact number, with the option to include the country code.

ship_to_postal_code string

Postal code

ship_to_state string

Delivery state. This is applicable for delivery addresses in the U.S. and Canada, Please refer to the country code.

ship_to_street1 string

Provide the remaining address details accordingly

useFlag string

To verify whether a cash payment receipt is issued.

* Required parameter for virtual account payments and Naver Point payments.

cash_receipt_type string

The purpose of issuing a cash payment receipt : Income Tax Deduction or Reimbursement Receipt.

* Required parameter for virtual account payments and Naver Point payments.

cash_receipt_deduction_detail string

The issuing methods, such as a phone number, ID number, or card number, will be required for generating a cash payment receipt.

* Required parameter for virtual account payments and Naver Point payments.

cash_receipt_user_info string

Issuing method entered for issuing cash payment receipt.

* Required parameter for virtual account payments and Naver Point payments.

virtual_account_number string

A virtual account number is required to process a virtual account payment.

virtual_account_bank_name string

Virtual account bank name

virtual_account_depositor string

Beneficiary name

virtual_account_due_date string

Deadline for fund transfer to the virtual account

Note. 1 - Mandatory object for virtual account payment and Japanese convenience store payment.
Note. 2 - Payment results for virtual account payment and Japanese convenience store payment will be returned in two stages.
• Order Registration : Returned via return_url and status_url
• Funds Transfer Notification : Returned via status_url
Note. 3 - The order registration result returned via status_url is optional.

payment_url string

URL information providing the payment procedure details for customers at the "Registered" stage of the Japanese convenience store payment.

dm_decision string

DM Process Status : The status codes are as follows

: Payment is authorized following the DM Process risk assessment.

REJECT

: Payment is rejected following the DM Process risk assessment.

REVIEW

: Payment is under risk review and requires further evaluation to determine if it is a high-risk transaction.

ERROR

: DM Process failed.

dm_reject string

REJECT Rule Code: The rule code uses I as a separator. Additional documentation for the rule code will be provided.

dm_review string

REJECT Rule Code: The rule code uses I as a separator. Additional documentation for the rule code will be provided.

base_currency string

Authorized amount

* In this model, the returned value will match the currency parameter. For MCP transactions, the original country currency will be returned as KRW or USD.

* Utilizing acquiring data for referral merchant.

* For Cross-Border payment Integration.

base_amount string

Authorized amount

* In this model, the returned value will match the currency parameter. For MCP transactions, the original country currency will be returned as KRW or USD.

* Utilizing acquiring data for referral merchant.

* For Cross-Border payment Integration.

base_rate string

Exchange rate for authorized currencies

* The exchange rate from the specified currency to the base currency. If the specified currency matches base_currency, a value of 1 will be returned.

* Utilizing acquiring data for referral merchant.

* For Cross-Border payment Integration.

foreign_currency string

The amount to be billed to the customer.

* The selected DCC currency unit chosen by the customer will be returned.

* For Cross-Border payment Integration.

foreign_amount string

Customer's billing amount

* The selected DCC currency unit chosen by the customer will be returned.

* For Cross-Border payment Integration.

foreign_rate string

Information regarding the exchange rate applied to the amount to be billed to the customer

* The exchange rate from the specified base currency to the foreign currency. If the specified currency matches the foreign_currency, a value of 1 will be returned.

* For Cross-Border payment Integration.

dcc_rate string

Exchange rate information for DCC service

* The exchange rate from the specified base currency to the foreign currency. If the specified base_currency matches the foreign_currency, a value of 1 will be returned.

* For Cross-Border payment Integration.

terminal_id string

VAN terminal ID

card_number string

Credit card number

expiry_date string

Credit card expiration date

store_number string

Acquirer's merchant number

cavv string

cavv for authentication verification results.

xid string

xid for authentication verification results.

eci string

eci for authentication verification results.

token_id string

Token ID for token creation request.

* This will be used for token-based payment integration.

token_creation string

To verify whether a token creation request has been made for cross-border issuing card simplified payment.

* Return the parameters received during the token creation request.

recurring_payment string

To confirm whether a recurring payment has been registered.
Maximum length is 1 character.

: Recurring payment is registered.

recurring_id string

Recurring payment ID : This is required for recurring Payment refund and modification requests.
Maximum length is 20 characters.

recurring_next_date string

The next recurring payment date.
Maximum length is 8 characters.

Request

                                                        
    curl --request POST 'https://api-test.eximbay.com/v1/payments/verify' \
    --header 'Authorization: Basic dGVzdF8xODQ5NzA1QzY0MkMyMTdFMEIyRDo=' \
    --header 'Content-Type: application/json' \
    --data '{
        "data" : "currency=USD&card_number1=4111&transaction_date=20220927152250&card_number4=1111&mid=1849705C64&amount=100&access_country=KR&order_id=20220927152140&payment_method=P101&email=test@eximbay.com&ver=230&transaction_id=1849705C6420220927000016&param3=TEST&resmsg=Success.&card_holder=TESTP&rescode=0000&auth_code=309812&fgkey=2AE38D785E05E6AF57977328908C7CD84A273B3FE6C042D537A800B0CBC783EA&transaction_type=PAYMENT&pay_to=EXIMBAY.COM"
    	    }'

Response parameter

rescode string

Mandatory

Response code

resmsg string

Mandatory

Description of Response Codes

Response

    
    {
        "rescode": "0000",
        "resmsg": "Success",
    }

Payment inquiry

POST/v1/payments/retrieve

Inquiries regarding payment authorization or refund.

Request parameter

mid string

Mandatory

A unique merchant ID generated by Eximbay to identify the merchant.

key_field string

Mandatory

Payment inquiries are optional and can be made using either the order_id or transaction_id.

order_id

: Inquiries can be made for authorized or refunded transactions using the order ID.

transaction_id

: This is used for inquiring about specific transactions.

payment object

order_id string

Mandatory

This is a unique identifier used to classify a merchant's order. This value cannot be reused for failed orders.

currency string

Mandatory

Payment Currency Unit. For detailed information, please refer to the currency code.

amount string

Mandatory

Total Payment Amount. The amount must be greater than "0" and , cannot be used.

lang string

Mandatory

Language Code: Specifies the language used on the payment page.

transaction_id string

This is a unique Eximbay transaction ID used to classify a merchant.

other_param object

param1 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

param2 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

Request

                                                        
    curl --request POST 'https://api-test.eximbay.com/v1/payments/retrieve' \
    --header 'Authorization: Basic dGVzdF8xODQ5NzA1QzY0MkMyMTdFMEIyRDo=' \
    --header 'Content-Type: application/json' \
    --data '{
        "mid" : "1849705C64",
        "key_field" : "order_id", 
        "payment" : {
            "order_id" : "20220902101716",
            "currency" : "USD",
            "amount" : "1",
            "transaction_id" : "20220902101716",
            "lang" : "EN"
        }
    }'

Response parameter

rescode string

Mandatory

Response code

resmsg string

Mandatory

Description of Response Codes

mid string

Mandatory

A unique merchant ID generated by Eximbay to identify the merchant.

payment object

status string

Mandatory

The status code for payment status through inquiries is as follows.

SALE

: Payment successful (Sale is confirmed).

AUTH

: Payment authorized (Sale is not confirmed; manual acquisition is required).

REGISTERED

: Order registered (Sale will be confirmed after funds are transferred).

NONE

: No existing order.

order_id string

Mandatory

This is a unique identifier used to classify a merchant's order. This value cannot be reused for failed orders.

currency string

Mandatory

Payment Currency Unit. For detailed information, please refer to the currency code.

amount string

Mandatory

Total Payment Amount. The amount must be greater than "0" and , cannot be used.

transaction_id string

Mandatory

This is a unique Eximbay transaction ID used to classify a merchant.

auth_code string

Authorization number

* A simplified payment transaction does not generate an authorization number.

transaction_date string

Mandatory

The returned authorization date is formatted as YYYYMMDDHHMMSS

balance string

Refundable balance (authorization amount - refund amount)

payment_method string

Payment Method Code: Defines the designated payment method that will redirect to the payment page. Please refer to the payment method code for details.

card_info object

card_number1 string

The first four digits of the card used for payment.

card_number4 string

The last four digits of the card used for payment.

other_param object

param1 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

param2 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

Response

                                                        
    {
        "rescode": "0000",
        "resmsg": "Success.",
        "mid": "1849705C64",
        "payment": {
            "order_id": "20220902101716",
            "currency": "USD",
            "amount": "1",
            "transaction_id": "1849705C6420220902000010",
            "status": "AUTH",
            "auth_code": "485760",
            "transaction_date": "20220902101749",
            "balance": "1.00"
        },
        "card_info": {
            "cardno1": "4111",
            "cardno4": "1111"
        }
    }

Payment refund

POST/v1/payments/{transaction_id}/cancel

The transaction_id is used for processing refunds on authorized payments.

Request parameter

mid string

Mandatory

A unique merchant ID generated by Eximbay to identify the merchant.

refund object

refund_type string

Mandatory

The payment refund types are as follows.

: Full amount refund

: Partial refund

refund_amount string

Mandatory

The refund amount cannot exceed the original payment amount. If the refund_type is selected as F and no amount is entered, the full amount will be refunded.

refund_id string

Mandatory

This is a unique refund ID used to categorize a merchant's refund. This value must be unique and cannot be duplicated.

reason string

Mandatory

Reason for the refund request

payment object

order_id string

Mandatory

The original order ID is required for the refund process, as it corresponds to the transaction that will be refunded.

currency string

Mandatory

Payment Currency Unit. For detailed information, please refer to the currency code.

amount string

Mandatory

Total Payment Amount. The amount must be greater than "0" and , cannot be used.

balance string

Mandatory

Refundable balance (authorization amount - refund amount)

lang string

Mandatory

Language Code: Specifies the language used on the payment page.

other_param object

param1 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

param2 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

refund_account object*A parameter is required for processing a virtual account payment refund.

user_name string

Beneficiary name of the bank account to which the refund amount will be remitted.

bank_code string

Bank code of the bank account for refund.

account_number string

Bank account number for refund.

tax object* Required parameter for virtual account payments and Naver Point payments.

receipt_status string

Select Y or N for issuing a cash payment receipt. For bank transfer payments, you must choose either Y or N for receipt issuance.

amount_tax_free string

The portion of the refund amount that is exempt from taxation

amount_taxable string

The amount for tax from the refund amount

amount_vat string

The amount for VAT from the refund amount

amount_service_fee string

The amount for service charge from the refund amount.

Request

                                                    
    curl --request POST 'https://api-test.eximbay.com/v1/payments/{transaction_id}/cancel' \
    --header 'Authorization: Basic dGVzdF8xODQ5NzA1QzY0MkMyMTdFMEIyRDo=' \
    --header 'Content-Type: application/json' \
    --data '{
    "mid" : "1849705C64",
    "refund" : {
        "refund_type" : "F",
        "refund_amount" : "1",
        "refund_id" : "1849705C64",
        "reason" : "change of mind"
    },
    "payment" : {
        "order_id" : "20220829170258",
        "currency" : "USD",
        "amount" : "1",
        "balance" : "1",
        "lang" : "EN"
    }
    }'

Response parameter

rescode string

Mandatory

Response code

resmsg string

Mandatory

Description of Response Codes

mid string

Mandatory

A unique merchant ID generated by Eximbay to identify the merchant.

refund object

refund_amount string

Mandatory

The refund amount cannot exceed the original payment amount. If the refund_type is selected as F and no amount is entered, the full amount will be refunded.

refund_id string

Mandatory

This is a unique refund ID used to categorize a merchant's refund. This value must be unique and cannot be duplicated.

refund_date string

Mandatory

The refund date is formatted as YYYYMMDDHHMMSS.

refund_transaction_id string

Mandatory

This is a unique Eximbay refund ID used to classify a refund transaction.

payment object

order_id string

Mandatory

The original order ID is required for the refund process, as it corresponds to the transaction that will be refunded.

currency string

Mandatory

Payment Currency Unit. For detailed information, please refer to the currency code.

amount string

Mandatory

Total Payment Amount. The amount must be greater than "0" and , cannot be used.

transaction_id string

Mandatory

This is a unique Eximbay transaction ID used to classify a merchant.

balance string

Mandatory

Refundable balance (authorization amount - refund amount)

auth_code string

Authorization number

* A simplified payment transaction does not generate an authorization number.

base_amount string

Authorized amount

* In this model, the returned value will match the currency parameter. For MCP transactions, the original country currency will be returned as KRW or USD.

* Utilizing acquiring data for referral merchant.

* For Cross-Border payment Integration.

base_rate string

Exchange rate for authorized currencies

* The exchange rate from the specified currency to the base currency. If the specified currency matches base_currency, a value of 1 will be returned.

* Utilizing acquiring data for referral merchant.

* For Cross-Border payment Integration.

dcc_rate string

Exchange rate information for DCC service

* The exchange rate from the specified base currency to the foreign currency. If the specified base_currency matches the foreign_currency, a value of 1 will be returned.

* For Cross-Border payment Integration.

foreign objcet

foreign_currency string

The amount to be billed to the customer.

* The selected DCC currency unit chosen by the customer will be returned.

* For Cross-Border payment Integration.

foreign_amount string

Customer's billing amount

* The selected DCC currency unit chosen by the customer will be returned.

* For Cross-Border payment Integration.

foreign_rate string

Information regarding the exchange rate applied to the amount to be billed to the customer

* The exchange rate from the specified currency to the foreign currency. If the specified currency matches foreign_currency, a value of 1 will be returned.

* For Cross-Border payment Integration.

other_param object

param1 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

param2 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

Response

                                                
    {
        "rescode": "0000",
        "resmsg": "Success.",
        "mid": "1849705C64",
        "refund": {
            "refund_amount": "1.00",
            "refund_id": "1849705C64",
            "refund_date": "20220922113927",
            "refund_transaction_id": "1849705C6420220922000014"
        },
        "payment": {
            "order_id": "20220922113330",
            "currency": "USD",
            "amount": "1.00",
            "transaction_id": "1849705C6420220922000013",
            "balance": "0.00",
            "base_amount": "1.00",
            "base_rate": "1.000000",
            "dcc_rate": "1.000000",
            "payment_method" : "P101"
        },
        "foreign": {
            "foregin_currency": "USD",
            "foregin_amount": "1.00",
            "foregin_rate": "0"
        }
    }

Token management

Token payment

POST/v1/payments/tokenbilling/{token_id}/rebill

Request parameter

payment object

order_id string

Mandatory

This is a unique identifier used to classify a merchant's order. This value cannot be reused for failed orders.

currency string

Mandatory

Payment Currency Unit. For detailed information, please refer to the currency code.

amount string

Mandatory

Total Payment Amount. The amount must be greater than "0" and , cannot be used.

lang string

Mandatory

Language Code: Specifies the language used on the payment page.

merchant object

mid string

Mandatory

A unique merchant ID generated by Eximbay to identify the merchant.

shop string

Store Name: If the store name differs from the merchant name, please specify accordingly.

buyer object

name string

Mandatory

Customer's name

phone_number string

Customer's contact number

email string

Mandatory

Customer's email address. (for sending payment confirmation letter)

other_param object

param1 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

param2 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

product array * The array length is limited to three.

name string

Mandatory

Merchandise Name

quantity string

Mandatory

Merchandise quantity

unit_price string

Mandatory

Merchandise unit price

link string

Mandatory

Merchandise purchasing link. this is mandatory for open market transactions.

surcharge array * The array length is limited to three.

name string

The name of the additional amount category (e.g., discount coupon, delivery fee).

quantity string

The quantity of the additional amount category, which must be greater than zero.

unit_price string

The unit price of the additional amount category, which cannot include , and may be sent with a negative quantity

ship_to object

city string

Delivery city

country string

Delivery country. ISO3166 two digit country code.

first_name string

Recipient's first name

last_name string

Recipient's last name

phone_number string

Recipient's contact number, with the option to include the country code.

postal_code string

Postal code

state string

Delivery state. This is applicable for delivery addresses in the U.S. and Canada, Please refer to the country code.

street1 string

Provide the remaining address details accordingly

bill_to object

city string

Billing city

country string

Billing country. ISO3166 two digit country code.

first_name string

Card holder's first name

last_name string

Card holder's first name

phone_number string

Card holder's contact number. with the option to include the country code.

postal_code string

Billing postal code

state string

Billing state. This is applicable for delivery addresses in the U.S. and Canada, Please refer to the country code.

street1 string

Provide the remaining address details accordingly

Request


curl --request POST 'https://api-test.eximbay.com/v1/payments/tokenbilling/{token_id}/rebill' \
--header 'Authorization: Basic dGVzdF8xODQ5NzA1QzY0MkMyMTdFMEIyRDo=' \
--header 'Content-Type: application/json' \
--data '{
    "payment" : {
        "order_id" : "20220902101716",
        "currency" : "USD",
        "amount" : "1"
    },
    "merchant" : {
        "mid" : "1849705C64"
    },
    "product" : [
        {
        "name" : "",
        "quantity" : "",
        "unit_price" : ""
        }
    ]
}

Response parameter

rescode string

Mandatory

Response code

resmsg string

Mandatory

Description of Response Codes

errcode string

Mandatory

Error code for payment error

tokenbilling object

token_id string

Mandatory

Issued Eximbay Token ID by Token creation request

payment object

order_id string

Mandatory

This is a unique identifier used to classify a merchant's order. This value cannot be reused for failed orders.

currency string

Mandatory

Payment Currency Unit. For detailed information, please refer to the currency code.

amount string

Mandatory

Total Payment Amount. The amount must be greater than "0" and , cannot be used.

lang string

Mandatory

Language Code: Specifies the language used on the payment page.

transaction_id string

Mandatory

This is a unique Eximbay transaction ID used to classify a merchant.

auth_code string

Mandatory

Authorization number

transaction_date string

The returned authorization date is formatted as YYYYMMDDHHMMSS.

payment_method string

Payment Method Code: Defines the designated payment method that will redirect to the payment page. Please refer to the payment method code for details.

payment_method_name string

Payment method

access_country string

The customer's location at the time of the payment, represented by the ISO 3166 two digit country code.

pay_to string

Billing merchant's name

merchant object

mid string

Mandatory

A unique merchant ID generated by Eximbay to identify the merchant.

shop string

Store Name: If the store name differs from the merchant name, please specify accordingly.

buyer object

name string

Mandatory

Customer's name

phone_number string

Customer's contact number

email string

Mandatory

Customer's email address. (for sending payment confirmation letter)

other_param object

param1 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

param2 string

A preparatory parameter available for merchants if needed. The parameter length is limited to 255 characters.

product array * The array length is limited to three.

name string

Mandatory

Merchandise Name
If multiple merchandise items are ordered, the name of the first item will be used.

card_info object

card_holder string

Card holder's first name

card_number1 string

The first four digits of the card used for payment.

card_number4 string

The last four digits of the card used for payment.

dm object

dm_decision string

DM Process Status : The status codes are as follows

: Payment is authorized following the DM Process risk assessment.

REJECT

: Payment is rejected following the DM Process risk assessment.

REVIEW

: Payment is under risk review and requires further evaluation to determine if it is a high-risk transaction.

ERROR

: DM Process failed.

dm_reject string

REJECT Rule Code. The rule code uses I as a separator. Additional documentation for the rule code will be provided.

dm_review string

REJECT Rule Code. The rule code uses I as a separator. Additional documentation for the rule code will be provided.

token_id string

Token ID for token creation request.

* This will be used for token-based payment integration.

token_creation string

To verify whether a token creation request has been made for cross-border issuing card simplified payment.

* Return the parameters received during the token creation request.

Response


{
    "rescode" : "0000",
    "resmsg" : "Success.",
    "payment" : {
        "order_id" : "20220902101716",
        "currency" : "USD",
        "amount" : "1",
        "transaction_id" : "EN",
        "auth_code" : "EN",
        "transaction_date" : "EN",
        "access_country" : "EN",
        "payment_method" : "EN",
        "pay_to" : "EN",
        "lang" : "EN",
        "payment_method_name" : "EN"
    },
    "card_info" : {
        "card_holder" : "HONG GIL DONG",
        "card_number1" : "4111",
        "card_number4" : "1111"
    }
}

Token deletion

POST/v1/payments/tokenbilling/{token_id}/delete

Delete the generated token using the token_id.

Response parameter

rescode string

Mandatory

Response code
Maximum length is 4 characters.

resmsg string

Mandatory

Description of Response Codes
Maximum length is 4 characters.

Response


{
    "rescode": "0000",
    "resmsg": "Success."
}

Token card identification value inquiry

GET/v1/payments/tokenbilling/{token_id}

Inquiry for generated token card identification value.

Request parameter

Request


curl --request GET 'https://api-test.eximbay.com/v1/payments/tokenbilling/{token_id}' \
--header 'Authorization: Basic dGVzdF8xODQ5NzA1QzY0MkMyMTdFMEIyRDo=' \
--header 'Content-Type: application/json; charset=UTF-8' \
--data '{
}'

Response parameter

rescode string

Mandatory

Response code
Maximum length is 4 characters.

resmsg string

Mandatory

Description of Response Codes
Maximum length is 4 characters.

token_id string

Mandatory

Token ID for token creation request. Maximum length is 20 characters.

card_identifier string

Mandatory

Identification value of the card used for payment to generate the token. Maximum length is 64 characters.

Response


{
    "rescode": "0000",
    "resmsg": "Success.",
    "token_id": "",
    "card_identifier": ""
}

Payment

Payment preparation

Payment authorization

Payment verification

Payment inquiry

Payment refund

Manual acquiring

Token management

Token payment

Token deletion

Token card identification value inquiry

Recurring payment

Recurring payment cancellation

Modification of recurring payment information

Settlement confirmation