Code Copied.

API Reference

version 1.0

  • version 1.0

Eximbay API

Explore Eximbay API endpoint, request/response parameters and sample codes.
Integrate various payment methods and additional APIs easily with Eximbay API.
For more information about API Key and authentication to use the API, refer to Preparing JavaScript SDK.

Ready a Payment

POST/v1/payments/ready

FGKey is used to authenticate and validate parameters transferred between the merchant and Eximbay.
Create the FGKey before requesting the JavaScript SDK. For the details, please refer to the Preparing FGkey

The FGKey created with the Payment Ready API is required when request the payment with the JavaScript SDK.
Please request the JavaScript SDK with FGKey received as response parameter from Payment Ready API. For the details, please refer to javascript SDK.

Request

payment object

transaction_type string

Require
It is necessary to classify the SDK Type for the online payment. For details, refer to Preparing Payments.
  1. PAYMENT

    : This type includes Authentication, Authorization and Capture in one transaction.

  2. PAYER_AUTH

    : This type includes only Authentication in one transaction. After receiving the response, you need to request additional APIs for Authorization and Capture.

  3. AUTHORIZE

    : This type includes Authentication and Authorization in one transaction. After Authorization the payments, you can request Capture API for capturing the payments.

* Capture API is available after a separate contract.

order_id string

Require

This is the unique order ID issued by Merchant to identify accepted or canceled transactions.

currency string

Require

The type of currency in currency codes.

amount string

Require

Total payment amount. , is not allowed, only numbers greater than zero can be sent.

lang string

Require

The type of language shown in the payment SDK. Refer to the Supported Languages.

payment_method string

The type of payment method. Refer to payment method codes.
This parameter is used when you want to call a specific payment method.

multi_payment_methodstring

Must be sent when specifying multiple payment methods. Use separator -. (e.g. P000-P185-P186) 

merchant object

mid string

Require

This is the unique merchant ID issued by Eximbay to identify merchants.

shop string

Shop name. Required when Shop name is different from Merchant name.

partner_code string

Partner Codes.

url object

return_url string

Require

Merchant page that is called when the user exits the payment screen on the payment result confirmation screen.
Since returnurl operates based on the customer's browser, it may not be cal led if the browser is forcibly closed.

status_url string

Require
After payment is completed, it is the merchant page called from Backend, and the return url and parameter are the same.
Since it is not called from the browser, scripts, cookies, and sessions cannot be used.

* DB operation and payment process must be handled by statusurl, and returnurl may not becalled
depending on the payment method orwhen the customer forcibly closes the payment screen.

* Since statusurl can be called in duplicate, please make sure that your order is not processed in duplicate.

buyer object

name string

Require

Buyer name.

phone_number string

Contact number of buyer.

email string

Require

Email address of buyer. This email is necessary for sending payment confirmation email.

tax object* Required for local payment.

amount_tax_free string

Tax-free amount out of the total payment amount.

amount_taxable string

Taxable amount out of the total payment amount.

amount_vat string

VAT out of the total payment amount.

amount_service_fee string

Service-fee out of the total payment amount.

Note. 1 - You must send all parameters in the tax object when you proceed with payment with Naver Pay points.

other_param object

param1 string

Preliminary parameters that merchants can use if needed.

param2 string

Preliminary parameters that merchants can use if needed.

product array* Array length is up to 3.

name string

Require

The product name of the ordered product.

quantity string

Require

The quantity of the ordered product.

unit_price string

Require

The unit price of the ordered product.

link string

Require

Link of the ordered product. For orders placed on the open market, it is mandatory to send it.

surcharge array* Array length is up to 3.

name string

The name of the surcharge. (e.g. coupon, shipping fee)

quantity string

The quantity of the surcharge. Quantity can only be positive.

unit_price string

The unit price of the surcharge. , cannot be included, and can have postive or negative values. (e.g. -100.50, 9.15)

ship_to object

city string

Shipping city. (e.g . Hanoi, Brisbane, Houston)

country string

Shipping country. The type of country in ISO 3166 format.

first_name string

The first name of the recipient of the shipment.

last_name string

The last name of the recipient of the shipment.

phone_number string

