EXIMBAY 개발자센터

지급대행

Eximbay 지급대행은 서브몰 관리(등록, 수정, 삭제 등)와 지급 대행(요청, 취소, 조회 등)에 대한 API를 포함하고 있습니다.
지급대행을 이용하기 위해서는 토큰을 먼저 발급 받아야합니다. 토큰 발급은 지급대행 준비에서 자세히 알아보세요.

  
  curl --location 'https://internal-api.eximbay.com/submall/api/submall/register' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: ••••••' \

본 문서에 따라 API 연동이 완료되면, 서비스용 URL과 관련 파라미터 변경 후, 실 서비스 이용이 가능합니다.

요청 URL

실제 송금은 운영에서만 가능합니다.
각 가맹점 별 테스트 가능 금액은 KRW 100,000 , USD 100, JPY 10,000입니다.

구분	URL
운영	https://pgonline.eximbay.com
테스트	https://pgonline-test.eximbay.com

응답 파라미터

rescode string

응답 코드입니다.

resmsg string

응답 코드에 대한 설명입니다.

type string

api 분류에 대한 코드입니다.

payout

: 지급대행 요청과 관련된 API type 입니다.

submall

: 서브몰 관련 요청과 관련된 API type 입니다.

data

Data type입니다.

String

Object(Nullable)

List

"RESPONSE_BODY"는 Data field에 대한 내용이 포함됩니다.

응답

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

서브몰 정보 관리

서브몰 등록

POST/submall/api/submall/register

지급대행을 요청할 하위 가맹점들을 엑심베이에 등록합니다. 등록한 서브몰의 정보를 바탕으로 심사가 진행됩니다.

• 한 번의 요청에 하나의 서브몰만 등록할 수 있습니다.
• 수취 계좌 조회 및 파라미터 검증 실패, 중복된 통화(Currency)로 등록 요청 시, 서 브몰 등록이 불가능합니다.
• 타행(하나은행 외) 다통화 계좌 정보 등록 시, 은행 업무시간(오전9시 ~오후4시) 외 등록이 불가능합니다.

요청 파라미터

biz_type string

필수

서브몰의 사업자 유형입니다. 최대 길이는 100자입니다.

CORPORATE_BUSINESS

: 법인사업자

INDIVIDUAL_BUSINESS

: 개인사업자

submall_name string

필수

서브몰의 상호명입니다. 최대 길이는 100자입니다.

business_number string

필수

서브몰의 사업자번호입니다. 최대 길이는 30자입니다.

representative_name string

필수

서브몰의 대표자 명입니다. 최대 길이는 60자입니다.

representative_email string

필수

서브몰의 대표자의 이메일입니다.

manager_name string

필수

서브믈의 운영담당자 명입니다. 최대 길이는 60자입니다.

manager_email string

필수

서브몰의 운영담당자 이메일입니다. 최대 길이는 100자입니다.

manager_phone string

필수

서브몰의 운영담당자 연락처입니다.

submall_bank_account list*정산금액을 지급받을 서브몰의 계좌정보입니다.

bank_account_name string

필수

계좌 별칭입니다. 최대 3개의 계좌를 별칭으로 구분하여 관리합니다.

bank_code string

필수

계좌의 은행코드입니다. 은행코드를 참고하여 세자리 코드로 입력해주세요.

currency string

필수

송금 통화입니다. KRW/JPY/USD 세가지의 통화로 송금받을 수 있습니다.

bank_account_number string

필수

계좌번호이며 -없이 숫자만 입력해주세요. 최대길이는 20자입니다.
USD/JPY 중복계좌 사용 가능합니다.

depositor string

필수

계좌의 예금주입니다. 최대길이는 한글, 영문 60자입니다.

요청

    
    {
        "biz_type": "INDIVIDUAL_BUSINESS",
        "submall_name": "test-submall",
        "business_number": "0000000000",
        "representative_name": "대표자명",
        "representative_email": "representative@eximbay.com",
        "manager_name": "매니저명",
        "manager_email": "manager@eximbay.com",
        "manager_phone": "01012345678",
        "submall_bank_account": [
            {
                "bank_account_name": "테스트 계좌명",
                "currency": "KRW",
                "bank_code": "000",
                "depositor": "테스트 예금주",
                "bank_account_number": "000000000000000"
            },
            {
                "bank_account_name": "테스트 외화 계좌",
                "currency": "USD",
                "bank_code": "000",
                "depositor": "테스트 수취인",
                "bank_account_number": "000000000000000"
            }
        ]
    }

