| Doc. No. | A18S1D3V1 | ||
|---|---|---|---|
| API Title | 가맹점 > 사업자번호 기준 결제 가능 가맹점 여부 확인 | ||
| API Description | 결제 하고자 하는 카드의 상품 정보를 기준으로 결제 가능 가맹점 여부를 확인하고자 할 때 사용합니다. - 지자체 정보는 ASP ID 와 KA ID 정보를 기준으로 구분하여 조회 가능합니다. |
||
| Protocol | HTTP | Interface Type | SYNC |
| HTTP METHOD | POST | Request URL | /api/v1/check/payable/merchant/bizLicenseNo |
| Data Encryption | Request : NO / Response : NO | ||
| Field | Type | Length | MOC | Description | ||
|---|---|---|---|---|---|---|
| kaId | STRING | 15 | MANDATORY | KA-ID | ||
| merchantChannel | STRING | 2 | MANDATORY | 가맹점 매입사 코드 - KM: 코나 직가맹점 - KB: KB카드 - HN: 하나카드 |
||
| bizLicenseNoList | ARRAY | MANDATORY | 사업자등록번호 리스트 - 하이픈(-) 없는 숫자 10자리 - 최대 1,000개 - 중복된 사업자등록번호는 1건으로 처리 |
|||
| Field | Type | Length | MOC | Description | ||
|---|---|---|---|---|---|---|
| merchantInfoInquiryInfoList | ARRAY | MANDATORY | 가맹점 정보 리스트 - 요청한 사업자등록번호 순서대로 응답 - 사업자등록번호 1건에 가맹점이 여러 건이면 가맹점 수만큼 응답 - ACTIVE 상태 가맹점만 조회 - 조회되지 않은 사업자등록번호는 bizLicenseNo 외 모든 값 null 로 1건 응답 |
|||
| └ zipCode | STRING | 5~6 | MANDATORY | 우편번호 | ||
| └ addr1 | STRING | 1~100 | MANDATORY | 가맹점 기본 주소 | ||
| └ addr2 | STRING | 1~100 | MANDATORY | 가맹점 상세 주소 | ||
| └ bizType | STRING | 3~4 | MANDATORY | 가맹점 업종 코드 | ||
| └ merchantId | STRING | 10~15 | MANDATORY | 가맹점 ID | ||
| └ salesCode | STRING | 1~3 | MANDATORY | 가맹점 매출 코드 | ||
| └ simpleName | STRING | 1~255 | MANDATORY | 가맹점 명 | ||
| └ bizLicenseNo | STRING | 10 | MANDATORY | 사업자등록번호 | ||
| └ result | BOOLEAN | MANDATORY | 결제 가능 여부 - true: 결제 가능 - false: 결제불가 |
|||
| totalSize | NUMBER | 1~999999999999 | MANDATORY | 응답 리스트 전체 건수 - 조회되지 않은 사업자등록번호 포함 |
||
| response | OBJECT | MANDATORY | 응답 결과 값 | |||
| └ code | STRING | 1~7 | MANDATORY | 응답 결과 코드 | ||
| └ description | STRING | 1~255 | MANDATORY | 응답 결과 상세 설명 | ||
| HTTP Status | Error code | Message | Description |
|---|---|---|---|
| 프로토콜 항목의 "공통 Error Message 정보"에서 추가 확인 바랍니다. | |||