웹훅 목록

엑심베이에서 제공하는 웹훅 목록입니다.

Chargeback

차지백 통보 및 해결 관련 정보를 이메일 뿐만 아니라 Webhook으로 수신할 수 있습니다.
연동 준비 사항은 여기에서 확인할 수 있습니다.

Chargeback Webhook은 매시간마다 대상을 추출하여 전송합니다.
가맹점 Webhook URL에서는 정상적으로 수신한 경우, {"rescode" : "0000", "resmsg": "Success"}를 출력해 주세요.
Webhook URL이 정상적으로 호출되지 않거나, rescode가 “0000”이 아닌 경우, 최대 3회 재전송합니다.

Header

    
    Http Method : POST
    Content-type : application/json;charset=utf-8
    
    
이벤트 파라미터

type string

CHARGEBACK

data object*상태가 변경된 차지백 객체입니다.

mid string

엑심베이에서 가맹점을 구분하기 위해 발급한 고유 가맹점 ID입니다.

order_id string

가맹점에서 주문 건을 구분하기 위해 발급한 유일한 값입니다. 실패한 주문에 같은 값을 사용할 수 없습니다.

transaction_id string

엑심베이에서 결제 내역을 구분하기 위해 발급한 고유 ID입니다.

currency string

결제에 사용한 통화 단위입니다. 자세한 내용은 통화 코드를 참고하세요.

amount string

총 결제금액입니다. , 는 사용할 수 없으며, 0보다 큰 숫자만 보낼 수 있습니다.

payment_method string

결제수단 코드입니다. 결제수단 코드를 참고하세요. 결제수단 코드가 지정된 경우, 해당 결제 수단 페이지로 바로 이동합니다.

auth_code string

승인번호입니다.

* 간편결제로 결제된 거래의 경우 승인번호가 존재하지 않습니다.

transaction_date string

승인일시 입니다. YYYYMMDDHHMMSS 형식으로 돌아옵니다.

pay_to string

청구할 가맹점명입니다.

param1 string

가맹점이 필요한 경우 사용할 수 있는 예비 파라미터입니다. 최대 길이는 255자입니다.

param2 string

가맹점이 필요한 경우 사용할 수 있는 예비 파라미터입니다.

param3 string

가맹점이 필요한 경우 사용할 수 있는 예비 파라미터입니다.

payer_authentication_flag string

3DS 거래인지 확인하는 상태값입니다.

refund_flag string

취소가 가능한 거래인지 확인하는 상태값입니다.

chargeback_status string

통보받은 시점의 차지백 상태입니다. REPORT(통보)와 RESOLVE(해소) 두가지 입니다.

chargeback_reason string

차지백 사유입니다.

chargeback_report_date string

차지백 통보일자입니다. YYYYMMDD 형식으로 돌아옵니다.

chargeback_deadline string

차지백 마감일 입니다. YYYYMMDD 형식으로 돌아옵니다.

chargeback_resolve_date string

차지백 해소일자 입니다. YYYYMMDD 형식으로 돌아옵니다.
chargeback_status가 ‘RESOLVE’인 경우에만 전송합니다.

{
    "type": "CHARGEBACK",
    "data": 
    {
        "mid": "30E82A50DD",
        "order_id": "20241108113100",
        "transaction_id": "30E82A50DDW0000056497689",
        "currency": "USD",
        "amount": "3.00",
        "payment_method": "P000",
        "auth_code": "710811",
        "transaction_date": "20241108113722",
        "pay_to": "EXIMBAY.COM",
        "param1": "",
        "param2": "",
        "param3": "",
        "payer_authentication_flag": "N",
        "refund_flag": "N",
        "chargeback_status": "RESOLVE",
        "chargeback_reason": "test chargeback notify 1",
        "chargeback_report_date": "20241108",
        "chargeback_deadline": "20241115",
        "chargeback_resolve_date": ""
    }
}

지급대행

지급대행 서비스를 사용하는 가맹점이 사용할 수 있습니다.
서브몰의 심사가 완료되고 지급이 완료된 경우에 Webhook으로 수신할 수 있습니다.

연동 준비 사항은 여기에서 확인할 수 있습니다

PAYOUT_SUBMALL_REVIEW_COMPLETE

POST/등록된 웹훅 수신 URL

지급대행 이용 가맹점의 서브몰의 심사가 SUBMALL_REVIEW_COMPLETE, SUBMALL_REVIEW_REJECT로 변경되면 웹훅이 전송됩니다.
이벤트 파라미터

type string

웹훅 타입입니다.

data object*웹훅의 세부 내용입니다. data 객체는 각 웹훅 별로 상이합니다.

submall_id string

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

submall_status string

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

submall_review_status string

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

submall_review_modified_date datetime

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

{
    "type": "PAYOUT_SUBMALL_REVIEW_COMPLETE",
    "data": {
        "submall_id": "00000000-0000-0000-0000-000000000000",
        "submall_status": "OK",
        "submall_review_status": "SUBMALL_REVIEW_COMPLETE",
        "submall_review_modified_date": "2025-02-12"
    }
}


PAYOUT_REMITTANCE_COMPLETE

POST/등록된 웹훅 수신 URL

지급요청 건의 상태가 COMPLETE와 FAILED로 변경되면 웹훅이 전송됩니다.
이벤트 파라미터

type string

웹훅 타입입니다.

data object*웹훅의 세부 내용입니다. data 객체는 각 웹훅 별로 상이합니다.

payout_id string

지급대행 요청 ID입니다.

status string

지급 대행 처리 상태입니다.

remit_time string

지급 대행 시간입니다. (yyyy-MM-dd hh:mm:ss)

{
    "type": "PAYOUT_REMITTANCE_COMPLETE",
    "data": [
        {
            "payout_id": "00000000-0000-0000-0000-000000000000",
            "status": "COMPLETE",
            "remit_time": "2025-01-13 01:45:32"
        },
        {
            "payout_id": "00000000-0000-0000-0000-000000000000",
            "status": "COMPLETE",
            "remit_time": "2025-01-13 01:45:35"
        }
    ]
}