응답 파라미터

submall_id string

등록한 서브몰의 고유 ID입니다.

registered_date datetime

서브몰 등록 일시입니다. (yyyy-MM-dd hh:mm:ss)

submall_status string

서브몰의 서비스 상태입니다. 서비스 상태 코드를 참고하세요.

submall_review_status string

서브몰의 심사 상태입니다. 심사 상태 코드를 참고하세요.

submall_review_modified_date datetime

심사상태 변경 일시입니다.

submall object*서브몰의 정보입니다.

submall_name string

서브몰의 상호명입니다. 최대 길이는 100자입니다.

biz_type string

서브몰의 사업자 유형입니다. 최대 길이는 100자입니다.

CORPORATE_BUSINESS

: 법인사업자

INDIVIDUAL_BUSINESS

: 개인사업자

business_number string

서브몰의 사업자번호입니다. 최대 길이는 30자입니다.

representative object*서브몰의 대표자 정보입니다.

representative_name string

서브몰의 대표자 명입니다. 최대 길이는 60자입니다.

representative_email string

서브몰의 대표자의 이메일입니다.

manager object*서브몰의 운영담당자 정보입니다.

manager_name string

서브믈의 운영담당자 명입니다.

manager_email string

서브몰의 운영담당자 이메일입니다. 최대 길이는 100자입니다.

manager_phone string

서브몰의 운영담당자 연락처입니다.

submall_bank_account list*정산금액을 지급받을 서브몰의 계좌정보입니다.

bank_account_name string

계좌 별칭입니다. 최대 3개의 계좌를 별칭으로 구분하여 관리합니다.

bank_account_id string

계좌 ID입니다.

bank_code string

계좌의 은행코드입니다. 은행코드를 참고하여 세자리 코드로 입력해주세요.

currency string

송금 통화입니다. KRW/JPY/USD 세가지의 통화로 송금받을 수 있습니다.

bank_account_number string

계좌번호이며 -없이 숫자만 입력해주세요. 최대길이는 20자입니다.
USD/JPY 중복계좌 사용 가능합니다.

depositor string

계좌의 예금주입니다. 최대길이는 한글, 영문 60자입니다.

응답


{
    "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_email": "representative@eximbay.com"
            },
        "manager": {
                "manager_name": "매니저명",
                "manager_email": "manager@eximbay.com",
                "manager_phone": "01012345678"
            },
        "submall_bank_account": [
            {
                "bank_account_name": "테스트 원화 계좌",
                "bank_account_id": "00000000-0000-0000-0000-000000000000",
                "bank_code": "000",
                "bank_account_number": "000000000000000",
                "currency": "KRW",
                "depositor": "테스트 예금주"
            },
            {
                "bank_account_name": "테스트 외화 계좌",
                "bank_account_id": "00000000-0000-0000-0000-000000000000",
                "bank_code": "000",
                "bank_account_number": "000000000000000",
                "currency": "USD",
                "depositor": "수취인1"
            }
        ]
    }
}

서브몰 단건 조회

GET/submall/api/submall/get/submallId

엑심베이에 등록한 한 개의 서브몰을 조회합니다.

요청 파라미터

요청


curl --location 'https://URL/submall/api/submall/get/6e46ccac-124a-4b73-aaef-ed50c302b488' \
--header 'Authorization: ••••••'

응답 파라미터

submall_id string

등록한 서브몰의 고유 ID입니다.

registered_date datetime

서브몰 등록 일시입니다. (yyyy-MM-dd hh:mm:ss)

submall_status string

서브몰의 서비스 상태입니다. 서비스 상태 코드를 참고하세요.

submall_review_status string

서브몰의 심사 상태입니다. 심사 상태 코드를 참고하세요.

submall_review_modified_date datetime

심사상태 변경 일시입니다.

submall object*서브몰의 정보입니다.

submall_name string

서브몰의 상호명입니다. 최대 길이는 100자입니다.

biz_type string

서브몰의 사업자 유형입니다. 최대 길이는 100자입니다.

CORPORATE_BUSINESS

: 법인사업자

INDIVIDUAL_BUSINESS

: 개인사업자

business_number string

서브몰의 사업자번호입니다. 최대 길이는 30자입니다.

representative object*서브몰의 대표자 정보입니다.

