Eximbay 개발자센터

지급대행 요청하기

지급대행 API는 서브몰 정보를 관리하는 API와 등록된 서브몰에 금액을 지급할 때 사용하는 API로 나누어집니다.
서브몰 정보를 등록하고, 지급대행 API를 호출해 원하는 금액을 서브몰에 송금하세요.

지급대행 API는 추가 계약 후 사용할 수 있습니다. 관련 문의는 문의하기를 이용해주세요.

서브몰 정보 등록하기

API를 통해 가맹점 하위의 서브몰 정보를 등록해야 합니다. 서브몰 정보와 함께 금액을 지급 받을 은행계좌 정보가 함께 포함되어야 합니다.

                  
curl -X POST --location "https://api2-stg.eximbay.com/v1/payouts/submalls" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Basic dGVzdF8xODQ5NzA1QzY0MkMyMTdFMEIyRDo=" \
-d "{
        \"submall_id\" : \"36\",
        \"submall_type\" : \"COMPANY\",
        \"country_code\" : \"KR\",
        \"submall_name\" : \"Test\",
        \"business_id\"  : \"354\",
        \"representative\" : \"Tester\",
        \"bank_account\" : [
            {
                \"currency\" : \"KRW\",
                \"country_code\" : \"KR\",
                \"bank_code\" : \"003\",
                \"bank_name\" : \"woori\",
                \"account_number\" : \"123\",
                \"depositor\" : \"tester\"
            }
        ],
        \"metadata\" : \"test\"
    }"

Path 파라미터에 submall_id를 추가해 등록한 서브몰의 정보를 변경하거나, 삭제할 수 있습니다. 지급대행에 대한 자세한 API 정보는 지급대행 API에서 확인할 수 있습니다.

서브몰에 금액 지급하기

잔액 조회 API를 사용해 서브몰에 지급을 신청하기 전 내 가맹점 지급대행 계좌에 잔액이 충분한지 확인할 수 있습니다. 잔액이 지급을 요청한 금액보다 커야 지급 신청을 할 수 있습니다.
잔액이 충분하다면 지급대행 요청 API로 등록한 서브몰에 지급을 신청하세요.

                  
curl -X POST --location "https://api2.eximbay.com/v1/payouts/" 
-H "accept: application/json" 
-H "Content-Type: application/json" 
-H "Authorization: Basic dGVzdF8xODQ5NzA1QzY0MkMyMTdFMEIyRDo=" 
-d "{
      \"submall_id\": 35,
      \"bank_account_id\": 5,
      \"payout_dt\": \"20220930\",
      \"currency\" : \"KRW\",
      \"amount\" : \"10000\"
    }"

지급대행 요청에 성공하면 아래와 같이 응답코드 0000과 함께 Payout 객체가 담긴 배열이 돌아옵니다.
지급대행 취소는 payout_dt 기준 하루전 자정까지 가능합니다.

                  
{
  "code": "0000",
  "message": "Success",
  "response": {
    "transaction_id": "test2022092800105942001",
    "bank_name": "woori",
    "account_number": "123",
    "depositor": "tester",
    "transaction_dt": null,
    "cancellable_dt": "2022-09-29 23:59:59",
    "fee": null,
    "status": "REQUESTED",
    "payout": {
      "submall_id": "35",
      "bank_account_id": 5,
      "payout_dt": "2022-09-30 11:00:00",
      "currency": "KRW",
      "amount": 10000,
      "statement_descriptor": null,
      "callback_url": null,
      "description": null,
    }
	}
}