The phone number of the recipient of the shipment.

postal_code string

The postal code of the shipping address.

state string

State or province of the shipping address. Required only when the shipping country is US or CA. (e.g. MA, NY, CA). Refer to State, Province and Territory Codes for the United States and Canada.

street1 string

The street of the shipping address. (e.g. 123 Main street, 56 Le Loi street)

bill_to object

city string

Billing city. (e.g . Hanoi, Brisbane, Houston)

country string

Billing country. The type of country in ISO 3166 format.

first_name string

Card holder's first name.

last_name string

Card holder's last name.

phone_number string

The phone number of the billing card holder.

postal_code string

The billing zip code(postal code).

state string

Billing State information. Available if your billing address is in the United States(US) or Canada(CA). Refer to Area code.

street1 string

The street of the shipping address. (e.g. 123 Main street, 56 Le Loi street)

settings object

display_type string

You can select how the payment opens in your browser. One of P or R. If not sent, P is sent by default.
  1. P

    : Pop-up

  2. R

    : Replace

autoclose string

You can control how the browser closes the payment window when the payment is completed. One of Y or N. If not sent, N is sent by default.
  1. Y

    : Go to the merchant page.

  2. N

    : Go to the completion page of the payment (default)

site_foreign_currency string

Required to show the amount in the currency set by the customer on the merchant site.

* If you used the payment_method parameter, you can only send a P000(Credit Card).

* When using DCC at a merchant, only DCC supported currencies can be displayed in the payment SDK. DCC supported currencies can be found in DCC Currency Codes.

* The price is based on the real-time exchange rate inquired through the Eximbay DCC Provider. After the card information is finally entered, it may be changed to the currency of the card issuance country.

call_from_app string

Classification of client environment. One of Y or N. If not sent, N is senty by default.
  1. Y

    : App(iOS, Android) environment

  2. N

    : Web browser environment (default)

call_from_scheme string

The App URL Scheme required to return from an external app to the merchant app.

issuer_country string

This parameter is required to use domestic payment with send KR at a merchant who use global payment.

ostype string

This is the client environment that opens the payment window. If parameter is sent by empty, P is sent to the default.
P

: PC (default)

M

: Mobile

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"
        }
    }'
Response

rescode string

Require
Code of response.

resmsg string

Require
Description of response code.

fgkey string

Require
When you try to open SDK, you must put same FGKey. You can refer to Preparing FGKey.
Response 
                                                
    {
    	"rescode": "0000",
    	"resmsg": "Success",
    	"fgkey": "0E9BE04BA239A519E68171F26B68604ADA0A85C8350DBF5C8C0FCCF98461DB09"
    }

Confirm a Payment

POST/v1/payments/confirm

After authenticating the payment with the Authentication Payment, request the payment confirm API and complete the payment.
Request

transaction_type string

Require
It is necessary to classify the SDK Type for the online payment. For the details, please refer to Preparing Payments.
  1. PAYER_AUTH

    : This type includes only Authentication in one transaction. After receiving the response, you need to request additional APIs for Authorization and Capture.

  2. AUTHORIZE

    : This type includes Authentication and Authorization in one transaction. After Authorization the payments, you can request Capture API for capturing the payments.

* Capture API is available after a separate contract.

mid string

Require

This is the unique merchant ID issued by Eximbay to identify merchant.

payment object

order_id string

Require

This is the unique order ID issued by Merchant to identify accepted or canceled transactions.

currency string

Require

The type of currency in currency codes.

amount string

Require

Total payment amount. , is not allowed, only numbers greater than zero can be sent.

lang string

Require

The type of language shown in the payment SDK. Refer to the Supported Languages.

payer_auth_id string

Require

Transaciton ID received when calling the SDK with transaction_type PAYER_AUTH

payment_url string

When a Japanese Convenience Store or Online Banking payment is used, this URL is sent to the customer upon their order registration.

other_param object

param1 string

Preliminary parameters that merchants can use if needed.

param2 string

Preliminary parameters that merchants can use if needed.

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",
        "payerauth_id" : "20220902101716",
        "lang" : "EN"
    }
}'
Response

rescode string

Require
Code of response.

resmsg string

Require
Description of resopose code.