representative_name string

서브몰의 대표자 명입니다. 최대 길이는 60자입니다.

representative_email string

서브몰의 대표자의 이메일입니다.

manager object*서브몰의 운영담당자 정보입니다.

manager_name string

서브믈의 운영담당자 명입니다.

manager_email string

서브몰의 운영담당자 이메일입니다. 최대 길이는 100자입니다.

manager_phone string

서브몰의 운영담당자 연락처입니다.

submall_bank_account list*정산금액을 지급받을 서브몰의 계좌정보입니다.

bank_account_name string

필수

계좌 별칭입니다. 최대 3개의 계좌를 별칭으로 구분하여 관리합니다.

bank_code string

계좌의 은행코드입니다. 은행코드를 참고하여 세자리 코드로 입력해주세요.

currency string

송금 통화입니다. KRW/JPY/USD 세가지의 통화로 송금받을 수 있습니다.

bank_account_number string

계좌번호이며 -없이 숫자만 입력해주세요. 최대길이는 20자입니다.
USD/JPY 중복계좌 사용 가능합니다.

depositor string

계좌의 예금주입니다. 최대길이는 한글, 영문 60자입니다.

응답


{
    "rescode": "SUCCESS",
    "resmsg": "SUCCESS",
    "type": "submall",
    "data": {
        "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_email": "representative@eximbay.com"
            },
        "manager": {
            "manager_name": "매니저명",
            "manager_email": "manager@eximbay.com",
            "manager_phone": "01012345678"
            },
        "submall_bank_account": [
            {
                "bank_account_name": "테스트 원화 계좌",
                "bank_account_id": "00000000-0000-0000-0000-000000000000",
                "bank_code": "000",
                "bank_account_number": "000000000000000",
                "currency": "KRW",
                "depositor": "예금주1"
            }
        ]
    }
}

서브몰 리스트 조회

GET/submall/api/submall/list

엑심베이에 등록한 여러개의 서브몰을 조회합니다.

요청 파라미터

page int

페이지를 기준으로 서브몰 리스트를 불러옵니다. 기본값은 0입니다.

size int

한 페이지에 조회하고 싶은 서브몰의 개수입니다. 기본값은 20입니다.

요청


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

응답 파라미터

list list(DataList)*서브몰 리스트 정보입니다

submall_id string

등록한 서브몰의 고유 ID입니다.

registered_date datetime

서브몰 등록 일시입니다. (yyyy-MM-dd hh:mm:ss)

submall_status string

서브몰의 서비스 상태입니다. 서비스 상태 코드를 참고하세요.

submall_review_status string

서브몰의 심사 상태입니다. 심사 상태 코드를 참고하세요.

submall_review_modified_date datetime

심사상태 변경 일시입니다.

submall object*서브몰의 정보입니다.

submall_name string

서브몰의 상호명입니다. 최대 길이는 100자입니다.

biz_type string

서브몰의 사업자 유형입니다. 최대 길이는 100자입니다.

CORPORATE_BUSINESS

: 법인사업자

INDIVIDUAL_BUSINESS

: 개인사업자

business_number string

서브몰의 사업자번호입니다. 최대 길이는 30자입니다.

representative object*서브몰의 대표자 정보입니다.

representative_name string

서브몰의 대표자 명입니다. 최대 길이는 60자입니다.

representative_email string

서브몰의 대표자의 이메일입니다.

manager object*서브몰의 운영담당자 정보입니다.

manager_name string

서브믈의 운영담당자 명입니다.

manager_email string

서브몰의 운영담당자 이메일입니다. 최대 길이는 100자입니다.

manager_phone string

서브몰의 운영담당자 연락처입니다.

submall_bank_account list*정산금액을 지급받을 서브몰의 계좌정보입니다.

bank_account_name string

계좌 별칭입니다. 최대 3개의 계좌를 별칭으로 구분하여 관리합니다.

bank_account_id string

계좌 ID입니다.

bank_code string

계좌의 은행코드입니다. 은행코드를 참고하여 세자리 코드로 입력해주세요.

currency string

송금 통화입니다. KRW/JPY/USD 세가지의 통화로 송금받을 수 있습니다.

bank_account_number string

계좌번호이며 -없이 숫자만 입력해주세요. 최대길이는 20자입니다.
USD/JPY 중복계좌 사용 가능합니다.

depositor string

계좌의 예금주입니다. 최대길이는 한글, 영문 60자입니다.

