Code has been copied.

Payout service

Eximbay's payout service includes APIs for sub-merchant management (such as registration, modification, and deletion) as well as payout-related functions (including requests, refunds, and inquiries).
Before using the payout service, token registration is required. Please refer to the payout preparation guidelines for token registration. 
  
  curl --location 'https://internal-api.eximbay.com/submall/api/submall/register' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: ••••••' \

Once the API integration is completed as per this document, update the service URL-related parameters to activate the service

Request URL

Remittance is available in the production environment.
The test amounts for remittance are KRW 100,000, USD 100, and JPY 10,000

Category URL
Production https://pgonline.eximbay.com
Test https://pgonline-test.eximbay.com
Response parameter

rescode string

Response code

resmsg string

Description of Response Codes

type string

API classification code
payout

: Types of APIs for payout requests

submall

: Types of APIs for Sub_merchant request

data

Data type
String
Object(Nullable)
List

Data field-related items are included in 'RESPONSE_BODY.

Response 
  
  {
      "rescode" : "RESPONSE_CODE",
      "resmsg" : "MESSAGE",
      "type" : "RESPONSE_BODY_DATA_TYPE",
      "data" : "RESPONSE_BODY"
  }

Sub_merchant information management

Sub_merchant registration

POST/submall/api/submall/register

Register the sub-merchant for the payout request. The verification process will be conducted based on the information provided during the sub-merchant's registration.

•  Each request can only register a single sub-merchant.
•  Sub-merchant registration cannot be processed under the following circumstances: beneficiary account inquiry failure, parameter validation failure, or duplicate currency registration request.
•  Registration of multi-currency information for banks other than Hanabank is limited to the bank's operating hours, from 9 AM to 4 PM.

Request parameter

biz_type string

Mandatory
Sub_merchant's business type. Maximum length is 100 characters.
CORPORATE_BUSINESS

: corporate business

INDIVIDUAL_BUSINESS

: individual businee

submall_name string

Mandatory
Sub_merchant's business name. Maximum length is 100 characters.

business_number string

Mandatory
Sub_merchant's business registration number. Maximum length is 30 characters.

representative_name string

Mandatory
Sub_merchant's representative's name. Maximum length is 60 characters.

representative_email string

Mandatory
Sub_merchant's representative's email.

manager_name string

Mandatory
The name of the sub-merchant's operational personnel. The maximum length is 60 characters

manager_email string

Mandatory
The email of the sub-merchant's operational personnel. The maximum length is 100 characters

manager_phone string

Mandatory
The phone number of the sub-merchant's operational personnel.

submall_bank_account list* Sub_merchant's account information for remittance

bank_account_name string

Mandatory
Bank account nickname. A maximum of three accounts can be distinguished using nicknames.

bank_code string

Mandatory
Bank code. Please refer to the three digit bank code.

currency string

Mandatory
Remittance currency. KRW/JPY/USD are available for remittance.

bank_account_number string

Mandatory
Please enter the bank account number without '-'. Maximum length is 20 characters.
The bank account registered for JPY and USD can be the same.

depositor string

Mandatory
Beneficiary's name. Maximum length is 60 characters.
Request 
    
    {
        "biz_type": "INDIVIDUAL_BUSINESS",
        "submall_name": "test-submall",
        "business_number": "0000000000",
        "representative_name": "representative name",
        "representative_email": "representative@eximbay.com",
        "manager_name": "manager name",
        "manager_email": "manager@eximbay.com",
        "manager_phone": "01012345678",
        "submall_bank_account": [
            {
                "bank_account_name": "bank_account_name",
                "currency": "KRW",
                "bank_code": "000",
                "depositor": "depositor",
                "bank_account_number": "000000000000000"
            },
            {
                "bank_account_name": "bank_account_name",
                "currency": "USD",
                "bank_code": "000",
                "depositor": "depositor",
                "bank_account_number": "000000000000000"
            }
        ]
    }
Response parameter

submall_id string