fgkey string

Require
When you try to open SDK, you must put same FGKey. You can refer to Preparing FGKey.

payment object

order_id string

Require

This is the unique order ID issued by Merchant to identify accepted or canceled transactions.

currency string

Require

The type of currency in currency codes.

amount string

Require

Total payment amount. , is not allowed, only numbers greater than zero can be sent.

email string

Require

Email address of buyer. This email is necessary for sending payment confirmation email.

transaction_id string

Require

This is a unique ID issued by Eximbay to identify payment details.

auth_code string

Approval number.

* The approval number does not exist for alternative payment methods.

transaction_date string

Require
The date and time when the payment was approved. Send in the format YYYYMMDDHHMMSS.

access_country string

Country information where the customer made the payment.

payment_method string

The type of payment method. Refer to payment method codes.
This parameter is used when you want to call a specific payment method.

pay_to string

The name of the merchant to be billed for.

payment_url string

When a Japanese Convenience Store or Online Banking payment is used, this URL is sent to the customer upon their order registration.

status string

Payment processing status when the payment method is a virtual account or Japanese convenience store payment
  1. REGISTERED

    : Receipt. You must proceed with order completion only when Sale is received.

  2. Sale

    : It is sent only to status_url when the deposit is completed.

base_currency string

Transaction Currency.

* Usually same as currency paramter. When MCP(Local Currency) is used, either KRW or USD amount can be return.

* It can also be used for the capture data if the merchant is direct acquirer contracted.

base_amount string

Transaction Currency.

* Usually same as amount paramter. When MCP(Local Currency) is used, either KRW or USD amount can be return.

* It can also be used for the capture data if the merchant is direct acquirer contracted.

base_rate string

The exchange rate applied to the transaction amount.

* Exchange rate from currency to base_currency. If currency and base_currency are the same, it is 1.

dcc_rate string

DCC Exchange Rate.

* Exchange rate from base_currency to foreign_currency. If base_currency and foreign_currency are the same, it is 1.

terminal_id string

VAN terminal ID.

card_number string

Card number.

expiry_date string

Card expiration date.

store_number string

Acquirer merchant number.

foreign object

foreign_currency string

Customer’s billing currency.

* When using DCC, the currency unit chosen by the customer is returned.

foreign_amount string

Customer’s billing amount.

* When using DCC, the amount is returned in the currency of the customer's choice.

foreign_rate string

Exchange rate of billing currency to the customers.

Exchange rate from currency to foreign_currency. If currency and foreign_currency are the same, it is 1.

card_info object

card_holder string

Cardholder name.

card_number1 string

The first 4 digits of the card used for the transaction.

card_number4 string

The last 4 digits of the card used for the transaction.

cash_receipt object

use_flag string

You can check if a cash receipt is used.

*This parameter is required for payment of virtual account and Naver Pay point.

cash_receipt_type string

Type of cash receipt. You can select Income deduction or Documentary evidence of expenditure.

*This parameter is required for payment of virtual account and Naver Pay point.

customer_information_type string

Type of customer information number. You can put the Phone number Card number Resident Registration Number.

*This parameter is required for payment of virtual account and Naver Pay point.

customer_information string

Number for the selected customer information type when issuing the cash receipt.

*This parameter is required for payment of virtual account and Naver Pay point.

ship_to object

city string

Shipping city. (e.g . Hanoi, Brisbane, Houston)

country string

Shipping country. The type of country in ISO 3166 format.

first_name string

The first name of the recipient of the shipment.

last_name string

The last name of the recipient of the shipment.

phone_number string

The phone number of the recipient of the shipment.

postal_code string

The postal code of the shipping address.

state string

State or province of the shipping address. Required only when the shipping country is US or CA. (e.g. MA, NY, CA)
Refer to State, Province and Territory Codes for the United States and Canada.

street1 string

The street of the shipping address. (e.g. 123 Main street, 56 Le Loi street)

dm object

decision string

The status of the DM Process. You can check the status code below.
ACCEPT

: Transaction approval after DM Process risk review

REJECT

: Transaction failure after DM Process risk review

REVIEW

: DM Process can be approved after risk review, but risk transaction needs to be checked