page int

페이지를 기준으로 서브몰 리스트를 불러옵니다. 기본값은 0입니다.

size int

한 페이지에 조회하고 싶은 서브몰의 개수입니다. 기본값은 20입니다.

total_count int

전체 서브몰 개수입니다.

응답


{
    "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_email": "representative@eximbay.com"
                },
                "manager": {
                        "manager_name": "매니저명",
                        "manager_email": "manager@eximbay.com",
                        "manager_phone": "01012345678"
                },
                "submall_bank_account": [
                    {
                        "bank_account_name": "테스트 원화 계좌",
                        "bank_account_id": "00000000-0000-0000-0000-000000000000",
                        "bank_code": "000",
                        "bank_account_number": "000000000000000",
                        "currency": "KRW",
                        "depositor": "테스트 예금주"
                    }
                ]
            }
        ],
        "page": 0,
        "size": 100,
        "total_count": 1
    }
}

서브몰 수정

POST/submall/api/submall/update/submallId

엑심베이에 등록한 서브몰을 수정합니다.

• 필드에 존재하는 값만 수정되며, 추가된 필드와 하위 오브젝트의 모든 필드는 null 값을 허용하지 않고 필수로 요구됩니다.
• 수취 계좌 조회 실패, 파라미터 검증 실패, 또는 중복된 통화(Currency)가 존재할 경우 수정이 불가능합니다.
• 서브몰 이름, 사업자 타입, 사업자번호, 대표자명을 변경할 경우 재심사가 필요합니다.
• 지급요청 대기중인 서브몰의 계좌는 수정이 불가능합니다.
• 타행(하나은행 외) 다통화 계좌 정보 수정 시, 은행 업무시간(오전9시 ~오후4시) 외 수정이 불가능합니다.

요청 파라미터

biz_type string

서브몰의 사업자 유형입니다. 최대 길이는 100자입니다.

CORPORATE_BUSINESS

: 법인사업자

INDIVIDUAL_BUSINESS

: 개인사업자

submall_name string

서브몰의 상호명입니다. 최대 길이는 100자입니다.

business_number string

서브몰의 사업자번호입니다. 최대 길이는 30자입니다.

representative_name string

서브몰의 대표자 명입니다. 최대 길이는 60자입니다.

representative_email string

서브몰의 대표자의 이메일입니다.

manager_name string

서브믈의 운영담당자 명입니다. 최대 길이는 60자입니다.

manager_email string

서브몰의 운영담당자 이메일입니다. 최대 길이는 100자입니다.

manager_phone string

서브몰의 운영담당자 연락처입니다.

submall_bank_account list*정산금액을 지급받을 서브몰의 계좌정보입니다.

bank_account_name string

필수

계좌 별칭입니다. 최대 3개의 계좌를 별칭으로 구분하여 관리합니다.

bank_account_id string

필수

계좌 ID입니다.

bank_code string

필수

계좌의 은행코드입니다. 은행코드를 참고하여 세자리 코드로 입력해주세요.

currency string

필수

송금 통화입니다. KRW/JPY/USD 세가지의 통화로 송금받을 수 있습니다.

bank_account_number string

필수

계좌번호이며 -없이 숫자만 입력해주세요. 최대길이는 20자입니다.
USD/JPY 중복계좌 사용 가능합니다.

depositor string

필수

계좌의 예금주입니다. 최대길이는 한글, 영문 60자입니다.

요청


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": "테스트 원화 계좌",
            "currency": "KRW",
            "bank_code": "000",
            "bank_account_number": "000000000000000",
            "depositor": "테스트 예금주"
        },
        {
            "bank_account_name": "테스트 외화 계좌",
            "currency": "JPY",
            "bank_code": "000",
            "bank_account_number": "000000000000000",
            "depositor": "테스트 수취인"
        }
    ]
}'

응답 파라미터

submall_id string

등록한 서브몰의 고유 ID입니다.

registered_date datetime

서브몰 등록 일시입니다. (yyyy-MM-dd hh:mm:ss)

submall_status string

서브몰의 서비스 상태입니다. 서비스 상태 코드를 참고하세요.

submall_review_status string

서브몰의 심사 상태입니다. 심사 상태 코드를 참고하세요.

submall_review_modified_date datetime

심사상태 변경 일시입니다.

submall object*서브몰의 정보입니다.

submall_name string