This is a unique ID used to classify a registered sub_merchant.

registered_date datetime

Sub_merchant's registration date. (yyyy-MM-dd hh:mm:ss)

submall_status string

Sub_merchant's service status. Please refer to the service status code.

submall_review_status string

Sub_merchant's verification status. Please refer to the service status code.

submall_review_modified_date datetime

Date of verification status update

submall object* Sub_merchant's information

submall_name string

Sub_merchant's business name. Maximum length is 100 characters.

biz_type string

Sub_merchant's business type. Maximum length is 100 characters.
CORPORATE_BUSINESS

: Corporate business

INDIVIDUAL_BUSINESS

: Individual business

business_number string

Sub_merchant's business registration number. Maximum length is 30 characters.

representative object* Sub_merchant's representative's information

representative_name string

Sub_merchant's representative's name. Maximum length is 60 characters.

representative_email string

Sub_merchant's representative's email.

manager object* The information of the sub-merchant's operational personnel.

manager_name string

The name of the sub-merchant's operational personnel.

manager_email string

The email of the sub-merchant's operational personnel. The maximum length is 100 characters

manager_phone string

The phone number of the sub-merchant's operational personnel.

submall_bank_account list* Sub_merchant's account information for remittance

bank_account_name string

Bank account nickname. A maximum of three accounts can be distinguished using nicknames.

bank_account_id string

계좌 ID입니다.

bank_code string

Bank code. Please refer to the three digit bank code.

currency string

Remittance currency. KRW/JPY/USD are available for remittance.

bank_account_number string

Please enter the bank account number without '-'. Maximum length is 20 characters.
The bank account registered for JPY and USD can be the same.

depositor string

Beneficiary's name. Maximum length is 60 characters.
Response 

{
    "rescode": "SUCCESS",
    "resmsg": "SUCCESS",
    "type": "submall",
    "data": {
        "submall_id": "bcdc12c1-7c72-4cc4-b12f-aa5a0774170f",
        "registered_date": "2024-12-16",
        "submall_status": "OK",
        "submall_review_status": "SUBMALL_REVIEW_READY",
        "submall_review_modified_date": "2024-12-16",
        "submall": {
                "submall_name": "test-submall",
                "biz_type": "INDIVIDUAL_BUSINESS",
                "business_number": "0000000000"
            },
        "representative": {
                "representative_name": "representative name",
                "representative_email": "representative@eximbay.com"
            },
        "manager": {
                "manager_name": "manager name",
                "manager_email": "manager@eximbay.com",
                "manager_phone": "01012345678"
            },
        "submall_bank_account": [
            {
                "bank_account_name": "bank_account_name",
                "bank_account_id": "00000000-0000-0000-0000-000000000000",
                "bank_code": "000",
                "bank_account_number": "000000000000000",
                "currency": "KRW",
                "depositor": "depositor"
            },
            {
                "bank_account_name": "bank_account_name",
                "bank_account_id": "00000000-0000-0000-0000-000000000000",
                "bank_code": "000",
                "bank_account_number": "000000000000000",
                "currency": "USD",
                "depositor": "depositor"
            }
        ]
    }
}

Sub_merchant's list inquiry

GET/submall/api/submall/list

Inquiry regarding multiple sub-merchant registered with Eximbay.
Request parameter

page int

Retrieve the list of sub-merchants on a page Default value is 0.

size int

Number of sub-merchants per page for inquiry. Default value is 20.
Request 

curl --location 'https://internal-api.eximbay.com/submall/api/submall/list?page=0&size=2' \
--header 'Authorization: ••••••'
Response parameter

list list(DataList)* Sub_merchant's list information

submall_id string

This is a unique ID used to classify a registered sub_merchant.

registered_date datetime

Sub_merchant's registration date. (yyyy-MM-dd hh:mm:ss)

submall_status string

Sub_merchant's service status. Please refer to the service status code.

submall_review_status string

Sub_merchant's verification status. Please refer to the service status code.