ERROR

: Failure of DM Process

reject string

REJECT Rule Code. Rule codes are separated by I, and information about rule codes is provided separately.

review string

REVIEW Rule Code. Rule codes are separated by I, and information about rule codes is provided separately.

other_param object

param1 string

Preliminary parameters that merchants can use if needed.

param2 string

Preliminary parameters that merchants can use if needed.
Response 
                                                    
    {
        "rescode": "ND62",
        "resmsg": "Decline",
        "mid": "1849705C64",
        "payment": {
            "order_id": "20220902101716",
            "currency": "USD",
            "amount": "1",
            "transaction_date": "20220921132642",
            "access_country": "KR"
        }
    }

Verify a Payment

POST/v1/payments/verify

You must check whether the payment has been forged through FGKey validation included in the SDK response.
Verify the payment with payment verification API.

The parameters returned by the Eximbay server are sent in the form of a query string.
Please send the parameters that were answered by the query string to the payment verification API request parameters. Once the validation is completed with the payment verification API, the payment will be completed. More information can be found in Preparing FGKey.

Note. 1 - The response parmeters received by Eximbay server depends on the transaction_type that you selected and the reqeust parameter you send.
Note. 2 - Depending on local or global payment, the response parameters received after load the SDK can be different.

Request

version string

Require
Version of Eximbay payment SDK.

mid string

Require
This is the unique merchant ID issued by Eximbay to identify merchants.

transaction_type string

Require
The payment SDK type selected when opening the Eximbay JS SDK. Depending on the selected payment type, the response parameters received from the Eximbay server are different.

fgkey string

Require
The fgkey you used to open the payment SDK.

order_id string

Require
This is the unique order ID issued by Merchant to identify accept of canceled transactions.

currency string

Require
The type of currency in currency codes.

amount string

Require
Total payment amount.

email string

Require
Email address of buyer. This email is necessary for sending payment confirmation email.

param1 string

Preliminary parameters that merchants can use if needed.

param2 string

Preliminary parameters that merchants can use if needed.

param3 string

Preliminary parameters that merchants can use if needed.

rescode string

Require
Code of response.

resmsg string

Require
Description of response code.

transaction_id string

This is a unique ID issued by Eximbay to identify payment details.

auth_code string

Approval number.

* The authorization number does not exist for transactions settled by alternative payment methods.

payer_auth_id string

Transaciton ID received when calling the SDK with transaction_type PAYER_AUTH.

transaction_date string

The date and time when the payment was approved. Send in the format YYYYMMDDHHMMSS.

access_country string

Country information where the customer made the payment.

payment_method string

The type of payment method. Refer to payment method codes. This parameter is used when you want to call a specific payment method.

payment_type string

This parmaeter is set in the merchant when local alternative payement method is selected as the payment method.

pay_to string

The name of the merchant to be billed for.

card_holder string

Cardholder name.

card_number1 string

The first 4 digits of the card used for the transaction.

card_number4 string

The last 4 digits of the card used for the transaction.

installment_months string

Installment month.

*Only for local payments.

status string

Status of transaction.
SALE

: Payment Completed (confirmed)

AUTH

: Authorization (Payment unconfirmed, confirmed after Capture a payment)

REGISTERED

: Order registration (Payment unconfirmed, confirmed after Deposit Notification)

NONE

: No transaction

city string

The name of the shipping city.

country string

The type of country in ISO 3166 format.

first_name string

The first name of the recipient of the shipment.

last_name string

The last name of the recipient of the shipment.

phone_number string

The phone number of the recipient of the shipment.

postal_code string

The postal code of the shipping address.

state string

State or province of the shipping address. Required only when the shipping country is US or CA. (e.g. MA, NY, CA)
Refer to .

street1 string

The street of the shipping address. (e.g. 123 Main street, 56 Le Loi street)

use_flag string

You can check if a cash receipt is used.

*This parameter is required for payment of virtual account and Naver Pay point.

cash_receipt_type string

Type of cash receipt. You can select Income deduction or Documentary evidence of expenditure.

*This parameter is required for payment of virtual account and Naver Pay point.

customer_information_type string

Type of customer information number. You can put the Phone number Card number Resident Registration Number.