서브몰의 상호명입니다. 최대 길이는 100자입니다.

biz_type string

서브몰의 사업자 유형입니다. 최대 길이는 100자입니다.

CORPORATE_BUSINESS

: 법인사업자

INDIVIDUAL_BUSINESS

: 개인사업자

business_number string

서브몰의 사업자번호입니다. 최대 길이는 30자입니다.

representative object*서브몰의 대표자 정보입니다.

representative_name string

서브몰의 대표자 명입니다. 최대 길이는 60자입니다.

representative_email string

서브몰의 대표자의 이메일입니다.

manager object*서브몰의 운영담당자 정보입니다.

manager_name string

서브믈의 운영담당자 명입니다.

manager_email string

서브몰의 운영담당자 이메일입니다. 최대 길이는 100자입니다.

manager_phone string

서브몰의 운영담당자 연락처입니다.

submall_bank_account list*정산금액을 지급받을 서브몰의 계좌정보입니다.

bank_account_name string

계좌 별칭입니다. 최대 3개의 계좌를 별칭으로 구분하여 관리합니다.

bank_account_id string

계좌 ID입니다.

bank_code string

계좌의 은행코드입니다. 은행코드를 참고하여 세자리 코드로 입력해주세요.

currency string

송금 통화입니다. KRW/JPY/USD 세가지의 통화로 송금받을 수 있습니다.

bank_account_number string

계좌번호이며 -없이 숫자만 입력해주세요. 최대길이는 20자입니다.
USD/JPY 중복계좌 사용 가능합니다.

depositor string

계좌의 예금주입니다. 최대길이는 한글, 영문 60자입니다.

응답


{
    "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_email": "representative@eximbay.com"
        },
        "manager": {
            "manager_name": "매니저명",
            "manager_email": "manager@eximbay.com",
            "manager_phone": "01012345678"
        },
        "submall_bank_account": [
            {
                "bank_account_name": "테스트 원화 계좌",
                "bank_account_id": "00000000-0000-0000-0000-000000000000",
                "bank_code": "000",
                "bank_account_number": "000000000000000",
                "currency": "KRW",
                "depositor": "테스트 예금주"
            }
        ]
    }
}

서브몰 삭제

POST/submall/api/submall/delete/submallId

엑심베이에 등록한 서브몰을 삭제합니다.
삭제한 서브몰은 복구할 수 없으며, 서브몰 등록 API를 통해 재등록을 해야합니다.

요청 파라미터

요청


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

응답 파라미터

응답


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

지급 요청 관리

지급 요청

POST/submall/api/remit/register

등록된 서브몰에 정산 금액을 이체합니다.

• Parameter validation에 실패하거나 요청 금액이 잔액에서 송금 대기 금액을 초과할 경우 요청이 불가합니다.
• 심사가 완료된 서브몰만 등록이 가능하며, 송금 요청 통화에 해당하는 계좌가 서브몰 정보에 등록되어 있어야 요청할 수 있습니다.
• 타행(하나은행 외) 다통화계좌 정보로 요청 시, 은행 업무시간(오전9시 ~오후4시) 외 등록이 불가능합니다.
• 송금요청일은 당일과 과거는 설정할 수 없으며, 하나은행 외 계좌에 송금을 요청하시는 경우 최소 금액 미달 시 송금이 불가합니다. (최소금액은 KRW 4,000, USD 4, JPY 400입니다.)
• 지급대행을 통해 서브몰에 정산된 금액은 회수가 어렵습니다. 엑심베이는 지급에 대한 책임을 지지 않으므로, 지급요청 정보를 신중하게 검토한 후에 사용해 주세요.

요청 파라미터

submall_id string

필수

정산금을 지급받는 서브몰의 ID입니다. 최대 길이는 255자입니다.

payout_date string

필수

정산금이 서브몰에 송금되는 일자입니다.(YYYY-MM-DD) 최대 길이는 10자입니다.

payout_amount string

필수

지급요청 금액입니다. 최대 길이는 255자입니다.

payout_currency string

필수

지급요청 통화입니다. 최대 길이는 100자입니다.

message string

필수

이체 내역에 표시되는 적용입니다. 최대 길이는 255자입니다.

요청


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

응답 파라미터

submall object*서브몰의 정보입니다.

submall_id string

정산금을 지급받는 서브몰의 ID입니다. 최대 길이는 255자입니다.

biz_type string