submall_review_modified_date datetime

Date of verification status update

submall object* Sub_merchant's information

submall_name string

Sub_merchant's business name. Maximum length is 100 characters.

biz_type string

Sub_merchant's business type. Maximum length is 100 characters.
CORPORATE_BUSINESS

: Corporate business

INDIVIDUAL_BUSINESS

: Individual business

business_number string

Sub_merchant's business registration number. Maximum length is 30 characters.

representative object* Sub_merchant's representative's information

representative_name string

Sub_merchant's representative's name. Maximum length is 60 characters.

representative_email string

Sub_merchant's representative's email.

manager object* The information of the sub-merchant's operational personnel.

manager_name string

The name of the sub-merchant's operational personnel.

manager_email string

The email of the sub-merchant's operational personnel. The maximum length is 100 characters

manager_phone string

The phone number of the sub-merchant's operational personnel.

submall_bank_account list*Sub_merchant's account information for remittance

bank_account_name string

Bank account nickname. A maximum of three accounts can be distinguished using nicknames.

bank_account_id string

계좌 ID입니다.

bank_code string

Bank code. Please refer to the three digit bank code.

currency string

Remittance currency. KRW/JPY/USD are available for remittance.

bank_account_number string

Please enter the bank account number without '-'. Maximum length is 20 characters.
The bank account registered for JPY and USD can be the same.

depositor string

Beneficiary's name. Maximum length is 60 characters.

page int

Retrieve the list of sub-merchants on a page Default value is 0.

size int

Number of sub-merchants per page for inquiry. Default value is 20.

total_count int

Total number of sub_merchants
Response 

{
    "rescode": "SUCCESS",
    "resmsg": "SUCCESS",
    "type": "submall",
    "data": {
        "list": [
            {
                "submall_id": "00000000-0000-0000-0000-000000000000",
                "registered_date": "2024-12-17",
                "submall_status": "OK",
                "submall_review_status": "SUBMALL_REVIEW_COMPLETE",
                "submall_review_modified_date": "2024-12-17",
                "submall": {
                    "submall_name": "test-submall",
                    "biz_type": "INDIVIDUAL_BUSINESS",
                    "business_number": "0000000000"
                },
                "representative": {
                        "representative_name": "representative name",
                        "representative_email": "representative@eximbay.com"
                },
                "manager": {
                        "manager_name": "manager name",
                        "manager_email": "manager@eximbay.com",
                        "manager_phone": "01012345678"
                },
                "submall_bank_account": [
                    {
                        "bank_account_name": "bank_account_name",
                        "bank_account_id": "00000000-0000-0000-0000-000000000000",
                        "bank_code": "000",
                        "bank_account_number": "000000000000000",
                        "currency": "KRW",
                        "depositor": "depositor"
                    }
                ]
            }
        ],
        "page": 0,
        "size": 100,
        "total_count": 1
    }
}

Sub_merchant information update

POST/submall/api/submall/update/submallId

Update the information of sub-merchants registered with Eximbay.

•  The existing values in the field can be updated. Additional fields and all fields.
•  Updates are not permitted under the following circumstances: beneficiary account inquiry failure, parameter validation failure, or duplicate currency entries.
•  A reassessment will be required for modifications to the sub-merchant's name, business type, business registration number, and representative's name.
•  Sub_merchant's account can not be modified during the payout process .
•  Registration of multi-currency information for banks other than Hanabank is limited to the bank's operating hours, from 9 AM to 4 PM.

Request parameter

biz_type string

Sub_merchant's business type. Maximum length is 100 characters.
CORPORATE_BUSINESS

: Corporate business

INDIVIDUAL_BUSINESS

: Individual business

submall_name string

Sub_merchant's business name. Maximum length is 100 characters.

business_number string

Sub_merchant's business registration number. Maximum length is 30 characters.

representative_name string

Sub_merchant's representative's name. Maximum length is 60 characters.

representative_email string

Sub_merchant's representative's email.

manager_name string