*This parameter is required for payment of virtual account and Naver Pay point.

customer_information string

Number for the selected customer information type when issuing the cash receipt.

*This parameter is required for payment of virtual account and Naver Pay point.

account_number string

Virtual account number. This parameter is required when purchasing with a virtual account.

bank_name string

Bank name of virtual account

depositor string

Name of the depositor

due_date string

Due date f or the deposit.

Note. 1 - Virtual account parameters are required when purchasing with virtual account or Japanese Convenience Sotre payment.
Note. 2 - Results are sent in the following two steps.
• Order Registration: return_url, status_url   • Notification of deposit: status_url
Note. 3 - You can choose whether to receive the result of order registration with statusurl.

payment_url string

When a Japanese Convenience Store or Online Banking payment is used, this URL is sent to the customer upon their order registration.

decision string

The status of the DM Process. You can check the status code below.
ACCEPT

: Transaction approval after DM Process risk review

REJECT

:Transaction failure after DM Process risk review

REVIEW

: DM Process can be approved after risk review, but risk transaction needs to be checked

ERROR

: Failure of DM Process

reject string

REJECT Rule Code. Rule codes are separated by | and information about rule codes is provided separately.

review string

REVIEW Rule Code. Rule codes are separated by | and information about rule codes is provided separately.

base_currency string

Transaction currency.

* Usually same as currency parameter. When MCP(Local Currency) is used, either KRW or USD amount can be return.

* It can also be used for the capture data if the merchant is direct acquirer contracted.

* Required when you integrate global payments.

base_amount string

Transaction amount.

* Usually same as currency parameter. When MCP(Local Currency) is used, either KRW or USD amount can be return.

* It can also be used for the capture data if the merchant is direct acquirer contracted.

* Required when you integrate global payments.

base_rate string

The exchange rate applied to the transaction amount.

* Exchange rate from currency to base_currency. If currency and base_currency are the same, it is 1.

* It can also be used for the capture data if the merchant is direct acquirer contracted.

* Required when you integrate global payments.

foreign_currency string

Customer’s billing currency.

* When using DCC, the currency unit chosen by the customer is returned.

* Required when you integrate global payments.

foreign_amount string

Customer’s billing amount.

* When using DCC, the amount is returned in the currency of the customer's choice.

* Required when you integrate global payments.

foreign_rate string

Exchange rate of billing currency to the customers.

* Exchange rate from currency to foreign_currency. If currency and foreign_currency are the same, it is 1.

* Required when you integrate global payments.

dcc_rate string

DCC Exchange Rate.

* Exchange rate from base_currency to foreign_currency. If both are the same, it is 1.

* Required when you integrate global payments.

terminal_id string

VAN terminal ID.

card_number string

Card number.

expiry_date string

Card expiration date.

store_number string

Acquirer merchant number.

cavv string

cavv information about the authentication result.

xid string

xid information about the authentication result.

eci string

eci information about the authentication result.
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

rescode string

Require
Code of response

resmsg string

Require
Description of response code.
Response 
                                                    
    {
        "rescode": "0000",
        "resmsg": "Success",
    }

Retrieve a Payment

POST/v1/payments/retrieve

You can view accepted or canceled payments with Payment Retrieve API.
Request

mid string

Require
This is the unique merchant ID issued by Eximbay to identify merchants.

key_field string

Require
To select a payment retrieve type. If parameter is sent by empty, transaction_id is sent to the default.
order_id

: To retrieve the last transaction that was approved or refunded.

transaction_id

: Retrieve a specified transaction. (default)

payment object

order_id string

Require
This is the unique order ID issued by Merchant to identify accept of canceled transactions.

currency string

Require
The type of currency in currency codes.

amount string

Require
Total payment amount. , is not allowed, only numbers greater than zero can be sent.

lang string

Require
The type of language shown in the payment SDK. Refer to the Supported Languages.

transaction_id string

This is a unique ID issued by Eximbay to identify payment details.

other_param object

param1 string

Preliminary parameters that merchants can use if needed.

param2 string

Preliminary parameters that merchants can use if needed.

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

rescode string

Require
Code of response

resmsg string

Require
Description of response code.