서브몰의 사업자 유형입니다. 최대 길이는 100자입니다.

CORPORATE_BUSINESS

: 법인사업자

INDIVIDUAL_BUSINESS

: 개인사업자

submall_name string

서브몰의 상호명입니다. 최대 길이는 100자입니다.

business_number string

서브몰의 사업자번호입니다. 최대 길이는 30자입니다.

payout object*지급 대행 요청객체 정보입니다.

payout_id string

지급대행 요청 건 별로 발급되는 고유 ID입니다.

payout_date string

정산금이 서브몰에 송금되는 일자입니다.(YYYY-MM-DD) 최대 길이는 10자입니다.

payout_amount string

지급요청 금액입니다.

currency string

송금 통화입니다. KRW/JPY/USD 세가지의 통화로 송금받을 수 있습니다.

bank_account_number string

계좌번호이며 -없이 숫자만 입력해주세요. 최대길이는 20자입니다.
USD/JPY 중복계좌 사용 가능합니다.

message string

이체 내역에 표시되는 적용입니다. 최대 길이는 255자입니다.

request_date string

가맹점의 지급대행 요청일자입니다.

status string

지급대행 요청상태를 확인하세요.

응답


{
    "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"
        }
    }
}

지급 요청 단건 조회

GET/submall/api/remit/get/payoutId

지급요청 1건을 조회합니다.

요청 파라미터

요청


curl --location 'https://URL/submall/api/remit/get?payoutKey=d6f9424c-2885-4f30-b50d-98e2ccc60d29' \
--header 'Authorization: ••••••'

응답 파라미터

submall object*서브몰의 정보입니다.

submall_id string

정산금을 지급받는 서브몰의 ID입니다. 최대 길이는 255자입니다.

biz_type string

서브몰의 사업자 유형입니다. 최대 길이는 100자입니다.

CORPORATE_BUSINESS

: 법인사업자

INDIVIDUAL_BUSINESS

: 개인사업자

submall_name string

서브몰의 상호명입니다. 최대 길이는 100자입니다.

business_number string

서브몰의 사업자번호입니다. 최대 길이는 30자입니다.

payout object*지급 대행 요청객체 정보입니다.

payout_id string

지급대행 요청 건 별로 발급되는 고유 ID입니다.

payout_date string

정산금이 서브몰에 송금되는 일자입니다.(YYYY-MM-DD) 최대 길이는 10자입니다.

payout_amount string

지급요청 금액입니다.

currency string

송금 통화입니다. KRW/JPY/USD 세가지의 통화로 송금받을 수 있습니다.

bank_account_number string

계좌번호이며 -없이 숫자만 입력해주세요. 최대길이는 20자입니다.
USD/JPY 중복계좌 사용 가능합니다.

message string

이체 내역에 표시되는 적용입니다. 최대 길이는 255자입니다.

request_date string

가맹점의 지급대행 요청일자입니다.

status string

지급대행 요청상태를 확인하세요.

cancel_reason string

지급요청 취소 사유입니다.
취소 건이 아닌경우, 빈 문자열로 표시됩니다.

응답


{
    "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": "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"
        }
    }
}

지급 요청 리스트 조회

GET/submall/api/remit/get/payoutId

지급요청 리스트를 조회합니다.
사용 가능한 파라미터만 지정할 수 있으며, 미지정 시 전체 조회가 수행됩니다. null 값은 허용되지 않습니다.

요청 파라미터

payout_date date

정산금이 서브몰에 송금되는 일자입니다.(YYYY-MM-DD) 최대 길이는 10자입니다.

page int

페이지를 기준으로 서브몰 리스트를 불러옵니다. 기본값은 0입니다.

size int

한 페이지에 조회하고 싶은 서브몰의 개수입니다. 기본값은 20입니다.

요청


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

응답 파라미터

list list(DataList)*서브몰 리스트 정보입니다

submall object*서브몰의 정보입니다.

submall_id string

정산금을 지급받는 서브몰의 ID입니다. 최대 길이는 255자입니다.

biz_type string

서브몰의 사업자 유형입니다. 최대 길이는 100자입니다.

CORPORATE_BUSINESS

: 법인사업자

INDIVIDUAL_BUSINESS

: 개인사업자

submall_name string

서브몰의 상호명입니다. 최대 길이는 100자입니다.

business_number string

서브몰의 사업자번호입니다. 최대 길이는 30자입니다.