The name of the sub-merchant's operational personnel. The maximum length is 60 characters

manager_email string

The email of the sub-merchant's operational personnel. The maximum length is 100 characters

manager_phone string

The phone number of the sub-merchant's operational personnel.

submall_bank_account list* Sub_merchant's account information for remittance

bank_account_name string

Mandatory
Bank account nickname. A maximum of three accounts can be distinguished using nicknames.

bank_account_id string

Mandatory
계좌 ID입니다.

bank_code string

Mandatory
Bank code. Please refer to the three digit bank code.

currency string

Mandatory
Remittance currency. KRW/JPY/USD are available for remittance.

bank_account_number string

Mandatory
Please enter the bank account number without '-'. Maximum length is 20 characters.
The bank account registered for JPY and USD can be the same.

depositor string

Mandatory
Beneficiary's name. Maximum length is 60 characters.
Request 

curl --location 'https://pgonline-test.eximbay.com/submall/api/submall/update/00000000-0000-0000-0000-000000000000' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
    "submall_name": "test-submall",
    "submall_bank_account": [
        {
            "bank_account_name": "bank_account_name",
            "currency": "KRW",
            "bank_code": "000",
            "bank_account_number": "000000000000000",
            "depositor": "depositor"
        },
        {
            "bank_account_name": "bank_account_name",
            "currency": "JPY",
            "bank_code": "000",
            "bank_account_number": "000000000000000",
            "depositor": "depositor"
        }
    ]
}'
Response parameter

submall_id string

This is a unique ID used to classify a registered sub_merchant.

registered_date datetime

Sub_merchant's registration date. (yyyy-MM-dd hh:mm:ss)

submall_status string

Sub_merchant's service status. Please refer to the service status code.

submall_review_status string

Sub_merchant's verification status. Please refer to the service status code.

submall_review_modified_date datetime

Date of verification status update

submall object* Sub_merchant's information

submall_name string

Sub_merchant's business name. Maximum length is 100 characters.

biz_type string

Sub_merchant's business type. Maximum length is 100 characters.
CORPORATE_BUSINESS

: Corporate business

INDIVIDUAL_BUSINESS

: Individual business

business_number string

Sub_merchant's business registration number. Maximum length is 30 characters.

representative object* Sub_merchant's representative's information

representative_name string

Sub_merchant's representative's name. Maximum length is 60 characters.

representative_email string

Sub_merchant's representative's email.

manager object* The information of the sub-merchant's operational personnel.

manager_name string

The name of the sub-merchant's operational personnel.

manager_email string

The email of the sub-merchant's operational personnel. The maximum length is 100 characters

manager_phone string

The phone number of the sub-merchant's operational personnel.

submall_bank_account list* Sub_merchant's account information for remittance

bank_account_name string

Bank account nickname. A maximum of three accounts can be distinguished using nicknames.

bank_account_id string

계좌 ID입니다.

bank_code string

Bank code. Please refer to the three digit bank code.

currency string

Remittance currency. KRW/JPY/USD are available for remittance.

bank_account_number string

Please enter the bank account number without '-'. Maximum length is 20 characters.
The bank account registered for JPY and USD can be the same.

depositor string

Beneficiary's name. Maximum length is 60 characters.
Response 

{
    "rescode": "SUCCESS",
    "resmsg": "SUCCESS",
    "type": "submall",
    "data": {
        "submall_id": "00000000-0000-0000-0000-000000000000",
        "registered_date": "2024-12-16",
        "submall_status": "OK",
        "submall_review_status": "SUBMALL_MODIFY_COMPLETE",
        "submall_review_modified_date": "2024-12-17",
        "submall": {
            "submall_name": "test-submall",
            "biz_type": "INDIVIDUAL_BUSINESS",
            "business_number": "0000000000"
        },
        "representative": {
            "representative_name": "representative name",
            "representative_email": "representative@eximbay.com"
        },
        "manager": {
            "manager_name": "manager name",
            "manager_email": "manager@eximbay.com",
            "manager_phone": "01012345678"
        },
        "submall_bank_account": [
            {
                "bank_account_name": "bank_account_name",
                "bank_account_id": "00000000-0000-0000-0000-000000000000",
                "bank_code": "000",
                "bank_account_number": "000000000000000",
                "currency": "KRW",
                "depositor": "depositor"
            }
        ]
    }
}