mid string

Require
This is the unique merchant ID issued by Eximbay to identify merchants.

payment object

status string

Require
The status of the retrieved payment. You can check the status code below.
SALE

Payment Completed (Payment confirmed)

AUTH

: Authorization (Payment unconfirmed, confirmed after Capture a payment)

REGISTERED

: Order registration (Payment unconfirmed, confirmed after Deposit Notification)

NONE

: No transaction

order_id string

Require
This is the unique order ID issued by Merchant to identify accepted or canceled transactions.

currency string

Require
The type of currency in currency codes.

amount string

Require
Total payment amount. , is not allowed, only numbers greater than zero can be sent.

transaction_id string

Require
This is a unique ID issued by Eximbay to identify payment details.

auth_code string

Approval Number.

* The authorization number does not exist for transactions settled by alternative payment methods.

transaction_date string

Require
The date and time of approved date of the retrieved transaction. Send in the format YYYYMMDDHHMMSS

balance string

Cancelable amount. (Approval amount - Refund amount)

payment_method string

The type of payment method. Refer to payment method codes.
This parameter is used when you want to call a specific payment method.

card_info object

card_number1 string

The first 4 digits of the card used for the transaction.

card_number4 string

The last 4 digits of the card used for the transaction.

other_param object

param1 string

Preliminary parameters that merchants can use if needed.

param2 string

Preliminary parameters that merchants can use if needed.

Response 
                                                    
    {
        "rescode": "0000",
        "resmsg": "Success.",
        "mid": "1849705C64",
        "payment": {
            "ref": "20220902101716",
            "cur": "USD",
            "amt": "1",
            "transid": "1849705C6420220902000010",
            "status": "AUTH",
            "authcode": "485760",
            "resdt": "20220902101749",
            "balance": "1.00"
        },
        "card_info": {
            "cardno1": "4111",
            "cardno4": "1111"
        }
    }

Refund a Payment

POST/v1/payments/{transaction_id}/cancel

Cancel an approved payment with transaction_id. Request the API by adding the transaction_id to the path parameter.
Request

mid string

Require

This is the unique merchant ID issued by Eximbay to identify merchants.

refund object

refund_type string

Require
Type of refund. One of F or P.
F

: Fully

P

: Partial

refund_amount string

Require

Amount of refund. You cannot request more than the original transaction.
If this parameter is empty when the refund_type is F, the total amount of the original transaction will be canceled.

refund_id string

Require

A unique identifier for a refund issued by Merchant.

reason string

Require

Reason for refunding the transaction.

payment object

order_id string

Require

This is the unique order ID of the transaction you want to refund.

currency string

Require

The type of currency in currency codes.

amount string

Require

Total payment amount. , is not allowed, only numbers greater than zero can be sent.

lang string

Require

The type of language shown in the payment SDK. Refer to the Supported Languages.

transaction_id string

Require

A unique identifier for a transaction that issued by Eximbay.

balance string

Require

Cancelable amount. (Approval amount - Refund amount)

other_param object

param1 string

Preliminary parameters that merchants can use if needed.

param2 string

Preliminary parameters that merchants can use if needed.

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" : "단순변심"
    },
    "payment" : {
        "order_id" : "20220829170258",
        "currency" : "USD",
        "amount" : "1",
        "balance" : "1",
        "lang" : "EN"
    }
}'
Response

rescode string

Require

Code of response

resmsg string

Require

Description of response code.

mid string

Require

This is the unique merchant ID issued by Eximbay to identify merchants.

refund object

refund_amount string

Require

Amount of refund. You cannot request more than the original transaction.
If this parameter is empty when the refund_type is F, the total amount of the original transaction will be canceled.

refund_id string

Require

A unique identifier for a refund issued by Merchant.

refund_date string

Require

The date and time the payment was canceled. Send in the fromat as YYYYMMDDHHMMSS.

refund_transaction_id string

Require

A unique identifier for a canceled transaction issued by Eximbay.

payment object

order_id string

Require

This is the unique order ID of the transaction you want to refund.

currency string

Require

The type of currency in currency codes.

amount string

Require

Total payment amount. , is not allowed, only numbers greater than zero can be sent.

