| Doc. No. | A18S1D1V1 | ||
|---|---|---|---|
| API Title | 가맹점 > 지자체 정보 기준 결제 가능 가맹점 여부 확인 | ||
| API Description | 지자체 정보를 기준으로 결제 가능 가맹점 여부를 확인하고자 할 때 사용합니다. - 지자체 정보는 ASP-ID와 KA-ID 정보를 기준으로 구분하여 조회 가능합니다. |
||
| Protocol | HTTP | Interface Type | SYNC |
| HTTP METHOD | POST | Request URL | /api/v1/check/payable/merchant/local-government |
| Data Encryption | Request : NO / Response : NO | ||
| Field | Type | Length | MOC | Description | ||
|---|---|---|---|---|---|---|
| aspId | STRING | 15 | MANDATORY | ASP-ID | ||
| kaId | STRING | 15 | MANDATORY | KA-ID | ||
| merchantChannel | STRING | 2 | MANDATORY | 가맹점 매입사 코드 - 고정값 : "KM" |
||
| merchantId | STRING | 15 | MANDATORY | 결제 가능 여부를 확인 할 가맹점 ID | ||
| Field | Type | Length | MOC | Description | ||
|---|---|---|---|---|---|---|
| result | BOOLEAN | MANDATORY | 결제 가능 여부 - true : 결제 가능 - false : 결제 불가 |
|||
| response | OBJECT | MANDATORY | 응답 결과 값 | |||
| └ code | STRING | 1~7 | MANDATORY | 응답 결과 코드 | ||
| └ description | STRING | 1~255 | MANDATORY | 응답 결과 상세 설명 | ||
| HTTP Status | Error code | Message | Description |
|---|---|---|---|
| 프로토콜 항목의 "공통 Error Message 정보"에서 추가 확인 바랍니다. | |||
| 400 | 018_001 | Not found KaId. | kaId 정보를 확인 할 수 없습니다. |