Sub_merchant's deletion

POST/submall/api/submall/delete/submallId

Delete the sub-merchants registered with Eximbay. Once deleted, sub-merchants cannot be retrieved.
To re-register a deleted sub-merchant, the sub-merchant registration API must be used to initiate the registration process again.
Request parameter
Request 

curl --location --request POST 'https://internal-api.eximbay.com/submall/api/submall/delete/eeed22ee-01e5-4681-b8a9-7640d429e4b6' \
--header 'Authorization: ••••••'
Response parameter
Response 

{
    "rescode": "SUCCESS",
    "resmsg": "SUCCESS",
    "type": "submall",
    "data": null
}

Remittance request management

Remittance request

POST/submall/api/remit/register

Settle the funds to the registered sub_merchant.

•  The request will be declined if there is a parameter validation failure or if the remittance request amount exceeds the pending remittance amount.
•  Registration is only available for sub-merchants whose verification is complete, and for those whose bank account linked to the remittance currency is registered in the sub-merchant's information.
•  Registration of multi-currency information for banks other than Hanabank is limited to the bank's operating hours, from 9 AM to 4 PM.
•  Remittance requests cannot be set for today or past dates. The minimum remittance amount, which cannot be remitted to banks other than Hana Bank, is 4,000 KRW or 400 JPY.
•  Once the funds are settled to the sub-merchants through the payout service, they cannot be retrieved. The merchant is solely responsible for carefully reviewing the payout request information before Eximbay settles the funds.

Request parameter

submall_id string

Mandatory
The ID for the sub-merchants has been settled. The maximum length is 255 characters.

payout_date string

Mandatory
Remittance date for the sub-merchant(YYYY-MM-DD) maximum length is 10 characters.

payout_amount string

Mandatory
The amount requested for remittance maximum length is 255 characters.

payout_currency string

Mandatory
The currency requested for remittance maximum length is 100 characters.

message string

Mandatory
The Object showed in remittance history. Maximum length is 255 characters.
Request 

curl --location 'https://URL/submall/api/remit/register' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: ••••••' \
    --data '{
        "submall_id": "00000000-0000-0000-0000-000000000000",
        "payout_date": "2025-12-30",
        "payout_amount": "1000.00",
        "payout_currency": "KRW",
        "message": "test message"
    }'
Response parameter

submall object* Sub_merchant's information

submall_id string

The ID for the sub-merchants has been settled. The maximum length is 255 characters.

biz_type string

Sub_merchant's business type. Maximum length is 100 characters.
CORPORATE_BUSINESS

: Corporate business

INDIVIDUAL_BUSINESS

: Individual business

submall_name string

Sub_merchant's business name. Maximum length is 100 characters.

business_number string

Sub_merchant's business registration number. Maximum length is 30 characters.

payout object* Payout request object information

payout_id string

This is a unique ID used to classify payout request.

payout_date string

Remittance date for the sub-merchant(YYYY-MM-DD) maximum length is 10 characters.

payout_amount string

The amount requested for remittance.

currency string

Remittance currency. KRW/JPY/USD are available for remittance.

bank_account_number string

Please enter the bank account number without '-'. Maximum length is 20 characters.
The bank account registered for JPY and USD can be the same.

message string

The Object showed in remittance history. Maximum length is 255 characters.

request_date string

The date the merchant requested the payout.

status string

Please check the status of the payout request.
Response 

