개요
EXIMLink OpenAPI는 파트너사가 프로그래밍 방식으로 인보이스를 생성·조회하고, 결제 이벤트를 웹훅으로 수신할 수 있도록 제공하는 REST API입니다.
주요 기능
| 영역 | 설명 |
|---|---|
| 인증 | API Key로 Access Token을 발급받아 모든 요청에 사용 |
| 템플릿 | 가맹점에 등록된 결제창 템플릿 목록 조회 |
| 인보이스 | 결제 링크(인보이스) 생성 및 상세 조회 |
| 웹훅 | 이벤트 실시간 수신을 위한 구독 관리 |
Environment
| Base URL | API Key Header | Access Token 유효기간 |
|---|---|---|
| https://link.eximbay.com | v1 | application/json |
인증
모든 API 호출에는 Access Token이 필요합니다. 파트너사에 발급된 apiKey를 헤더에 담아 토큰을 요청하고, 이후 모든 요청에 Authorization: Bearer {token} 형식으로 포함합니다.
| 영역 | 설명 |
|---|---|
| API Key 헤더 | apiKey |
| 인증 헤더 | Authorization: Bearer {access_token} |
| 토큰 유효기간 | 24시간 |
공통 응답 형식
모든 응답은 아래 구조를 따릅니다.
code string
결과 코드입니다. (성공: CMN_0000)
message string
결과 메시지입니다.
data object | null
응답 데이터입니다. (에러 시 생략)
자세한 응답 코드 내용은 코드 목록에서 확인할 수 있습니다.