balance string

Require

Cancelable amount. (Approval amount - Refund amount)

auth_code string

Approval number.

* The authorization number does not exist for transactions settled by alternative payment methods.

base_amount string

Transaction Amount.

* Usually same as amount parameter. When MCP(Local Currency) is used, either KRW or USD amount can be return.

* It can also be used for the capture data if the merchant is direct acquirer contracted.

base_rate string

The exchange rate applied to the transaction amount.

* Exchange rate from currency to base_currency. If currency and base_currency are the same, it is 1

dcc_rate string

DCC Exchange Rate.

* Exchange rate from base_currency to foreign_currency. If base_currency and foreign_currency are the same, it is 1

foreign object

foreign_currency string

Customer’s billing currency.

* When using DCC, the currency unit chosen by the customer is returned.

foreign_amount string

Customer’s billing amount.

* When using DCC, the amount is returned in the currency of the customer's choice.

foreign_rate string

Exchange rate of billing currency to the customers.

* Exchange rate from currency to foreign_currency. If currency and foreign_currency are the same, it is 1

other_param object

param1 string

Preliminary parameters that merchants can use if needed.

param2 string

Preliminary parameters that merchants can use if needed.

Response 
                                                    
    {
        "rescode": "0000",
        "resmsg": "Success.",
        "mid": "1849705C64",
        "refund": {
            "refundamt": "1.00",
            "refundid": "1849705C64",
            "refundAt": "20220922113927",
            "refundtransid": "1849705C6420220922000014"
        },
        "payment": {
            "ref": "20220922113330",
            "cur": "USD",
            "amt": "1.00",
            "transid": "1849705C6420220922000013",
            "balance": "0.00",
            "baseamt": "1.00",
            "baserate": "1.000000",
            "dccrate": "1.000000",
    				"paymethod" : "P101"
        },
        "foreign": {
            "foregincur": "USD",
            "foreginamt": "1.00",
            "foreginrate": "0"
        }
    }

Capture a Payment

POST/v1/payments/{transaction_id}/capture

Capture the accepted payment with transaction_id. Request the API by adding the transaction_id to the pathe parameter.
Request

mid string

Require
This is the unique merchant ID issued by Eximbay to identify merchants.

payment object

order_id string

Require
This is the unique order ID issued by Merchant to identify accepted or canceled transactions.

currency string

Require
The type of currency in currency codes.

amount string

Require
Total payment amount. , is not allowed, only numbers greater than zero can be sent.

lang string

Require
The type of language shown in the payment SDK. Refer to the Supported Languages.

other_param object

param1 string

Preliminary parameters that merchants can use if needed.

param2 string

Preliminary parameters that merchants can use if needed.

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

rescode string

Require
Code of response

resmsg string

Require
Description of response code.

mid string

Require
This is the unique merchant ID issued by Eximbay to identify merchants.

payment object

order_id string

Require
This is the unique order ID issued by Merchant to identify accepted or canceled transactions.

transaction_id string

Require
This is a unique ID issued by Eximbay to identify payment details.

currency string

Require
The type of currency in currency codes.

amount string

Require
Total payment amount. , is not allowed, only numbers greater than zero can be sent.

lang string

Require
The type of language shown in the payment SDK. Refer to the Supported Languages.

transaction_id string

Require
This is a unique ID issued by Eximbay to identify payment details.

captured_date string

Require
Response date and time after capturing the transaction. Send in the fromat as YYYYMMDDHHMMSS

partially_cancelable string

Whether partial cancellation is possible. One of Y or N. If parameter is sent by empty, N is sent to the default.
Y

: Partial cancellation is possible.

N

: Partial cancellation is not possible.

other_param object

param1 string

Preliminary parameters that merchants can use if needed.

param2 string

Preliminary parameters that merchants can use if needed.

Response 
                                                    
    {
        "rescode": "0000",
        "resmsg": "Success.",
        "mid": "1849705C64",
        "payment": {
            "order_id": "20220922114007",
            "currency": "USD",
            "amount": "1",
            "transaction_id": "1849705C6420220922000016",
            "captured_date": "20220922114212",
            "allowed_pvoid": "Y"
        }
    }