{
    "rescode": "SUCCESS",
    "resmsg": "SUCCESS",
    "type": "payout",
    "data": {
        "submall": {
            "submall_id": "00000000-0000-0000-0000-000000000000",
            "biz_type": "INDIVIDUAL_BUSINESS",
            "submall_name": "test-submall",
            "business_number": "0000000000"
        },
        "payout": {
            "payout_id": "00000000-0000-0000-0000-000000000000",
            "payout_date": "2025-12-30",
            "payout_amount": "1000.00",
            "currency": "KRW",
            "bank_account_number": "000000000000000",
            "message": "test message",
            "request_date": "2024-12-17 00:00:00",
            "status": "REQUEST"
        }
    }
}

Payout request list

GET/submall/api/remit/get/payoutId

Inquiry for the payout request list. Only available parameters can be specified; if none are designated, a full inquiry will be initiated. Null values are allowed.
Request parameter

payout_date date

Remittance date for the sub-merchant(YYYY-MM-DD) maximum length is 10 characters.

page int

Retrieve the list of sub-merchants on a page Default value is 0.

size int

Number of sub-merchants per page for inquiry. Default value is 20.
Request 

curl --location 'https:///submall/api/remit/list?page=0&size=100&payoutDate=2024-12-12' \
--header 'Authorization: ••••••'
Response parameter

list list(DataList)* Sub_merchant's list information

submall object* Sub_merchant's information

submall_id string

The ID for the sub-merchants has been settled. The maximum length is 255 characters.

biz_type string

Sub_merchant's business type. Maximum length is 100 characters.
CORPORATE_BUSINESS

: Corporate business

INDIVIDUAL_BUSINESS

: Individual business

submall_name string

Sub_merchant's business name. Maximum length is 100 characters.

business_number string

Sub_merchant's business registration number. Maximum length is 30 characters.

payout object* Payout request object information

payout_id string

This is a unique ID used to classify payout request.

payout_date string

Remittance date for the sub-merchant(YYYY-MM-DD) maximum length is 10 characters.

payout_amount string

The amount requested for remittance.

currency string

Remittance currency. KRW/JPY/USD are available for remittance.

bank_account_number string

Please enter the bank account number without '-'. Maximum length is 20 characters.
The bank account registered for JPY and USD can be the same.

message string

The Object showed in remittance history. Maximum length is 255 characters.

request_date string

The date the merchant requested the payout.

status string

Please check the status of the payout request.

cancel_reason string

The reason for the remittance request cancellation. If not canceled, a null string will be displayed.

page int

Retrieve the list of sub-merchants on a page Default value is 0.

size int

Number of sub-merchants per page for inquiry. Default value is 20.

total_count int

Total number of sub_merchants
Response 

{
    "rescode": "SUCCESS",
    "resmsg": "SUCCESS",
    "type": "payout",
    "data": {
        "list": [
            {
                "submall": {
                    "submall_id": "00000000-0000-0000-0000-000000000000",
                    "biz_type": "INDIVIDUAL_BUSINESS",
                    "submall_name": "test-submall",
                    "business_number": "0000000000"
                },
                "payout": {
                    "payout_id": "00000000-0000-0000-0000-000000000000",
                    "payout_date": "2024-12-30",
                    "payout_amount": "1000.00",
                    "currency": "KRW",
                    "bank_account_number": "000000000000000",
                    "message": "test message",
                    "request_date": "2024-12-17 00:00:00",
                    "status": "REQUEST",
                    "cancel_reason": ""
                }
            },
            {
                "submall": {
                    "submall_id": "00000000-0000-0000-0000-000000000000",
                    "biz_type": "INDIVIDUAL_BUSINESS",
                    "submall_name": "test-submall",
                    "business_number": "0000000000"
                },
                "payout": {
                    "payout_id": "00000000-0000-0000-0000-000000000000",
                    "payout_date": "2024-12-30",
                    "payout_amount": "1000.00",
                    "currency": "KRW",
                    "bank_account_number": "000000000000000",
                    "message": "test message",
                    "request_date": "2024-12-17 00:00:00",
                    "status": "CANCEL",
                    "cancel_reason": "cancel reason"
                }
            },
        ],
        "page": 0,
        "size": 100,
        "total_count": 4
    }
}