payout object*지급 대행 요청객체 정보입니다.

payout_id string

지급대행 요청 건 별로 발급되는 고유 ID입니다.

payout_date string

정산금이 서브몰에 송금되는 일자입니다.(YYYY-MM-DD)

payout_amount string

지급요청 금액입니다.

currency string

송금 통화입니다. KRW/JPY/USD 세가지의 통화로 송금받을 수 있습니다.

bank_account_number string

계좌번호이며 -없이 숫자만 입력해주세요. 최대길이는 20자입니다.
USD/JPY 중복계좌 사용 가능합니다.

message string

이체 내역에 표시되는 적용입니다. 최대 길이는 255자입니다.

request_date string

가맹점의 지급대행 요청일자입니다.

status string

지급대행 요청상태를 확인하세요.

cancel_reason string

지급요청 취소 사유입니다.
취소 건이 아닌경우, 빈 문자열로 표시됩니다.

page int

페이지를 기준으로 서브몰 리스트를 불러옵니다. 기본값은 0입니다.

size int

한 페이지에 조회하고 싶은 서브몰의 개수입니다. 기본값은 20입니다.

total_count int

전체 서브몰 개수입니다.

응답


{
    "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
    }
}

지급 요청 취소

POST/submall/api/remit/cancel

지급 요청을 취소합니다. 송금 대기 상태인 요청에 대해서만 취소가능합니다.

요청 파라미터

payout_id date

필수

지급대행 요청 건 별로 발급되는 고유 ID입니다. 최대 길이는 255자입니다.

reason date

필수

요청취소에 대한 사유입니다. 최대 길이는 255자입니다.

요청


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

응답 파라미터

submall object*서브몰의 정보입니다.

submall_id string

정산금을 지급받는 서브몰의 ID입니다. 최대 길이는 255자입니다.

biz_type string

서브몰의 사업자 유형입니다. 최대 길이는 100자입니다.

CORPORATE_BUSINESS

: 법인사업자

INDIVIDUAL_BUSINESS

: 개인사업자

submall_name string

서브몰의 상호명입니다. 최대 길이는 100자입니다.

business_number string

서브몰의 사업자번호입니다. 최대 길이는 30자입니다.

payout object*지급 대행 요청객체 정보입니다.

payout_id string

지급대행 요청 건 별로 발급되는 고유 ID입니다.

payout_date string

정산금이 서브몰에 송금되는 일자입니다.(YYYY-MM-DD) 최대 길이는 10자입니다.

payout_amount string

지급요청 금액입니다.

currency string

송금 통화입니다. KRW/JPY/USD 세가지의 통화로 송금받을 수 있습니다.

bank_account_number string

계좌번호이며 -없이 숫자만 입력해주세요. 최대길이는 20자입니다.
USD/JPY 중복계좌 사용 가능합니다.

message string

이체 내역에 표시되는 적용입니다. 최대 길이는 255자입니다.

request_date string

가맹점의 지급대행 요청일자입니다.

status string

지급대행 요청상태를 확인하세요.

cancel_reason string

지급요청 취소 사유입니다.
취소 건이 아닌경우, 빈 문자열로 표시됩니다.

응답


{
    "rescode": "SUCCESS",
    "resmsg": "SUCCESS",
    "type": "payout",
    "data": {
        "submall": {
            "submall_id": "bcdc12c1-7c72-4cc4-b12f-aa5a0774170f",
            "biz_type": "INDIVIDUAL_BUSINESS",
            "submall_name": "테스트2",
            "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": "취소 테스트"
        }
    }
}

가맹점 잔액 조회

GET/submall/api/remit/merchant/balance

가맹점의 실제 잔액을 조회합니다. 계약된 통화에 대해서만 확인 가능합니다.

요청 파라미터

요청


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

응답 파라미터

KRW string

KRW 잔액입니다.

USD string

USD 잔액입니다.

JPY string

JPY 잔액입니다.

응답


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

지급 대행 요청 가능 금액 조회

GET/submall/api/remit/available/amount

지급 요청 리스트에 포함된 금액을 제외한 서브몰에 지급 가능한 잔액을 조회합니다. 계약된 통화에 대해서만 확인 가능합니다.

요청 파라미터

요청


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

응답 파라미터

KRW string

KRW 요청가능 금액입니다.

USD string

USD 요청가능 금액입니다.

JPY string

JPY 요청가능 금액입니다.

응답


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