Remittance request cancellation

POST/submall/api/remit/cancel

Remittance request cancellation is only allowed when the remittance status is pending.
Request parameter

payout_id date

Mandatory
This is a unique ID used to classify payout request. The maximum length is 255 characters.

reason date

Mandatory
The reason for the remittance request cancellation. Maximum length is 255 character
Request 

curl --location 'https://internal-api.eximbay.com/submall/api/remit/cancel' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
    "payout_id": "00000000-0000-0000-0000-000000000000",
    "reason": "cancel reason"
    }'
Response parameter

submall object* Sub_merchant's information

submall_id string

The ID for the sub-merchants has been settled. The maximum length is 255 characters.

biz_type string

Sub_merchant's business type. Maximum length is 100 characters.
CORPORATE_BUSINESS

: Corporate business

INDIVIDUAL_BUSINESS

: Individual business

submall_name string

Sub_merchant's business name. Maximum length is 100 characters.

business_number string

Sub_merchant's business registration number. Maximum length is 30 characters.

payout object* Payout request object information

payout_id string

This is a unique ID used to classify payout request.

payout_date string

Remittance date for the sub-merchant(YYYY-MM-DD) maximum length is 10 characters.

payout_amount string

The amount requested for remittance.

currency string

Remittance currency. KRW/JPY/USD are available for remittance.

bank_account_number string

Please enter the bank account number without '-'. Maximum length is 20 characters.
The bank account registered for JPY and USD can be the same.

message string

The Object showed in remittance history. Maximum length is 255 characters.

request_date string

The date the merchant requested the payout.

status string

Please check the status of the payout request.

cancel_reason string

The reason for the remittance request cancellation. If not canceled, a null string will be displayed.
Response 

{
    "rescode": "SUCCESS",
    "resmsg": "SUCCESS",
    "type": "payout",
    "data": {
        "submall": {
            "submall_id": "bcdc12c1-7c72-4cc4-b12f-aa5a0774170f",
            "biz_type": "INDIVIDUAL_BUSINESS",
            "submall_name": "submall_name",
            "business_number": "4321432121"
        },
        "payout": {
            "payout_id": "4c7f4d3a-1700-47a9-8c34-c72ab906b5f4",
            "payout_date": "2024-12-30",
            "payout_amount": "10.00",
            "currency": "KRW",
            "bank_account_number": "11891001127504",
            "message": "test payout",
            "request_date": "2024-12-17 10:02:44",
            "status": "CANCEL",
            "cancel_reason": "cancel_reason"
        }
    }
}

Merchant balance inquiry

GET/submall/api/remit/merchant/balance

Inquiry into the merchant's real-time balance is available only for currencies specified in the agreement
Request parameter
Request 

curl --location 'https://internal-api.eximbay.com/submall/api/remit/merchant/balance' \
--header 'Authorization: ••••••'
Response parameter

KRW string

Amount of KRW

USD string

Amount of USD

JPY string

Amount of JPY
Response 

{
    "rescode": "SUCCESS",
    "resmsg": "SUCCESS",
    "type": "payout",
    "data": {
        "KRW": 100000.00,
        "JPY": 0
    }
}

Payout amount inquiry

GET/submall/api/remit/available/amount

Inquiry into the available payout balance for the sub-merchant. The available balance is determined by deducting the amounts listed in the payout request list. The balance is available only for currencies specified in the agreement.
Request parameter
Request 

curl --location 'https://internal-api.eximbay.com/submall/api/remit/available/amount' \
--header 'Authorization: ••••••'
Response parameter

KRW string

Payout amount of KRW

USD string

Payout amount of USD

JPY string

Payout amount of JPY
Response 

{
    "rescode": "SUCCESS",
    "resmsg": "SUCCESS",
    "type": "payout",
    "data": {
        "KRW": 100000.00,
        "JPY": 0
    }
}